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

Minor doc improvements

Browse Source
This commit is contained in:
Hugues Delorme 2015-03-02 16:49:52 +01:00
parent 0a98161182
commit 4f8bdc4a6f
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/gmio_core/endian.h
View File

@ -5,7 +5,7 @@
GMIO_C_LINKAGE_BEGIN GMIO_C_LINKAGE_BEGIN
/*! This enum identifies endian representations of numbers */ /*! This enum identifies common endianness (byte order) of computer memory */
enum gmio_endianness enum gmio_endianness
{ {
GMIO_LITTLE_ENDIAN, GMIO_LITTLE_ENDIAN,

10
src/gmio_stl/stl_io.h
View File

@ -16,12 +16,13 @@ GMIO_C_LINKAGE_BEGIN
/*! \brief Options for gmio_stla_read() /*! \brief Options for gmio_stla_read()
* *
* No options yet, it just exists for future needs * No options yet, it just exists for future needs, which could possibly be:
* - flag to force locale ?
* - case sensitive/insensitive ?
*/ */
struct gmio_stla_read_options struct gmio_stla_read_options
{ {
void* dummy; /*!< Structs must have at least one member in strict ISO-C90 */ void* dummy; /*!< Structs must have at least one member in strict ISO-C90 */
/* Flag to force locale ? */
}; };
typedef struct gmio_stla_read_options gmio_stla_read_options_t; typedef struct gmio_stla_read_options gmio_stla_read_options_t;
@ -32,7 +33,7 @@ typedef struct gmio_stla_read_options gmio_stla_read_options_t;
GMIO_LIBSTL_EXPORT GMIO_LIBSTL_EXPORT
int gmio_stla_read(gmio_stl_mesh_creator_t* creator, int gmio_stla_read(gmio_stl_mesh_creator_t* creator,
gmio_transfer_t* trsf, gmio_transfer_t* trsf,
const gmio_stla_read_options_t* options); /* NULL */ const gmio_stla_read_options_t* options /* NULL */);
/*! \brief Options for gmio_stla_write() /*! \brief Options for gmio_stla_write()
*/ */
@ -51,7 +52,8 @@ typedef struct gmio_stla_write_options gmio_stla_write_options_t;
* \param mesh Defines the mesh to write * \param mesh Defines the mesh to write
* \param trsf Defines needed objects (stream, buffer, ...) for the writing * \param trsf Defines needed objects (stream, buffer, ...) for the writing
* operation * operation
* \param options Options for the writing operation * \param options Options for the writing operation, can be set to NULL to
* use default values
* *
* \return Error code * \return Error code
* \retval GMIO_NO_ERROR If operation successful * \retval GMIO_NO_ERROR If operation successful