From: Amos Jeffries <squid3@treenet.co.nz>
Date: Tue, 20 Apr 2010 09:59:12 +0000 (+1200)
Subject: Document more of AccessLogEntry class
X-Git-Tag: SQUID_3_2_0_1~285
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4e26d606c3ab8d5660d145d4c0edf5c8a75237d1;p=thirdparty%2Fsquid.git

Document more of AccessLogEntry class
---

diff --git a/src/AccessLogEntry.h b/src/AccessLogEntry.h
index 2de05b84e5..4ca4de8e26 100644
--- a/src/AccessLogEntry.h
+++ b/src/AccessLogEntry.h
@@ -52,6 +52,10 @@ public:
 
     const char *url;
 
+    /** \brief This subclass holds log info for HTTP protocol
+     * \todo Inner class declarations should be moved outside
+     * \todo details of HTTP held in the parent class need moving into here.
+     */
     class HttpDetails
     {
 
@@ -72,15 +76,21 @@ public:
         }
     } http;
 
-    class ICPDetails
+    /** \brief This subclass holds log info for ICP protocol
+     * \todo Inner class declarations should be moved outside
+     */
+    class IcpDetails
     {
 
     public:
-        ICPDetails() : opcode(ICP_INVALID) {}
+        IcpDetails() : opcode(ICP_INVALID) {}
 
         icp_opcode opcode;
     } icp;
 
+    /** \brief This subclass holds log info for HTCP protocol
+     * \todo Inner class declarations should be moved outside
+     */
     class HtcpDetails
     {
     public:
@@ -89,6 +99,11 @@ public:
         const char *opcode;
     } htcp;
 
+    /** \brief This subclass holds log info for Squid internal stats
+     * \todo Inner class declarations should be moved outside
+     * \todo some details relevant to particular protocols need shuffling to other sub-classes
+     * \todo this object field need renaming to 'squid' or something.
+     */
     class CacheDetails
     {
 
@@ -130,6 +145,9 @@ public:
 
     } cache;
 
+    /** \brief This subclass holds log info for various headers in raw format
+     * \todo shuffle this to the relevant protocol section.
+     */
     class Headers
     {
 
@@ -155,6 +173,7 @@ public:
 
     // Why is this a sub-class and not a set of real "private:" fields?
     // It looks like its duplicating HTTPRequestMethod anyway!
+    // TODO: shuffle this to the relevant protocol section OR replace with request->method
     class Private
     {