---------------------
PatchSet 5387 
Date: 2007/08/19 23:13:26
Author: amosjeffries
Branch: docs
Tag: (none) 
Log:
description update of MemPool macros.

Members: 
	include/MemPool.h:1.10.10.4->1.10.10.5 

Index: squid3/include/MemPool.h
===================================================================
RCS file: /cvsroot/squid-sf//squid3/include/MemPool.h,v
retrieving revision 1.10.10.4
retrieving revision 1.10.10.5
diff -u -r1.10.10.4 -r1.10.10.5
--- squid3/include/MemPool.h	17 Aug 2007 04:46:55 -0000	1.10.10.4
+++ squid3/include/MemPool.h	19 Aug 2007 23:13:26 -0000	1.10.10.5
@@ -220,18 +220,9 @@
 
 /**
  \ingroup MemPoolsAPI
+ \hideinitializer
  * 
  * This macro is intended for use within the declaration of a class.
- * Below is an example of how to use it.
- * 
- \code
-   class foo
-   {
-      MEMPROXY_CLASS(foo);
-   }
- \endcode
- \hideinitializer
- \todo change syntax to allow moving into .cci files
  */
 #define MEMPROXY_CLASS(CLASS) \
     inline void *operator new(size_t); \
@@ -240,19 +231,10 @@
 
 /**
  \ingroup MemPoolsAPI
+ \hideinitializer
  * 
  * This macro is intended for use within the .h or .cci of a
  * class as appropriate. Below is an example of how to use it.
- *
- \code
-   class foo
-   {
-      MEMPROXY_CLASS(foo);
-   }
-
-   MEMPROXY_CLASS_INLINE(foo);
- \endcode
- \hideinitializer
  */
 #define MEMPROXY_CLASS_INLINE(CLASS) \
 MemAllocatorProxy& CLASS::Pool() \
@@ -419,6 +401,7 @@
 #define memPoolCreate MemPools::GetInstance().create
 
 /* Allocator API */
+/8 AYJ: these appear to be only referenced from internal MemPools methods */
 /// \ingroup MemPoolsAPI
 extern MemPoolIterator * memPoolIterate(void);
 /// \ingroup MemPoolsAPI