]> mj.ucw.cz Git - libucw.git/commitdiff
fb-grow: Updated documentation, so that our doc tools can digest it
authorMartin Mares <mj@ucw.cz>
Mon, 18 Apr 2011 19:51:06 +0000 (21:51 +0200)
committerMartin Mares <mj@ucw.cz>
Mon, 18 Apr 2011 19:51:06 +0000 (21:51 +0200)
ucw/fastbuf.h

index 197dc94f6f23240cace560865587e7a90df7a178..f418f66798ca4df430753e6288cd98cd7f4b53b4 100644 (file)
@@ -387,9 +387,13 @@ struct fastbuf *fbgrow_create(unsigned basic_size);        /** Create the growing buffe
 struct fastbuf *fbgrow_create_mp(struct mempool *mp, unsigned basic_size); /** Create the growing buffer pre-allocated to @basic_size bytes. **/
 void fbgrow_reset(struct fastbuf *b);                  /** Reset stream and prepare for writing. **/
 void fbgrow_rewind(struct fastbuf *b);                 /** Prepare for reading (of already written data). **/
-uns fbgrow_get_buf(struct fastbuf *b, byte **buf);     /** Can be used in any state of @b (for example when writing or after fbgrow_rewind()) to
-                                                           return the pointer to internal buffer and its length in bytes. The returned buffer
-                                                           can be invalidated by further requests. **/
+
+/**
+ * Can be used in any state of @b (for example when writing or after
+ * @fbgrow_rewind()) to return the pointer to internal buffer and its length in
+ * bytes. The returned buffer can be invalidated by further requests.
+ **/
+uns fbgrow_get_buf(struct fastbuf *b, byte **buf);
 
 /***
  * === Fastbuf on memory pools [[fbpool]]