documented fbpool briefly

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index 1020427b5d80f301b4044a6dd2d79d55742f3f37..09114f4cf98090bce6a6c2901b51175538cc5bcb 100644 (file)
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -152,9 +152,11 @@ struct fbpool {
   struct mempool *mp;
 };
 
-void fbpool_init(struct fbpool *fb);
+void fbpool_init(struct fbpool *fb);   /* Initialize a new fastbuf */
 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
-void *fbpool_end(struct fbpool *fb);
+                                       /* Start a new continuous block and prepare for writing (see mp_start()) */
+void *fbpool_end(struct fbpool *fb);   /* Close the block and return its address (see mp_end()).
+                                          The length can be determined with mp_size(mp, ptr). */
 
 /* FastO with atomic writes for multi-threaded programs */