]> mj.ucw.cz Git - libucw.git/commitdiff
Docs: Let eltpool and mempool refer to the corresponding resource functions
authorMartin Mares <mj@ucw.cz>
Tue, 19 Apr 2011 13:55:41 +0000 (15:55 +0200)
committerMartin Mares <mj@ucw.cz>
Tue, 19 Apr 2011 13:55:41 +0000 (15:55 +0200)
ucw/eltpool.h
ucw/mempool.h

index a3a4e427a517d29d92be92c5c88a3866d03ba57f..1b70d440f7548445e1ce606dca04de76a8f92113 100644 (file)
@@ -50,6 +50,8 @@ struct eltpool_free {
  * The pool will allocate chunks of at least @elts_per_chunk elements.
  * Higher numbers lead to better allocation times but also to bigger
  * unused memory blocks. Call @ep_delete() to free all pool's resources.
+ *
+ * Element pools can be treated as <<trans:respools,resources>>, see <<trans:res_eltpool()>>.
  **/
 struct eltpool *ep_new(uns elt_size, uns elts_per_chunk);
 
index e0d2b43cc061b0cd50d09a81910f7bf872101b6e..bcc22bd35bcf755e0aca15ad05e15655bd66332b 100644 (file)
@@ -54,6 +54,8 @@ struct mempool_stats {                        /** Mempool statistics. See @mp_stats(). **/
  * @chunk_size must be in the interval `[1, UINT_MAX / 2]`.
  * It will allocate memory by this large chunks and take
  * memory to satisfy requests from them.
+ *
+ * Memory pools can be treated as <<trans:respools,resources>>, see <<trans:res_mempool()>>.
  **/
 void mp_init(struct mempool *pool, uns chunk_size);
 
@@ -62,6 +64,8 @@ void mp_init(struct mempool *pool, uns chunk_size);
  * See @mp_init() for @chunk_size limitations.
  *
  * The new mempool structure is allocated on the new mempool.
+ *
+ * Memory pools can be treated as <<trans:respools,resources>>, see <<trans:res_mempool()>>.
  **/
 struct mempool *mp_new(uns chunk_size);