Doc fixes

This commit is contained in:
Hugues Delorme 2016-03-11 10:07:53 +01:00
parent e9be2a62d5
commit 0a14409aea
3 changed files with 6 additions and 4 deletions

View File

@ -32,7 +32,7 @@ struct gmio_stringstream
/*! Stream to iterate over */
struct gmio_stream stream;
/*! Holds contents read from stream */
/*! Holds contents chunk read from stream */
struct gmio_string strbuff;
/*! Position after last char in strbuff */
@ -44,7 +44,8 @@ struct gmio_stringstream
/*! Data to be passed to callback func_stream_read */
void* cookie;
/*! Pointer on a function called each time next contents has to be read */
/*! Pointer on a function called each time next contents chunk has to be
* read */
size_t (*func_stream_read)(
void* cookie, struct gmio_stream* stream, char* ptr, size_t len);
};

View File

@ -49,6 +49,8 @@ GMIO_C_LINKAGE_BEGIN
* It will try to read 512 bytes from \p stream into a buffer and then
* analyses this data to guess the format.
*
* The position of the input stream is preserved.
*
* \retval GMIO_STL_FORMAT_UNKNOWN in case of error.
*/
GMIO_LIBSTL_EXPORT

View File

@ -34,8 +34,7 @@ struct gmio_stl_coords
float z;
};
/*! STL mesh triangle defined three geometric vertices and an
* orientation(normal) */
/*! STL mesh triangle defined three vertices and a normal(orientation) */
struct gmio_stl_triangle
{
struct gmio_stl_coords n; /*!< Normal vector */