From: amosjeffries <>
Date: Wed, 6 Feb 2008 05:38:24 +0000 (+0000)
Subject: Documentation updates.
X-Git-Tag: BASIC_TPROXY4~145
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6d96c80d3faf51df480225e7a9cb64c567bb0782;p=thirdparty%2Fsquid.git

Documentation updates.

- Adds auto-documentation to some ACLARP code
- Adds peer address to NAT filure debugging on Linux.
---

diff --git a/src/ACLARP.cc b/src/ACLARP.cc
index 31d1816bbc..391edb2daa 100644
--- a/src/ACLARP.cc
+++ b/src/ACLARP.cc
@@ -1,6 +1,6 @@
 
 /*
- * $Id: ACLARP.cc,v 1.28 2008/01/22 22:34:47 serassio Exp $
+ * $Id: ACLARP.cc,v 1.29 2008/02/05 22:38:24 amosjeffries Exp $
  *
  * DEBUG: section 28    Access Control
  * AUTHOR: Duane Wessels
@@ -152,9 +152,13 @@ ACLARP::empty () const
  *       Solaris code by R. Gancarz <radekg@solaris.elektrownia-lagisza.com.pl>
  */
 
-/*
- * Decode an ascii representation (asc) of an ethernet adress, and place
- * it in eth[6].
+/**
+ * Decode an ascii representation (asc) of an ethernet adress.
+ *
+ \param asc[in]    ASCII representation of an ethernet (MAC) address
+ \param eth[out]   Binary representation of the ethernet address
+ \retval 0	Conversion to binary failed. Invalid address
+ \retval 1	Conversion completed successfully
  */
 static int
 decode_eth(const char *asc, char *eth)
diff --git a/src/IPInterception.cc b/src/IPInterception.cc
index a8ec83b0bd..e7d510b2b9 100644
--- a/src/IPInterception.cc
+++ b/src/IPInterception.cc
@@ -1,6 +1,6 @@
 
 /*
- * $Id: IPInterception.cc,v 1.19 2007/12/14 23:11:45 amosjeffries Exp $
+ * $Id: IPInterception.cc,v 1.20 2008/02/05 22:38:24 amosjeffries Exp $
  *
  * DEBUG: section 89    NAT / IP Interception 
  * AUTHOR: Robert Collins
@@ -218,7 +218,7 @@ clientNatLookup(int fd, const IPAddress &me, const IPAddress &peer, IPAddress &d
         dst.FreeAddrInfo(lookup);
 
         if (squid_curtime - last_reported > 60) {
-            debugs(89, 1, "clientNatLookup: NF getsockopt(SO_ORIGINAL_DST) failed: " << xstrerror());
+            debugs(89, 1, "clientNatLookup: peer " << peer << " NF getsockopt(SO_ORIGINAL_DST) failed: " << xstrerror());
             last_reported = squid_curtime;
         }