From: Amos Jeffries <squid3@treenet.co.nz>
Date: Wed, 24 Dec 2008 13:35:21 +0000 (+1300)
Subject: Documentation updates
X-Git-Tag: SQUID_3_2_0_1~1285
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9035d1d56b7cf56995168b4d5b38ddaae545b48b;p=thirdparty%2Fsquid.git

Documentation updates
---

diff --git a/src/HttpHeaderTools.cc b/src/HttpHeaderTools.cc
index fba64bfe5a..aa7a7cf76c 100644
--- a/src/HttpHeaderTools.cc
+++ b/src/HttpHeaderTools.cc
@@ -141,7 +141,7 @@ httpHeaderPutStrvf(HttpHeader * hdr, http_hdr_type id, const char *fmt, va_list
 }
 
 
-/* wrapper arrounf PutContRange */
+/** wrapper arrounf PutContRange */
 void
 httpHeaderAddContRange(HttpHeader * hdr, HttpHdrRangeSpec spec, int64_t ent_len)
 {
@@ -153,7 +153,7 @@ httpHeaderAddContRange(HttpHeader * hdr, HttpHdrRangeSpec spec, int64_t ent_len)
 }
 
 
-/*
+/**
  * return true if a given directive is found in at least one of
  * the "connection" header-fields note: if HDR_PROXY_CONNECTION is
  * present we ignore HDR_CONNECTION.
diff --git a/src/http.cc b/src/http.cc
index 76faf0852d..f07c03c8d9 100644
--- a/src/http.cc
+++ b/src/http.cc
@@ -948,7 +948,8 @@ HttpStateData::persistentConnStatus() const
     if (eof) // already reached EOF
         return COMPLETE_NONPERSISTENT_MSG;
 
-    /* In chunked responce we do not know the content length but we are absolutelly
+    /** \par
+     * In chunked response we do not know the content length but we are absolutely
      * sure about the end of response, so we are calling the statusIfComplete to
      * decide if we can be persistant
      */
@@ -963,7 +964,8 @@ HttpStateData::persistentConnStatus() const
     if (clen < 0)
         return INCOMPLETE_MSG;
 
-    /* If the body size is known, we must wait until we've gotten all of it. */
+    /** \par
+     * If the body size is known, we must wait until we've gotten all of it. */
     if (clen > 0) {
         // old technique:
         // if (entry->mem_obj->endOffset() < vrep->content_length + vrep->hdr_sz)
@@ -975,7 +977,8 @@ HttpStateData::persistentConnStatus() const
             return INCOMPLETE_MSG;
     }
 
-    /* If there is no message body or we got it all, we can be persistent */
+    /** \par
+     * If there is no message body or we got it all, we can be persistent */
     return statusIfComplete();
 }