From: Amos Jeffries <squid3@treenet.co.nz>
Date: Thu, 7 Oct 2010 06:34:34 +0000 (+1300)
Subject: Document PconnPool
X-Git-Tag: take1~195
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=01eb26fc5a3507443312a3c5e8c60f2ecbe1f4fb;p=thirdparty%2Fsquid.git

Document PconnPool
---

diff --git a/src/pconn.h b/src/pconn.h
index 34e979a084..e874e22c7a 100644
--- a/src/pconn.h
+++ b/src/pconn.h
@@ -65,7 +65,13 @@ class IdleConnLimit;
 /* for hash_table */
 #include "hash.h"
 
-/// \ingroup PConnAPI
+/** \ingroup PConnAPI
+ * Manages idle persistent connections to a caller-defined set of
+ * servers (e.g., all HTTP servers). Uses a collection of IdleConnLists
+ * internally to list the individual open connections to each server.
+ * Controls lists existence and limits the total number of
+ * idle connections across the collection.
+ */
 class PconnPool
 {