From: Martin Mares Date: Mon, 18 Apr 2011 19:51:06 +0000 (+0200) Subject: fb-grow: Updated documentation, so that our doc tools can digest it X-Git-Tag: v5.0~74^2~19 X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=f9526b65f58e9e2d11c5fdec03843f8d3a6210a0;p=libucw.git fb-grow: Updated documentation, so that our doc tools can digest it --- diff --git a/ucw/fastbuf.h b/ucw/fastbuf.h index 197dc94f..f418f667 100644 --- a/ucw/fastbuf.h +++ b/ucw/fastbuf.h @@ -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]]