---------------------
PatchSet 5390 
Date: 2007/08/20 00:35:23
Author: amosjeffries
Branch: docs
Tag: (none) 
Log:
Some spelling and phrasing changes.

Members: 
	include/MemPool.h:1.10.10.6->1.10.10.7 

Index: squid3/include/MemPool.h
===================================================================
RCS file: /cvsroot/squid-sf//squid3/include/MemPool.h,v
retrieving revision 1.10.10.6
retrieving revision 1.10.10.7
diff -u -r1.10.10.6 -r1.10.10.7
--- squid3/include/MemPool.h	20 Aug 2007 00:24:02 -0000	1.10.10.6
+++ squid3/include/MemPool.h	20 Aug 2007 00:35:23 -0000	1.10.10.7
@@ -294,8 +294,7 @@
  \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.
+ * This macro is intended for use within the .h or .cci of a class as appropriate.
  */
 #define MEMPROXY_CLASS_INLINE(CLASS) \
 MemAllocatorProxy& CLASS::Pool() \
@@ -516,11 +515,13 @@
 
 /**
  \ingroup MemPoolsAPI
- *
- * Fills MemPoolGlobalStats struct with statistical data about overall
- * usage for all pools. As a return value returns number of pools that
- * have at least one object in use. Ie. number of dirty pools.
  \todo Stats API - not sured how to refactor yet
+ *
+ * Fills MemPoolGlobalStats with statistical data about overall
+ * usage for all pools.
+ *
+ \retval  Number of pools that have at least one object in use.
+ *        Ie. number of dirty pools.
  */
 extern int memPoolGetGlobalStats(MemPoolGlobalStats * stats);