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 bad5131593756f020f60e6423f0fe0058ab4e746..7e4b662d7d4a216453929531040c8230a6137e4a 100644 (file)
--- 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;