From a6dff8a150f167d21fc1a911e8545b0360591b81 Mon Sep 17 00:00:00 2001 From: Hugues Delorme Date: Wed, 13 Jan 2016 10:15:04 +0100 Subject: [PATCH] More doc --- src/gmio_core/internal/stringstream.h | 19 +++++++++++++++---- src/gmio_stl/stl_constants.h | 6 +++--- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/src/gmio_core/internal/stringstream.h b/src/gmio_core/internal/stringstream.h index a97c2ce..c9f14bc 100644 --- a/src/gmio_core/internal/stringstream.h +++ b/src/gmio_core/internal/stringstream.h @@ -22,18 +22,29 @@ /*! Stream that operates on a string * - * To be used with API below. * It allows to iterate over a stream (until end is reached) as if it was a * string. + * + * To be used with API below. */ struct gmio_stringstream { + /*! Stream to iterate over */ struct gmio_stream stream; - struct gmio_string strbuff; - const char* strbuff_end; /*!< Position after last char in strbuff */ - const char* strbuff_at; /*!< Position indicator in buffer */ + /*! Holds contents read from stream */ + struct gmio_string strbuff; + + /*! Position after last char in strbuff */ + const char* strbuff_end; + + /*! Position indicator in strbuff */ + const char* strbuff_at; + + /*! User data to be passed to callback func_stream_read_hook */ void* cookie; + + /*! Pointer on user function called each time next contents is read */ void (*func_stream_read_hook)( void* cookie, const struct gmio_string* strbuff); }; diff --git a/src/gmio_stl/stl_constants.h b/src/gmio_stl/stl_constants.h index fdee6a8..8758a58 100644 --- a/src/gmio_stl/stl_constants.h +++ b/src/gmio_stl/stl_constants.h @@ -27,13 +27,13 @@ enum gmio_stl_constants { - /*! Compact size of a struct gmio_stl_coords object */ + /*! Compact size of a gmio_stl_coords object */ GMIO_STL_COORDS_RAWSIZE = (3 * sizeof(gmio_float32_t)), - /*! Compact size of a struct gmio_stl_triangle object, STL ascii format */ + /*! Compact size of a gmio_stl_triangle object, STL ascii format */ GMIO_STLA_TRIANGLE_RAWSIZE = (4 * GMIO_STL_COORDS_RAWSIZE), - /*! Compact size of a struct gmio_stl_triangle object, STL binary format */ + /*! Compact size of a gmio_stl_triangle object, STL binary format */ GMIO_STLB_TRIANGLE_RAWSIZE = (GMIO_STLA_TRIANGLE_RAWSIZE + sizeof(uint16_t)), /*! Size(in bytes) of the header data for STL binary */