Minor doc improvements
This commit is contained in:
parent
e4dd893ea2
commit
5c959616aa
@ -7,7 +7,7 @@
|
||||
GMIO_C_LINKAGE_BEGIN
|
||||
|
||||
/*! 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
|
||||
{
|
||||
|
@ -5,16 +5,16 @@
|
||||
#include "stream.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
|
||||
{
|
||||
/*! The stream to be used for I/O */
|
||||
/*! The stream object to be used for I/O */
|
||||
gmio_stream_t stream;
|
||||
|
||||
/*! The optional control object used to handle progress of the transfer */
|
||||
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;
|
||||
|
||||
/*! Size (in bytes) of the memory buffer */
|
||||
|
@ -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))
|
||||
|
||||
/*! \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 solid_name May be NULL to generate default name
|
||||
* \param real32_prec The maximum number of significant digits
|
||||
@ -105,7 +105,7 @@ static gmio_bool_t gmio_transfer_flush_buffer(gmio_transfer_t* trsf, size_t n)
|
||||
*
|
||||
* \retval GMIO_NO_ERROR If operation successful
|
||||
*/
|
||||
int gmio_stla_write(const gmio_stl_mesh_t *mesh,
|
||||
int gmio_stla_write(const gmio_stl_mesh_t* mesh,
|
||||
gmio_transfer_t* trsf,
|
||||
const char* solid_name,
|
||||
uint8_t real32_prec)
|
||||
|
Loading…
Reference in New Issue
Block a user