caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

gmio_stl: fix minor doc issues in stl_io.h

Browse Source
This commit is contained in:
Hugues Delorme 2015-03-30 17:26:38 +02:00
parent e9ed4b511e
commit cb39f6e8e6
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/gmio_stl/stl_io.h
View File

@ -109,7 +109,8 @@ typedef struct gmio_stla_write_options gmio_stla_write_options_t;
* values * values
* *
* \return Error code (see error.h and stl_error.h) * \return Error code (see error.h and stl_error.h)
* \retval GMIO_INVALID_BUFFER_SIZE_ERROR if \c trs->buffer_size < 512 * \retval GMIO_INVALID_BUFFER_SIZE_ERROR
* if <tt>trsf->buffer.size < 512</tt>
*/ */
GMIO_LIBSTL_EXPORT GMIO_LIBSTL_EXPORT
int gmio_stla_write( int gmio_stla_write(
@ -128,8 +129,8 @@ int gmio_stla_write(
* \param options Byte order of the input STL binary data * \param options Byte order of the input STL binary data
* *
* \return Error code (see error.h and stl_error.h) * \return Error code (see error.h and stl_error.h)
* \retval GMIO_INVALID_BUFFER_SIZE_ERRO * \retval GMIO_INVALID_BUFFER_SIZE_ERROR
* if \c trs->buffer_size < GMIO_STLB_MIN_CONTENTS_SIZE * if <tt>trsf->buffer.size < GMIO_STLB_MIN_CONTENTS_SIZE</tt>
*/ */
GMIO_LIBSTL_EXPORT GMIO_LIBSTL_EXPORT
int gmio_stlb_read( int gmio_stlb_read(
@ -167,7 +168,7 @@ typedef struct gmio_stlb_write_options gmio_stlb_write_options_t;
* *
* \return Error code (see error.h and stl_error.h) * \return Error code (see error.h and stl_error.h)
* \retval GMIO_INVALID_BUFFER_SIZE_ERROR * \retval GMIO_INVALID_BUFFER_SIZE_ERROR
* if \c trs->buffer_size < GMIO_STLB_MIN_CONTENTS_SIZE * if <tt>trsf->buffer.size < GMIO_STLB_MIN_CONTENTS_SIZE</tt>
*/ */
GMIO_LIBSTL_EXPORT GMIO_LIBSTL_EXPORT
int gmio_stlb_write( int gmio_stlb_write(