X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/12e1d787707bb574c3930f6262a5e751c9a11043..9e291a3a66a2c277895e78b3921c068436e7f9a1:/include/xbt/str.h

diff --git a/include/xbt/str.h b/include/xbt/str.h
index dbb5f8090e..0b4cb72179 100644
--- a/include/xbt/str.h
+++ b/include/xbt/str.h
@@ -11,8 +11,6 @@
 #include "xbt/misc.h"
 #include "xbt/dynar.h"
 
-
-
 #ifndef XBT_STR_H
 #define XBT_STR_H
 
@@ -22,13 +20,39 @@
 
 SG_BEGIN_DECL()
 
+/** @addtogroup XBT_str
+ *  @brief String manipulation functions
+ * 
+ * This module defines several string related functions. We redefine some quite classical 
+ * functions on the platforms were they are not nativaly defined (such as getline() or 
+ * asprintf()), while some other are a bit more exotic. 
+ * @{
+ */
+  
 /* snprintf related functions */
+/** @brief print to allocated string (reimplemented when not provided by the system)
+ * 
+ * The functions asprintf() and vasprintf() are analogues of
+ * sprintf() and vsprintf(), except that they allocate a string large
+ * enough to hold the output including the terminating null byte, and
+ * return a pointer to it via the first parameter.  This pointer
+ * should be passed to free(3) to release the allocated storage when
+ * it is no longer needed.
+ */
 XBT_PUBLIC(int) asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
+/** @brief print to allocated string (reimplemented when not provided by the system)
+ * 
+ * See asprintf()
+ */
 XBT_PUBLIC(int) vasprintf (char **ptr, const char *fmt, va_list ap);
+/** @brief print to allocated string
+ * 
+ * Works just like asprintf(), but returns a pointer to the newly created string
+ */
 XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
 
 /* the gettext function. It gets redefined here only if not yet available */
-#if defined(_WIN32) || !defined(__GNUC__)
+#if defined(_WIN32) || !defined(__GNUC__) || defined(DOXYGEN)
 XBT_PUBLIC(long) getline(char **lineptr, size_t *n, FILE *stream);
 #endif
 
@@ -44,6 +68,8 @@ XBT_PUBLIC(char *) xbt_str_join(xbt_dynar_t dynar, const char *sep);
 XBT_PUBLIC(void) xbt_str_strip_spaces(char *);
 XBT_PUBLIC(char *) xbt_str_diff(char *a, char *b);
 
+/**@}*/
+
 SG_END_DECL()
 
 #endif /* XBT_STR_H */