---------------------
PatchSet 6637 
Date: 2008/01/23 02:32:10
Author: amosjeffries
Branch: docs
Tag: (none) 
Log:
Auto-Document a bit of HttpHeader.h

Members: 
	src/HttpHeader.h:1.19.2.5->1.19.2.6 

Index: squid3/src/HttpHeader.h
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/HttpHeader.h,v
retrieving revision 1.19.2.5
retrieving revision 1.19.2.6
diff -u -r1.19.2.5 -r1.19.2.6
--- squid3/src/HttpHeader.h	22 Jan 2008 22:57:47 -0000	1.19.2.5
+++ squid3/src/HttpHeader.h	23 Jan 2008 02:32:10 -0000	1.19.2.6
@@ -1,6 +1,5 @@
-
 /*
- * $Id: HttpHeader.h,v 1.19.2.5 2008/01/22 22:57:47 amosjeffries Exp $
+ * $Id: HttpHeader.h,v 1.19.2.6 2008/01/23 02:32:10 amosjeffries Exp $
  *
  *
  * SQUID Web Proxy Cache          http://www.squid-cache.org/
@@ -44,7 +43,7 @@
 
 /* constant attributes of http header fields */
 
-/* recognized or "known" header fields; @?@ add more! */
+/** recognized or "known" header fields; @?@ add more! */
 typedef enum {
     HDR_BAD_HDR = -1,
     HDR_ACCEPT = 0,
@@ -88,7 +87,7 @@
     HDR_PROXY_CONNECTION,
     HDR_PUBLIC,
     HDR_RANGE,
-    HDR_REQUEST_RANGE,		/* some clients use this, sigh */
+    HDR_REQUEST_RANGE,		/**< some clients use this, sigh */
     HDR_REFERER,
     HDR_RETRY_AFTER,
     HDR_SERVER,
@@ -105,9 +104,9 @@
     HDR_WWW_AUTHENTICATE,
     HDR_AUTHENTICATION_INFO,
     HDR_X_CACHE,
-    HDR_X_CACHE_LOOKUP,		/* tmp hack, remove later */
+    HDR_X_CACHE_LOOKUP,		/**< tmp hack, remove later */
     HDR_X_FORWARDED_FOR,
-    HDR_X_REQUEST_URI,		/* appended if ADD_X_REQUEST_URI is #defined */
+    HDR_X_REQUEST_URI,		/**< appended if ADD_X_REQUEST_URI is #defined */
     HDR_X_SQUID_ERROR,
     HDR_NEGOTIATE,
 #if X_ACCELERATOR_VARY
@@ -120,9 +119,9 @@
     HDR_ENUM_END
 } http_hdr_type;
 
-/* possible types for http header fields */
+/** possible types for http header fields */
 typedef enum {
-    ftInvalid = HDR_ENUM_END,	/* to catch nasty errors with hdr_id<->fld_type clashes */
+    ftInvalid = HDR_ENUM_END,	/**< to catch nasty errors with hdr_id<->fld_type clashes */
     ftInt,
     ftInt64,
     ftStr,
@@ -135,7 +134,7 @@
     ftDate_1123_or_ETag
 } field_type;
 
-/* possible owners of http header */
+/** Possible owners of http header */
 typedef enum {
     hoNone =0,
 #if USE_HTCP
@@ -160,7 +159,7 @@
 
 class HttpHdrSc;
 
-/*iteration for headers; use HttpHeaderPos as opaque type, do not interpret */
+/** Iteration for headers; use HttpHeaderPos as opaque type, do not interpret */
 typedef ssize_t HttpHeaderPos;
 
 /* use this and only this to initialize HttpHeaderPos */
@@ -189,7 +188,7 @@
     String value;
 };
 
-MEMPROXY_CLASS_INLINE(HttpHeaderEntry)          /**DOCS_NOSEMI*/
+MEMPROXY_CLASS_INLINE(HttpHeaderEntry);
 
 class HttpHeader
 {
@@ -247,18 +246,20 @@
     int hasListMember(http_hdr_type id, const char *member, const char separator) const;
     int hasByNameListMember(const char *name, const char *member, const char separator) const;
     void removeHopByHopEntries();
+
     /* protected, do not use these, use interface functions instead */
-    Vector<HttpHeaderEntry *> entries;		/* parsed fields in raw format */
-    HttpHeaderMask mask;	/* bit set <=> entry present */
-    http_hdr_owner_type owner;	/* request or reply */
-    int len;			/* length when packed, not counting terminating '\0' */
+    Vector<HttpHeaderEntry *> entries;		/**< parsed fields in raw format */
+    HttpHeaderMask mask;	/**< bit set <=> entry present */
+    http_hdr_owner_type owner;	/**< request or reply */
+    int len;			/**< length when packed, not counting terminating '\0' */
 
 protected:
+    /** \deprecated Public access replaced by removeHopByHopEntries() */
     void removeConnectionHeaderEntries();
-    
+
 private:
     HttpHeaderEntry *findLastEntry(http_hdr_type id) const;
-    // Make it non-copyable. Our destructor is a bit nasty...
+    /// Made it non-copyable. Our destructor is a bit nasty...
     HttpHeader(const HttpHeader &);
     //assignment is used by the reset method, can't block it..
     //const HttpHeader operator=(const HttpHeader &);