From: Michal Vaner <vorner@ucw.cz>
Date: Fri, 3 Oct 2008 18:15:40 +0000 (+0200)
Subject: ucw docs: Mempool struct internals are private
X-Git-Tag: holmes-import~268
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=6e6c3447234fc657c209fbed2dea20b08aabedcb;p=libucw.git

ucw docs: Mempool struct internals are private

Tells the user not to dig inside.
---

diff --git a/ucw/mempool.h b/ucw/mempool.h
index bad51315..7e4b662d 100644
--- a/ucw/mempool.h
+++ b/ucw/mempool.h
@@ -19,14 +19,19 @@
 
 /**
  * Memory pool state (see @mp_push(), ...).
- ***/
+ * You should use this one as an opaque handle only, the insides are internal.
+ **/
 struct mempool_state {
   uns free[2];
   void *last[2];
   struct mempool_state *next;
 };
 
-struct mempool { /** Memory pool. **/
+/**
+ * Memory pool.
+ * You should use this one as an opaque handle only, the insides are internal.
+ **/
+struct mempool {
   struct mempool_state state;
   void *unused, *last_big;
   uns chunk_size, threshold, idx;