Minor doc improvements

This commit is contained in:
Hugues Delorme 2014-11-19 09:39:56 +01:00
parent e4dd893ea2
commit 5c959616aa
3 changed files with 6 additions and 6 deletions

View File

@ -7,7 +7,7 @@
GMIO_C_LINKAGE_BEGIN GMIO_C_LINKAGE_BEGIN
/*! Stream that can get input from an arbitrary data source or can write output to an arbitrary /*! Stream that can get input from an arbitrary data source or can write output to an arbitrary
* data sink * data sink. It can be seen as generalization of the standard FILE*
*/ */
struct gmio_stream struct gmio_stream
{ {

View File

@ -5,16 +5,16 @@
#include "stream.h" #include "stream.h"
#include "task_control.h" #include "task_control.h"
/*! Defines data required for any transfer(read/write) operation */ /*! Defines objects required for any transfer(read/write) operation */
struct gmio_transfer struct gmio_transfer
{ {
/*! The stream to be used for I/O */ /*! The stream object to be used for I/O */
gmio_stream_t stream; gmio_stream_t stream;
/*! The optional control object used to handle progress of the transfer */ /*! The optional control object used to handle progress of the transfer */
gmio_task_control_t task_control; gmio_task_control_t task_control;
/*! Pointer on a user memory area used by the transfer as a buffer for stream optimization */ /*! Pointer on a memory buffer used by the transfer for stream operations */
void* buffer; void* buffer;
/*! Size (in bytes) of the memory buffer */ /*! Size (in bytes) of the memory buffer */

View File

@ -96,7 +96,7 @@ static gmio_bool_t gmio_transfer_flush_buffer(gmio_transfer_t* trsf, size_t n)
#define _GMIO_INTERNAL_MIN(v1, v2) ((v1) < (v2) ? (v1) : (v2)) #define _GMIO_INTERNAL_MIN(v1, v2) ((v1) < (v2) ? (v1) : (v2))
/*! \param geom Defines the custom geometry to write /*! \param mesh Defines the mesh to write
* \param trsf Defines needed objects (stream, buffer, ...) for the writing operation * \param trsf Defines needed objects (stream, buffer, ...) for the writing operation
* \param solid_name May be NULL to generate default name * \param solid_name May be NULL to generate default name
* \param real32_prec The maximum number of significant digits * \param real32_prec The maximum number of significant digits