---------------------
PatchSet 6019 
Date: 2007/10/27 10:11:22
Author: amosjeffries
Branch: docs
Tag: (none) 
Log:
Link pinger external app to docs

Members: 
	doc/Programming-Guide/ExternalPrograms.dox:1.1.2.2->1.1.2.3 
	src/pinger.cc:1.15->1.15.2.1 

Index: squid3/doc/Programming-Guide/ExternalPrograms.dox
===================================================================
RCS file: /cvsroot/squid-sf//squid3/doc/Programming-Guide/Attic/ExternalPrograms.dox,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- squid3/doc/Programming-Guide/ExternalPrograms.dox	9 Aug 2007 06:25:19 -0000	1.1.2.2
+++ squid3/doc/Programming-Guide/ExternalPrograms.dox	27 Oct 2007 10:11:22 -0000	1.1.2.3
@@ -1,19 +1,6 @@
 /**
 \defgroup ExternalPrograms External Programs
 
-\section pinger pinger
-\par
-	Although it would be possible for Squid to send and receive
-	ICMP messages directly, we use an external process for
-	two important reasons:
-	\li Because squid handles many filedescriptors simultaneously,
-	we get much more accurate RTT measurements when ICMP is
-	handled by a separate process.
-	\li Superuser privileges are required to send and receive
-	ICMP.  Rather than require Squid to be started as root,
-	we prefer to have the smaller and simpler pinger
-	program installed with setuid permissions.
-
 \section redirector redirector
 \par
 	A redirector process reads URLs on stdin and writes (possibly
Index: squid3/src/pinger.cc
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/pinger.cc,v
retrieving revision 1.15
retrieving revision 1.15.2.1
diff -u -r1.15 -r1.15.2.1
--- squid3/src/pinger.cc	30 Apr 2007 17:51:40 -0000	1.15
+++ squid3/src/pinger.cc	27 Oct 2007 10:11:22 -0000	1.15.2.1
@@ -1,6 +1,5 @@
-
 /*
- * $Id: pinger.cc,v 1.15 2007/04/30 17:51:40 squidadm Exp $
+ * $Id: pinger.cc,v 1.15.2.1 2007/10/27 10:11:22 amosjeffries Exp $
  *
  * DEBUG: section 42    ICMP Pinger program
  * AUTHOR: Duane Wessels
@@ -35,6 +34,24 @@
 
 #define SQUID_HELPER 1
 
+/**
+ \defgroup pinger pinger
+ \ingroup ExternalPrograms
+ \par
+ *   Although it would be possible for Squid to send and receive
+ *   ICMP messages directly, we use an external process for
+ *   two important reasons:
+ *
+ \li Because squid handles many filedescriptors simultaneously,
+ *   we get much more accurate RTT measurements when ICMP is
+ *   handled by a separate process.
+ *
+ \li Superuser privileges are required to send and receive ICMP.
+ *   Rather than require Squid to be started as root, we prefer
+ *   to have the smaller and simpler pinger program installed
+ *   with setuid permissions.
+ */
+
 #include "squid.h"
 #include "SquidTime.h"
 
@@ -108,7 +125,7 @@
 
 iphdr;
 
-/* ICMP header */
+/** ICMP header */
 
 typedef struct icmphdr
 {
@@ -224,6 +241,7 @@
 
 #endif
 
+/// \ingroup ExternalPinger
 void
 pingerOpen(void)
 {
@@ -599,6 +617,13 @@
     }
 }
 
+/**
+ \ingroup pinger
+ \par This is the pinger external process.
+ *
+ \param argc Ignored.
+ \param argv Ignored.
+ */
 int
 main(int argc, char *argv[])
 {