X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/90343fd64afa87283f3be2ab7c6504cc47652f27..4cc7314baa37e4baa4fd3a648fb1b13ef9c55ed2:/include/xbt/strbuff.h

diff --git a/include/xbt/strbuff.h b/include/xbt/strbuff.h
index ace5e34c85..2949420011 100644
--- a/include/xbt/strbuff.h
+++ b/include/xbt/strbuff.h
@@ -17,7 +17,18 @@
 
 SG_BEGIN_DECL()
 
-/** Buffer code **/
+/** @defgroup xbt_strbuff String buffers 
+ *  @ingroup XBT_adt
+ * 
+ *  This data container is very similar to the Java StringBuffer: 
+ *  that's a string to which you can add content with a lesser performance 
+ *  penalty than if you recreate a new string from scratch. Once done building 
+ *  your string, you must retrieve the content and free its container.
+ * 
+ *  @{
+ */
+
+/** @brief Buffer data container **/
 struct xbt_strbuff {
   char *data;
   int used, size;
@@ -35,5 +46,6 @@ XBT_PUBLIC(void) xbt_strbuff_chomp(xbt_strbuff_t b);
 XBT_PUBLIC(void) xbt_strbuff_trim(xbt_strbuff_t b);
 XBT_PUBLIC(void) xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns);
 
+/** @} */
 SG_END_DECL()
 #endif