From: Martin Mares <mj@ucw.cz>
Date: Tue, 19 Apr 2011 13:55:41 +0000 (+0200)
Subject: Docs: Let eltpool and mempool refer to the corresponding resource functions
X-Git-Tag: v5.0~74^2~1
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=57501aa6ad13a8c4d1448cd4f511e77a0042ad11;p=libucw.git

Docs: Let eltpool and mempool refer to the corresponding resource functions
---

diff --git a/ucw/eltpool.h b/ucw/eltpool.h
index a3a4e427..1b70d440 100644
--- a/ucw/eltpool.h
+++ b/ucw/eltpool.h
@@ -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);
 
diff --git a/ucw/mempool.h b/ucw/mempool.h
index e0d2b43c..bcc22bd3 100644
--- a/ucw/mempool.h
+++ b/ucw/mempool.h
@@ -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);