Document the gras_datadesc_dynar function

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@2158 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/src/gras/DataDesc/ddt_create.c b/src/gras/DataDesc/ddt_create.c
index 1ac7274..8cedb27 100644 (file)
--- a/src/gras/DataDesc/ddt_create.c
+++ b/src/gras/DataDesc/ddt_create.c
@@ -592,6 +592,11 @@ static void gras_datadesc_dynar_cb(gras_datadesc_type_t typedesc, gras_cbps_t va
   dynar->size = dynar->used;
 }
 
+/** \brief Declare a new type being a dynar in which each elements are of the given type
+ * 
+ *  \param elm_t: the datadesc of the elements
+ *  \param free_func: the function to use to free the elements when the dynar gets freed
+ */
 gras_datadesc_type_t
 gras_datadesc_dynar(gras_datadesc_type_t elm_t,
                    void_f_pvoid_t *free_func) {