gmio_stl: more docs

This commit is contained in:
Hugues Delorme 2015-12-18 10:45:51 +01:00
parent ce50f76ef0
commit b8299e38ac
5 changed files with 11 additions and 7 deletions

View File

@ -18,6 +18,7 @@
#include "../stl_infos.h"
/*! Find infos from a STL ASCII stream */
int gmio_stla_infos_get(
struct gmio_stl_infos_get_args* args, unsigned flags);

View File

@ -19,6 +19,7 @@
#include "../stl_infos.h"
#include "../../gmio_core/endian.h"
/*! Find infos from a STL binary stream */
int gmio_stlb_infos_get(
struct gmio_stl_infos_get_args* args,
enum gmio_endianness byte_order,

View File

@ -99,7 +99,7 @@ int gmio_stlb_write(
error = gmio_stlb_write_header(
&core_args->stream,
byte_order,
args->options.stlb_header_data,
args->options.stlb_header,
facet_count);
if (gmio_error(error))
return error;

View File

@ -44,16 +44,18 @@ struct gmio_stl_infos
* For STL ascii it includes the "endsolid" tag */
gmio_streamsize_t size;
/*! STL ascii only: name of the solid, the pointer has to be set by the
* caller of gmio_stl_infos_get() */
/*! STL ascii only: name of the solid
*
* The pointer has to be set by the caller of gmio_stl_infos_get() */
char* stla_solidname;
/*! STL ascii only: maximum length(capacity) of stla_solidname, it has to be
* set by the caller of gmio_stl_infos_get()
/*! STL ascii only: maximum length(capacity) of stla_solidname
*
* The value has to be set by the caller of gmio_stl_infos_get()
*/
size_t stla_solidname_maxlen;
/*! STL binary only */
/*! STL binary only: header(80-bytes) of STL data */
struct gmio_stlb_header stlb_header;
};

View File

@ -42,7 +42,7 @@ struct gmio_stl_read_args
/*! Optional pointer to a function that returns the size(in bytes) of the
* STL ascii data to read
*
* Useful only with STL ascii format. If set to NULL then by default the
* Useful only with STL ascii format. If set to NULL then by default
* gmio_stream::func_size() is called.
*
* The resulting stream size is passed to