Minor fixes

This commit is contained in:
Hugues Delorme 2017-03-29 12:05:52 +02:00
parent 1521a12c71
commit dd57fa5d54
3 changed files with 28 additions and 31 deletions

View File

@ -263,28 +263,6 @@ struct gmio_amf_document {
uint32_t element_index,
void* ptr_element);
/*! Optional function that retrieves the i-th \c composite within a
* \c material element
*
* Function not required(can be set to \c NULL) if there is no material
* composite in the document */
void (*func_get_material_composite)(
const void* cookie,
uint32_t material_index,
uint32_t composite_index,
struct gmio_amf_composite* ptr_composite);
/*! Optional function that retrieves the i-th \c instance within a
* \c constellation element
*
* Function not required(can be set to \c NULL) if there is no
* constellation in the document */
void (*func_get_constellation_instance)(
const void* cookie,
uint32_t constellation_index,
uint32_t instance_index,
struct gmio_amf_instance* ptr_instance);
/*! Function that retrieves the i-th \c mesh within an \c object element */
void (*func_get_object_mesh)(
const void* cookie,
@ -315,7 +293,29 @@ struct gmio_amf_document {
uint32_t triangle_index,
struct gmio_amf_triangle* ptr_triangle);
/* Function pointers to retrieve metadata */
/*! Optional function that retrieves the i-th \c composite within a
* \c material element
*
* Function not required(can be set to \c NULL) if there is no material
* composite in the document */
void (*func_get_material_composite)(
const void* cookie,
uint32_t material_index,
uint32_t composite_index,
struct gmio_amf_composite* ptr_composite);
/*! Optional function that retrieves the i-th \c instance within a
* \c constellation element
*
* Function not required(can be set to \c NULL) if there is no
* constellation in the document */
void (*func_get_constellation_instance)(
const void* cookie,
uint32_t constellation_index,
uint32_t instance_index,
struct gmio_amf_instance* ptr_instance);
/* Optional function pointers to retrieve metadata */
/*! Optional function that retrieves the i-th metadata assigned to a
* document sub-element

View File

@ -31,14 +31,14 @@
* Global declarations for the AMF module
*
* \defgroup gmio_amf gmioAMF
* Provides API to handle input/output operations with the AMF file format
* Provides API to handle output operations with the AMF file format
*
* In addition, the gmioAMF module has the following advatanges:
* \li The user keeps its own geometry data structures, no conversion needed.
* \li Fixed memory consumption and independant of the geometry size
*
* In this module, the name of all entities(structures, functions, ...) are
* prefixed either with \c gmio_amf
* prefixed with \c gmio_amf
*
* <table>
* <tr>

View File

@ -101,8 +101,7 @@ int gmio_stla_parse_solidname_beg(struct gmio_stla_parse_data* data);
/* Eats next token string and checks it against an expected token
*
* This procedure copies the token string into internal
* struct gmio_stla_parse_data::strbuff
*/
* struct gmio_stla_parse_data::strbuff */
int gmio_stla_eat_next_token(
struct gmio_stla_parse_data* data, enum gmio_stla_token expected_token);
@ -111,14 +110,12 @@ int gmio_stla_eat_next_token(
* This procedure does the same thing as parsing_eat_next_token() but is faster
* as it does not copy the token string(it just "reads" it).
* It performs "in-place" case insensitive string comparison of the current
* token string against expected
*/
* token string against expected */
int gmio_stla_eat_next_token_inplace(
struct gmio_stla_parse_data* data, enum gmio_stla_token expected_token);
/* Eats contents until some expected "end" token is matched
*
* Array \p end_tokens must end with a "null_token" item
*/
* Array \p end_tokens must end with a "null_token" item */
int gmio_stla_eat_until_token(
struct gmio_stla_parse_data* data, const enum gmio_stla_token* end_tokens);