X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Fbbuf.h;h=bb023a02ef73a1029668f27bd7acdb974f84347f;hb=92b3bd34e6024ec20c67e3c1285f3a442fe6f326;hp=24c2c0b9106657b1c2474165e4f0d9f3a348414a;hpb=031256ad2e123eec58521f8e3eb9496c197641d2;p=libucw.git

diff --git a/ucw/bbuf.h b/ucw/bbuf.h
index 24c2c0b9..bb023a02 100644
--- a/ucw/bbuf.h
+++ b/ucw/bbuf.h
@@ -12,11 +12,35 @@
 
 #define	GBUF_TYPE	byte
 #define	GBUF_PREFIX(x)	bb_##x
-#include "ucw/gbuf.h"
+#include <ucw/gbuf.h>
 
+/**
+ * printf() into a growing buffer with `va_list` arguments.
+ * Generates a `'\0'`-terminated string at the beginning of the buffer
+ * and returns pointer to it.
+ *
+ * See @bb_printf().
+ **/
 char *bb_vprintf(bb_t *bb, const char *fmt, va_list args);
+/**
+ * printf() into a growing buffer.
+ * Generates a `'\0'`-terminated string at the beginning of the buffer
+ * and returns pointer to it.
+ *
+ * See @bb_vprintf().
+ **/
 char *bb_printf(bb_t *bb, const char *fmt, ...);
+/**
+ * Like @bb_vprintf(), but it does not start at the beginning of the
+ * buffer, but @ofs bytes further.
+ *
+ * Returns pointer to the new string (eg. @ofs bytes after the
+ * beginning of buffer).
+ **/
 char *bb_vprintf_at(bb_t *bb, uns ofs, const char *fmt, va_list args);
+/**
+ * Like @bb_vprintf_at(), but it takes individual arguments.
+ **/
 char *bb_printf_at(bb_t *bb, uns ofs, const char *fmt, ...);
 
 #endif