Document the name of type descriptions created with gras_datadesc_dynar()

[simgrid.git] / src / gras / DataDesc / ddt_create.c

diff --git a/src/gras/DataDesc/ddt_create.c b/src/gras/DataDesc/ddt_create.c
index f8f7fc0..d71a49b 100644 (file)
--- a/src/gras/DataDesc/ddt_create.c
+++ b/src/gras/DataDesc/ddt_create.c
@@ -599,6 +599,10 @@ static void gras_datadesc_dynar_cb(gras_datadesc_type_t typedesc, gras_cbps_t va
 }
 
 /** \brief Declare a new type being a dynar in which each elements are of the given type
+ * 
+ *  The type gets registered under the name "dynar(%s)_s", where %s is the name of the subtype.
+ *  For example, a dynar of doubles will be called "dynar(double)_s" and a dynar of dynar of 
+ *  strings will be called "dynar(dynar(string)_s)_s".
  * 
  *  \param elm_t: the datadesc of the elements
  *  \param free_func: the function to use to free the elements when the dynar gets freed