Opt: Documented opt and its interaction with conf

[libucw.git] / ucw / bbuf.h

diff --git a/ucw/bbuf.h b/ucw/bbuf.h
index 24c2c0b9106657b1c2474165e4f0d9f3a348414a..9e26436b58d99cb7bc804c6406668d8995b8f191 100644 (file)
--- a/ucw/bbuf.h
+++ b/ucw/bbuf.h
@@ -10,13 +10,44 @@
 #ifndef _UCW_BBUF_H
 #define _UCW_BBUF_H
 
+#ifdef CONFIG_UCW_CLEAN_ABI
+#define bb_printf ucw_bb_printf
+#define bb_printf_at ucw_bb_printf_at
+#define bb_vprintf ucw_bb_vprintf
+#define bb_vprintf_at ucw_bb_vprintf_at
+#endif
+
 #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