BEGIN_DECL()
-/** @defgroup GRAS_dd Data description
+/** @addtogroup GRAS_dd Data description
* @brief Describing data to be exchanged (Communication facility)
*
* @section Overview
*
* There is several possible interfaces for this, ranging from the really completely automatic parsing to
* completely manual. Let's study each of them from the simplest to the more advanced.
+ *
+ * \warning At least, I would like to present those sections in the right order, but doxygen prevents me
+ * from doing so. There is a weird bug I fail to circumvent here. The right order is naturally:
+ * -# basic operations
+ * -# Automatic parsing
+ * -# Simple manual definitions
+ * -# Callback Persistant State: Simple push/pop mechanism
+ * -# Callback Persistant State: Full featured mechanism
*/
-
-/** @name a) basic operations
- * @ingroup GRAS_dd
+/*@{*/
+
+/** @name 1. basic operations
*
* If you only want to send pre-existing types, simply retrieve the pre-defined description with
* the \ref gras_datadesc_by_name function. Existing types entail:
/* @} */
-/** @name b) Automatic parsing
- * @ingroup GRAS_dd
+/** @name 2. Automatic parsing
*
* If you need to declare a new datatype, this is the simplest way to describe it to GRAS. Simply
* enclose its type definition into a \ref GRAS_DEFINE_TYPE macro call, and you're set. Here is
* It specifies that the structure s_array contains two fields, and that the size of the array pointed
* by \a data is the \a length field, and that the \a father field is a simple reference.
*
- * If you cannot express your datadescs with this mecanism, you'll have to use the more advanced
+ * If you cannot express your datadescs with this mechanism, you'll have to use the more advanced
* (and somehow complex) one described below.
*
* \warning Since GRAS_DEFINE_TYPE is a macro, you shouldn't put any comma in your type definition
gras_datadesc_type_t
gras_datadesc_parse(const char *name, const char *C_statement);
-/** @name c) Simple manual definitions
- * @ingroup GRAS_dd
+/** @name 3. Simple manual definitions
*
* Here are the functions to use if you want to declare your description manually.
* The function names should be self-explanatory in most cases.
*
* If your types are dynamic, you'll need to add some extra callback. For example, there is a
* specific callback for the string type which is in charge of computing the length of the char
- * array. This is done with the cbps mecanism, explained in next section.
+ * array. This is done with the cbps mechanism, explained in next section.
*
* If your types may contain pointer cycle, you must specify it to GRAS using the @ref gras_datadesc_cycle_set.
*
**** Declare datadescription yourself ****
******************************************/
-/** \brief Declare a new structure description */
gras_datadesc_type_t gras_datadesc_struct(const char *name);
+void gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
+ const char *name,
+ gras_datadesc_type_t field_type);
+void gras_datadesc_struct_close(gras_datadesc_type_t struct_type);
-/** \brief Append a new field to a structure description */
-void
- gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
- const char *name,
- gras_datadesc_type_t field_type);
-/** \brief Close a structure description */
-void
- gras_datadesc_struct_close(gras_datadesc_type_t struct_type);
-/** \brief Declare a new union description */
-gras_datadesc_type_t
- gras_datadesc_union(const char *name,
- gras_datadesc_type_cb_int_t selector);
-/** \brief Append a new field to an union description */
-void
- gras_datadesc_union_append(gras_datadesc_type_t union_type,
- const char *name,
- gras_datadesc_type_t field_type);
-/** \brief Close an union description */
-void
- gras_datadesc_union_close(gras_datadesc_type_t union_type);
+gras_datadesc_type_t gras_datadesc_union(const char *name,
+ gras_datadesc_type_cb_int_t selector);
+void gras_datadesc_union_append(gras_datadesc_type_t union_type,
+ const char *name,
+ gras_datadesc_type_t field_type);
+void gras_datadesc_union_close(gras_datadesc_type_t union_type);
-/** \brief Declare a new type being a reference to the one passed in arg */
gras_datadesc_type_t
- gras_datadesc_ref(const char *name,
- gras_datadesc_type_t referenced_type);
-/** \brief Declare a new type being a generic reference. */
+ gras_datadesc_ref(const char *name,
+ gras_datadesc_type_t referenced_type);
gras_datadesc_type_t
- gras_datadesc_ref_generic(const char *name,
- gras_datadesc_selector_t selector);
+ gras_datadesc_ref_generic(const char *name,
+ gras_datadesc_selector_t selector);
-/** \brief Declare a new type being an array of fixed size and content */
gras_datadesc_type_t
- gras_datadesc_array_fixed(const char *name,
- gras_datadesc_type_t element_type,
- long int fixed_size);
-
-/** \brief Declare a new type being an array of fixed size, but accepting several content types. */
+ gras_datadesc_array_fixed(const char *name,
+ gras_datadesc_type_t element_type,
+ long int fixed_size);
gras_datadesc_type_t
gras_datadesc_array_dyn(const char *name,
gras_datadesc_type_t element_type,
gras_datadesc_type_cb_int_t dynamic_size);
-
-/** \brief Declare a new type being an array which size can be found with \ref gras_cbps_i_pop */
gras_datadesc_type_t
gras_datadesc_ref_pop_arr(gras_datadesc_type_t element_type);
/*@}*/
-/** @name Callback Persistant State: Simple push/pop mecanism
- * @ingroup GRAS_dd
+/** @name 4. Callback Persistant State: Simple push/pop mechanism
*
* Sometimes, one of the callbacks need to leave information for the next ones. If this is a simple integer (such as
* an array size), you can use the functions described here. If not, you'll have to play with the complete cbps interface.
/*@}*/
-/** @name Callback Persistant State: Full featured mecanism
- * @ingroup GRAS_dd
+/** @name 5. Callback Persistant State: Full featured mechanism
*
- * Sometimes, one of the callbacks need to leave information for the next ones. If the simple push/pop mecanism
+ * Sometimes, one of the callbacks need to leave information for the next ones. If the simple push/pop mechanism
* introduced in previous section isn't enough, you can always use this full featured one.
*/
gras_cbps_block_end(gras_cbps_t ps);
/* @} */
+/*@}*/
/*******************************