version number changed to 4.0

[libucw.git] / ucw / bbuf.h

diff --git a/ucw/bbuf.h b/ucw/bbuf.h
index 24c2c0b9106657b1c2474165e4f0d9f3a348414a..ecc1f66c1b6fa1ca198e7ed945979bd7ac43d2d7 100644 (file)
--- a/ucw/bbuf.h
+++ b/ucw/bbuf.h
@@ -14,9 +14,33 @@
 #define        GBUF_PREFIX(x)  bb_##x
 #include "ucw/gbuf.h"
 
 #define        GBUF_PREFIX(x)  bb_##x
 #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);
 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, ...);
 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);
 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
 char *bb_printf_at(bb_t *bb, uns ofs, const char *fmt, ...);
 
 #endif