X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/eed8daedf7c2d58e0db96826205f138cedb9cc5a..337c0de59186a44f7a146bc28628ee10f6e5f9ed:/include/gras/datadesc.h diff --git a/include/gras/datadesc.h b/include/gras/datadesc.h index 3df17d1c7c..7ea963ead9 100644 --- a/include/gras/datadesc.h +++ b/include/gras/datadesc.h @@ -16,12 +16,7 @@ SG_BEGIN_DECL() /** @addtogroup GRAS_dd Data description - * @brief Describing data to be exchanged (Communication facility) - * - *
Top [\ref index]::[\ref GRAS_API] - *
Prev - *
Next [\ref GRAS_sock] - *
Down [\ref GRAS_dd_basic]
+ * @brief Describing data to be exchanged * * Since GRAS takes care of potential representation conversion when the platform is heterogeneous, * any data which transits on the network must be described beforehand. @@ -44,9 +39,7 @@ SG_BEGIN_DECL() /** @defgroup GRAS_dd_basic Basic operations on data descriptions * @ingroup GRAS_dd - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_dd] - *
Prev - *
Next [\ref GRAS_dd_auto]
+ * \htmlonly \endhtmlonly * * 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: @@ -72,9 +65,7 @@ gras_datadesc_type_t gras_datadesc_by_name(const char *name); /** @defgroup GRAS_dd_auto Automatic parsing of data descriptions * @ingroup GRAS_dd - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_dd] - *
Prev [\ref GRAS_dd_basic] - *
Next [\ref GRAS_dd_manual]
+ * \htmlonly \endhtmlonly * * 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 @@ -165,9 +156,6 @@ gras_datadesc_parse(const char *name, const char *C_statement); /** @defgroup GRAS_dd_manual Simple manual data description * @ingroup GRAS_dd - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_dd] - *
Prev [\ref GRAS_dd_auto] - *
Next [\ref GRAS_dd_cb_simple]
* * Here are the functions to use if you want to declare your description manually. * The function names should be self-explanatory in most cases. @@ -298,13 +286,11 @@ int gras_datadesc_get_id(gras_datadesc_type_t ddt); /** @defgroup GRAS_dd_cb_simple Data description with Callback Persistant State: Simple push/pop mechanism * @ingroup GRAS_dd - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_dd] - *
Prev [\ref GRAS_dd_manual] - *
Next [\ref GRAS_dd_cb_full]
* * 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. * + * \htmlonly \endhtmlonly * * Here is an example:\verbatim struct s_array { @@ -367,12 +353,14 @@ void gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t typedesc, gras_cbps_t /** @defgroup GRAS_dd_cb_full Data description with Callback Persistant State: Full featured interface * @ingroup GRAS_dd - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_dd] - *
Prev [\ref GRAS_dd_cb_simple] - *
Next
* - * 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. + * 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. The bad point is + * that it is quite badly documented... + * + * \htmlonly \endhtmlonly + * */ /* @{ */