add documentation for obstack_printf
authorMatthias Braun <matze@braunis.de>
Fri, 9 Jul 2010 16:17:03 +0000 (16:17 +0000)
committerMatthias Braun <matze@braunis.de>
Fri, 9 Jul 2010 16:17:03 +0000 (16:17 +0000)
[r27719]

include/libfirm/adt/obstack.h

index 6ce2d8d..220eeb3 100644 (file)
@@ -501,9 +501,13 @@ __extension__                                                              \
 
 #endif /* not __GNUC__ or not __STDC__ */
 
-int obstack_vprintf(struct obstack *obst, const char *fmt, va_list ap);
+
+/** prints formated string (printf-style format) to an obstack.
+ * This is done by "growing" the obstack with the obstack_*grow*
+ * functions. Note: Does NOT append a null-byte. */
 int obstack_printf(struct obstack *obst, const char *fmt, ...);
+int obstack_vprintf(struct obstack *obst, const char *fmt, va_list ap);
 
 #include "../end.h"
 
-#endif /* obstack.h */
+#endif