--------------------- PatchSet 5362 Date: 2007/08/17 04:00:56 Author: amosjeffries Branch: docs Tag: (none) Log: Link many ACL interfaces to the ACL API module. Members: src/ACL.h:1.18.10.4->1.18.10.5 src/ACLARP.h:1.4.20.1->1.4.20.2 src/ACLASN.h:1.8.14.1->1.8.14.2 src/ACLBrowser.h:1.2->1.2.32.1 src/ACLCertificate.h:1.3->1.3.28.1 src/ACLCertificateData.h:1.7.20.1->1.7.20.2 src/ACLChecklist.h:1.25.2.2->1.25.2.3 src/ACLData.h:1.6->1.6.20.1 src/ACLDestinationASN.h:1.2->1.2.20.1 src/ACLDestinationDomain.h:1.8->1.8.20.1 src/ACLDomainData.h:1.6.20.1->1.6.20.2 src/ACLExtUser.h:1.5.20.1->1.5.20.2 src/ACLHTTPHeaderData.h:1.2.20.1->1.2.20.2 src/ACLHTTPRepHeader.h:1.2->1.2.20.1 src/ACLHTTPReqHeader.h:1.2->1.2.20.1 src/ACLHTTPStatus.h:1.2.18.1->1.2.18.2 src/ACLIP.h:1.8.20.1->1.8.20.2 src/ACLIdent.h:1.8.20.1->1.8.20.2 src/ACLIntRange.h:1.4->1.4.20.1 src/ACLMaxConnection.h:1.4.20.1->1.4.20.2 src/ACLMaxUserIP.h:1.9.2.1->1.9.2.2 src/ACLMethod.h:1.1->1.1.32.1 src/ACLMethodData.h:1.4.20.1->1.4.20.2 src/ACLMyIP.h:1.5.26.1->1.5.26.2 src/ACLMyPort.h:1.1->1.1.32.1 Index: squid3/src/ACL.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACL.h,v retrieving revision 1.18.10.4 retrieving revision 1.18.10.5 diff -u -r1.18.10.4 -r1.18.10.5 --- squid3/src/ACL.h 15 Aug 2007 02:32:57 -0000 1.18.10.4 +++ squid3/src/ACL.h 17 Aug 2007 04:00:56 -0000 1.18.10.5 @@ -1,6 +1,5 @@ - /* - * $Id: ACL.h,v 1.18.10.4 2007/08/15 02:32:57 amosjeffries Exp $ + * $Id: ACL.h,v 1.18.10.5 2007/08/17 04:00:56 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,6 +34,7 @@ #ifndef SQUID_ACL_H #define SQUID_ACL_H + #include "Array.h" #include "cbdata.h" #include "dlink.h" Index: squid3/src/ACLARP.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLARP.h,v retrieving revision 1.4.20.1 retrieving revision 1.4.20.2 diff -u -r1.4.20.1 -r1.4.20.2 --- squid3/src/ACLARP.h 10 Aug 2007 05:11:13 -0000 1.4.20.1 +++ squid3/src/ACLARP.h 17 Aug 2007 04:00:56 -0000 1.4.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLARP.h,v 1.4.20.1 2007/08/10 05:11:13 amosjeffries Exp $ + * $Id: ACLARP.h,v 1.4.20.2 2007/08/17 04:00:56 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,15 +34,18 @@ #ifndef SQUID_ACLARP_H #define SQUID_ACLARP_H + #include "ACL.h" #include "ACLChecklist.h" #include "splay.h" +/// \ingroup ACLAPI struct acl_arp_data { char eth[6]; }; +/// \ingroup ACLAPI class ACLARP : public ACL { Index: squid3/src/ACLASN.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLASN.h,v retrieving revision 1.8.14.1 retrieving revision 1.8.14.2 diff -u -r1.8.14.1 -r1.8.14.2 --- squid3/src/ACLASN.h 15 Aug 2007 02:48:03 -0000 1.8.14.1 +++ squid3/src/ACLASN.h 17 Aug 2007 04:00:57 -0000 1.8.14.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLASN.h,v 1.8.14.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLASN.h,v 1.8.14.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,6 +34,7 @@ #ifndef SQUID_ACLASN_H #define SQUID_ACLASN_H + #include "ACLData.h" #include "List.h" #include "ACLStrategised.h" @@ -44,11 +44,19 @@ class CacheManager; +/// \ingroup ACLAPI SQUIDCEXTERN int asnMatchIp(List *, struct IN_ADDR); + +/// \ingroup ACLAPI SQUIDCEXTERN void asnInit(void); + +/// \ingroup ACLAPI extern void asnRegisterWithCacheManager(CacheManager & manager); + +/// \ingroup ACLAPI SQUIDCEXTERN void asnFreeMemory(void); +/// \ingroup ACLAPI class ACLASN : public ACLData { Index: squid3/src/ACLBrowser.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLBrowser.h,v retrieving revision 1.2 retrieving revision 1.2.32.1 diff -u -r1.2 -r1.2.32.1 --- squid3/src/ACLBrowser.h 22 Feb 2003 03:14:29 -0000 1.2 +++ squid3/src/ACLBrowser.h 17 Aug 2007 04:00:57 -0000 1.2.32.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLBrowser.h,v 1.2 2003/02/22 03:14:29 squidadm Exp $ + * $Id: ACLBrowser.h,v 1.2.32.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,11 +34,13 @@ #ifndef SQUID_ACLBROWSER_H #define SQUID_ACLBROWSER_H + #include "ACL.h" #include "ACLData.h" #include "ACLRequestHeaderStrategy.h" #include "ACLStrategised.h" +/// \ingroup ACLAPI class ACLBrowser { Index: squid3/src/ACLCertificate.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLCertificate.h,v retrieving revision 1.3 retrieving revision 1.3.28.1 diff -u -r1.3 -r1.3.28.1 --- squid3/src/ACLCertificate.h 26 Feb 2003 03:15:19 -0000 1.3 +++ squid3/src/ACLCertificate.h 17 Aug 2007 04:00:57 -0000 1.3.28.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLCertificate.h,v 1.3 2003/02/26 03:15:19 squidadm Exp $ + * $Id: ACLCertificate.h,v 1.3.28.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,12 +34,14 @@ #ifndef SQUID_ACLCERTIFICATE_H #define SQUID_ACLCERTIFICATE_H + #include "ACL.h" #include "ACLData.h" #include "ACLChecklist.h" #include "ssl_support.h" #include "ACLStrategised.h" +/// \ingroup ACLAPI class ACLCertificateStrategy : public ACLStrategy { @@ -59,6 +60,7 @@ ACLCertificateStrategy&operator=(ACLCertificateStrategy const &); }; +/// \ingroup ACLAPI class ACLCertificate { Index: squid3/src/ACLCertificateData.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLCertificateData.h,v retrieving revision 1.7.20.1 retrieving revision 1.7.20.2 diff -u -r1.7.20.1 -r1.7.20.2 --- squid3/src/ACLCertificateData.h 15 Aug 2007 02:48:03 -0000 1.7.20.1 +++ squid3/src/ACLCertificateData.h 17 Aug 2007 04:00:57 -0000 1.7.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLCertificateData.h,v 1.7.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLCertificateData.h,v 1.7.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,12 +34,14 @@ #ifndef SQUID_ACLCERTIFICATEDATA_H #define SQUID_ACLCERTIFICATEDATA_H + #include "splay.h" #include "ACL.h" #include "ACLData.h" #include "ssl_support.h" #include "ACLStringData.h" +/// \ingroup ACLAPI class ACLCertificateData : public ACLData { Index: squid3/src/ACLChecklist.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLChecklist.h,v retrieving revision 1.25.2.2 retrieving revision 1.25.2.3 diff -u -r1.25.2.2 -r1.25.2.3 --- squid3/src/ACLChecklist.h 6 Aug 2007 08:03:40 -0000 1.25.2.2 +++ squid3/src/ACLChecklist.h 17 Aug 2007 04:00:57 -0000 1.25.2.3 @@ -1,6 +1,5 @@ - /* - * $Id: ACLChecklist.h,v 1.25.2.2 2007/08/06 08:03:40 amosjeffries Exp $ + * $Id: ACLChecklist.h,v 1.25.2.3 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -41,17 +40,20 @@ class ConnStateData; +/// \ingroup ACLAPI class ACLChecklist { public: - /* State class. + /** + * State class. * This abstract class defines the behaviour of * async lookups - which can vary for different ACL types. * Today, every state object must be a singleton. * See NULLState for an example. - * Note that *no* state should be stored in the state object, + * + \note *no* state should be stored in the state object, * they are used to change the behaviour of the checklist, not * to hold information. If you need to store information in the * state object, consider subclassing ACLChecklist, converting it @@ -163,6 +165,7 @@ bool lastACLResult() const { return lastACLResult_; } }; +/// \ingroup ACLAPI SQUIDCEXTERN ACLChecklist *aclChecklistCreate(const acl_access *, HttpRequest *, const char *ident); Index: squid3/src/ACLData.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLData.h,v retrieving revision 1.6 retrieving revision 1.6.20.1 diff -u -r1.6 -r1.6.20.1 --- squid3/src/ACLData.h 8 May 2005 15:52:32 -0000 1.6 +++ squid3/src/ACLData.h 17 Aug 2007 04:00:57 -0000 1.6.20.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLData.h,v 1.6 2005/05/08 15:52:32 squidadm Exp $ + * $Id: ACLData.h,v 1.6.20.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -36,8 +35,8 @@ #ifndef SQUID_ACLDATA_H #define SQUID_ACLDATA_H +/// \ingroup ACLAPI template - class ACLData { Index: squid3/src/ACLDestinationASN.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLDestinationASN.h,v retrieving revision 1.2 retrieving revision 1.2.20.1 diff -u -r1.2 -r1.2.20.1 --- squid3/src/ACLDestinationASN.h 19 Apr 2005 02:14:45 -0000 1.2 +++ squid3/src/ACLDestinationASN.h 17 Aug 2007 04:00:57 -0000 1.2.20.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLDestinationASN.h,v 1.2 2005/04/19 02:14:45 squidadm Exp $ + * $Id: ACLDestinationASN.h,v 1.2.20.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,9 +34,11 @@ #ifndef SQUID_ACLDESTINATIONASN_H #define SQUID_ACLDESTINATIONASN_H + #include "ACLASN.h" #include "ACLStrategy.h" +/// \ingroup ACLAPI class ACLDestinationASNStrategy : public ACLStrategy { @@ -46,9 +47,13 @@ virtual bool requiresRequest() const {return true;} static ACLDestinationASNStrategy *Instance(); - /* Not implemented to prevent copies of the instance. */ - /* Not private to prevent brain dead g+++ warnings about - * private constructors with no friends */ + + /** + * Not implemented to prevent copies of the instance. + \par + * Not private to prevent brain dead g++ warnings about + * private constructors with no friends + */ ACLDestinationASNStrategy(ACLDestinationASNStrategy const &); private: Index: squid3/src/ACLDestinationDomain.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLDestinationDomain.h,v retrieving revision 1.8 retrieving revision 1.8.20.1 diff -u -r1.8 -r1.8.20.1 --- squid3/src/ACLDestinationDomain.h 9 May 2005 02:14:08 -0000 1.8 +++ squid3/src/ACLDestinationDomain.h 17 Aug 2007 04:00:57 -0000 1.8.20.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLDestinationDomain.h,v 1.8 2005/05/09 02:14:08 squidadm Exp $ + * $Id: ACLDestinationDomain.h,v 1.8.20.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,20 +34,26 @@ #ifndef SQUID_ACLSOURCEDOMAIN_H #define SQUID_ACLSOURCEDOMAIN_H + #include "ACL.h" #include "ACLData.h" #include "ACLChecklist.h" #include "ACLStrategised.h" +/// \ingroup ACLAPI class ACLDestinationDomainStrategy : public ACLStrategy { public: virtual int match (ACLData * &, ACLChecklist *); static ACLDestinationDomainStrategy *Instance(); - /* Not implemented to prevent copies of the instance. */ - /* Not private to prevent brain dead g+++ warnings about - * private constructors with no friends */ + + /** + * Not implemented to prevent copies of the instance. + \par + * Not private to prevent brain dead g+++ warnings about + * private constructors with no friends + */ ACLDestinationDomainStrategy(ACLDestinationDomainStrategy const &); private: @@ -58,6 +63,7 @@ ACLDestinationDomainStrategy&operator=(ACLDestinationDomainStrategy const &); }; +/// \ingroup ACLAPI class DestinationDomainLookup : public ACLChecklist::AsyncState { @@ -70,6 +76,7 @@ static void LookupDone(const char *, void *); }; +/// \ingroup ACLAPI class ACLDestinationDomain { Index: squid3/src/ACLDomainData.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLDomainData.h,v retrieving revision 1.6.20.1 retrieving revision 1.6.20.2 diff -u -r1.6.20.1 -r1.6.20.2 --- squid3/src/ACLDomainData.h 15 Aug 2007 02:48:03 -0000 1.6.20.1 +++ squid3/src/ACLDomainData.h 17 Aug 2007 04:00:57 -0000 1.6.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLDomainData.h,v 1.6.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLDomainData.h,v 1.6.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,10 +34,12 @@ #ifndef SQUID_ACLDOMAINDATA_H #define SQUID_ACLDOMAINDATA_H + #include "splay.h" #include "ACL.h" #include "ACLData.h" +/// \ingroup ACLAPI class ACLDomainData : public ACLData { Index: squid3/src/ACLExtUser.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLExtUser.h,v retrieving revision 1.5.20.1 retrieving revision 1.5.20.2 diff -u -r1.5.20.1 -r1.5.20.2 --- squid3/src/ACLExtUser.h 15 Aug 2007 02:48:03 -0000 1.5.20.1 +++ squid3/src/ACLExtUser.h 17 Aug 2007 04:00:57 -0000 1.5.20.2 @@ -1,5 +1,5 @@ /* - * $Id: ACLExtUser.h,v 1.5.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLExtUser.h,v 1.5.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -34,10 +34,12 @@ #ifndef SQUID_ACLIDENT_H #define SQUID_ACLIDENT_H + #include "ACL.h" #include "ACLChecklist.h" #include "ACLData.h" +/// \ingroup ACLAPI class ACLExtUser : public ACL { Index: squid3/src/ACLHTTPHeaderData.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLHTTPHeaderData.h,v retrieving revision 1.2.20.1 retrieving revision 1.2.20.2 diff -u -r1.2.20.1 -r1.2.20.2 --- squid3/src/ACLHTTPHeaderData.h 15 Aug 2007 02:48:03 -0000 1.2.20.1 +++ squid3/src/ACLHTTPHeaderData.h 17 Aug 2007 04:00:57 -0000 1.2.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLHTTPHeaderData.h,v 1.2.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLHTTPHeaderData.h,v 1.2.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,8 +34,10 @@ #ifndef SQUID_ACLHTTPHEADERDATA_H #define SQUID_ACLHTTPHEADERDATA_H + #include "ACLData.h" +/// \ingroup ACLAPI class ACLHTTPHeaderData : public ACLData { Index: squid3/src/ACLHTTPRepHeader.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLHTTPRepHeader.h,v retrieving revision 1.2 retrieving revision 1.2.20.1 diff -u -r1.2 -r1.2.20.1 --- squid3/src/ACLHTTPRepHeader.h 5 Aug 2006 12:51:07 -0000 1.2 +++ squid3/src/ACLHTTPRepHeader.h 17 Aug 2007 04:00:57 -0000 1.2.20.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLHTTPRepHeader.h,v 1.2 2006/08/05 12:51:07 squidadm Exp $ + * $Id: ACLHTTPRepHeader.h,v 1.2.20.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,10 +34,12 @@ #ifndef SQUID_ACLHTTPREPHEADER_H #define SQUID_ACLHTTPREPHEADER_H + #include "ACLStrategy.h" #include "ACLStrategised.h" #include "HttpHeader.h" +/// \ingroup ACLAPI class ACLHTTPRepHeaderStrategy : public ACLStrategy { @@ -47,9 +48,12 @@ virtual bool requiresReply() const { return true; } static ACLHTTPRepHeaderStrategy *Instance(); - /* Not implemented to prevent copies of the instance. */ - /* Not private to prevent brain dead g+++ warnings about - * private constructors with no friends */ + /** + * Not implemented to prevent copies of the instance. + \par + * Not private to prevent brain dead g+++ warnings about + * private constructors with no friends + */ ACLHTTPRepHeaderStrategy(ACLHTTPRepHeaderStrategy const &); private: @@ -59,6 +63,7 @@ ACLHTTPRepHeaderStrategy&operator = (ACLHTTPRepHeaderStrategy const &); }; +/// \ingroup ACLAPI class ACLHTTPRepHeader { Index: squid3/src/ACLHTTPReqHeader.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLHTTPReqHeader.h,v retrieving revision 1.2 retrieving revision 1.2.20.1 diff -u -r1.2 -r1.2.20.1 --- squid3/src/ACLHTTPReqHeader.h 5 Aug 2006 12:51:07 -0000 1.2 +++ squid3/src/ACLHTTPReqHeader.h 17 Aug 2007 04:00:57 -0000 1.2.20.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLHTTPReqHeader.h,v 1.2 2006/08/05 12:51:07 squidadm Exp $ + * $Id: ACLHTTPReqHeader.h,v 1.2.20.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,10 +34,12 @@ #ifndef SQUID_ACLHTTPREQHEADER_H #define SQUID_ACLHTTPREQHEADER_H + #include "ACLStrategy.h" #include "ACLStrategised.h" #include "HttpHeader.h" +/// \ingroup ACLAPI class ACLHTTPReqHeaderStrategy : public ACLStrategy { @@ -59,6 +60,7 @@ ACLHTTPReqHeaderStrategy&operator = (ACLHTTPReqHeaderStrategy const &); }; +/// \ingroup ACLAPI class ACLHTTPReqHeader { Index: squid3/src/ACLHTTPStatus.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLHTTPStatus.h,v retrieving revision 1.2.18.1 retrieving revision 1.2.18.2 diff -u -r1.2.18.1 -r1.2.18.2 --- squid3/src/ACLHTTPStatus.h 15 Aug 2007 02:48:03 -0000 1.2.18.1 +++ squid3/src/ACLHTTPStatus.h 17 Aug 2007 04:00:57 -0000 1.2.18.2 @@ -1,5 +1,5 @@ /* - * $Id: ACLHTTPStatus.h,v 1.2.18.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLHTTPStatus.h,v 1.2.18.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -34,10 +34,12 @@ #ifndef SQUID_ACLHTTPSTATUS_H #define SQUID_ACLHTTPSTATUS_H + #include "ACL.h" #include "ACLChecklist.h" #include "splay.h" +/// \ingroup ACLAPI struct acl_httpstatus_data { int status1, status2; @@ -48,6 +50,7 @@ static int compare(acl_httpstatus_data* const& a, acl_httpstatus_data* const& b); }; +/// \ingroup ACLAPI class ACLHTTPStatus : public ACL { Index: squid3/src/ACLIP.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLIP.h,v retrieving revision 1.8.20.1 retrieving revision 1.8.20.2 diff -u -r1.8.20.1 -r1.8.20.2 --- squid3/src/ACLIP.h 6 Aug 2007 05:18:23 -0000 1.8.20.1 +++ squid3/src/ACLIP.h 17 Aug 2007 04:00:57 -0000 1.8.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLIP.h,v 1.8.20.1 2007/08/06 05:18:23 amosjeffries Exp $ + * $Id: ACLIP.h,v 1.8.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,9 +34,11 @@ #ifndef SQUID_ACLIP_H #define SQUID_ACLIP_H + #include "ACL.h" #include "splay.h" +/// \ingroup ACLAPI class acl_ip_data { @@ -65,6 +66,7 @@ MEMPROXY_CLASS_INLINE(acl_ip_data) /**DOCS_NOSEMI*/ +/// \ingroup ACLAPI class ACLIP : public ACL { Index: squid3/src/ACLIdent.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLIdent.h,v retrieving revision 1.8.20.1 retrieving revision 1.8.20.2 diff -u -r1.8.20.1 -r1.8.20.2 --- squid3/src/ACLIdent.h 15 Aug 2007 02:48:03 -0000 1.8.20.1 +++ squid3/src/ACLIdent.h 17 Aug 2007 04:00:57 -0000 1.8.20.2 @@ -1,5 +1,5 @@ /* - * $Id: ACLIdent.h,v 1.8.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLIdent.h,v 1.8.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -34,10 +34,12 @@ #ifndef SQUID_ACLIDENT_H #define SQUID_ACLIDENT_H + #include "ACL.h" #include "ACLChecklist.h" #include "ACLData.h" +/// \ingroup ACLAPI class IdentLookup : public ACLChecklist::AsyncState { @@ -50,6 +52,7 @@ static void LookupDone(const char *ident, void *data); }; +/// \ingroup ACLAPI class ACLIdent : public ACL { Index: squid3/src/ACLIntRange.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLIntRange.h,v retrieving revision 1.4 retrieving revision 1.4.20.1 diff -u -r1.4 -r1.4.20.1 --- squid3/src/ACLIntRange.h 9 May 2005 02:14:08 -0000 1.4 +++ squid3/src/ACLIntRange.h 17 Aug 2007 04:00:57 -0000 1.4.20.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLIntRange.h,v 1.4 2005/05/09 02:14:08 squidadm Exp $ + * $Id: ACLIntRange.h,v 1.4.20.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,10 +34,12 @@ #ifndef SQUID_ACLINTRANGE_H #define SQUID_ACLINTRANGE_H + #include "ACLData.h" #include "List.h" #include "Range.h" +/// \ingroup ACLAPI class ACLIntRange : public ACLData { Index: squid3/src/ACLMaxConnection.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLMaxConnection.h,v retrieving revision 1.4.20.1 retrieving revision 1.4.20.2 diff -u -r1.4.20.1 -r1.4.20.2 --- squid3/src/ACLMaxConnection.h 15 Aug 2007 02:48:03 -0000 1.4.20.1 +++ squid3/src/ACLMaxConnection.h 17 Aug 2007 04:00:57 -0000 1.4.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLMaxConnection.h,v 1.4.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLMaxConnection.h,v 1.4.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,9 +34,11 @@ #ifndef SQUID_ACLMAXCONNECTION_H #define SQUID_ACLMAXCONNECTION_H + #include "ACL.h" #include "ACLChecklist.h" +/// \ingroup ACLAPI class ACLMaxConnection : public ACL { Index: squid3/src/ACLMaxUserIP.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLMaxUserIP.h,v retrieving revision 1.9.2.1 retrieving revision 1.9.2.2 diff -u -r1.9.2.1 -r1.9.2.2 --- squid3/src/ACLMaxUserIP.h 15 Aug 2007 02:48:03 -0000 1.9.2.1 +++ squid3/src/ACLMaxUserIP.h 17 Aug 2007 04:00:57 -0000 1.9.2.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLMaxUserIP.h,v 1.9.2.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLMaxUserIP.h,v 1.9.2.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,9 +34,11 @@ #ifndef SQUID_ACLMAXUSERIP_H #define SQUID_ACLMAXUSERIP_H + #include "ACL.h" #include "ACLChecklist.h" +/// \ingroup ACLAPI class ACLMaxUserIP : public ACL { Index: squid3/src/ACLMethod.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLMethod.h,v retrieving revision 1.1 retrieving revision 1.1.32.1 diff -u -r1.1 -r1.1.32.1 --- squid3/src/ACLMethod.h 26 Feb 2003 03:15:29 -0000 1.1 +++ squid3/src/ACLMethod.h 17 Aug 2007 04:00:57 -0000 1.1.32.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLMethod.h,v 1.1 2003/02/26 03:15:29 squidadm Exp $ + * $Id: ACLMethod.h,v 1.1.32.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,9 +34,11 @@ #ifndef SQUID_ACLMETHOD_H #define SQUID_ACLMETHOD_H + #include "ACLStrategy.h" #include "ACLStrategised.h" +/// \ingroup ACLAPI class ACLMethodStrategy : public ACLStrategy { @@ -46,9 +47,12 @@ virtual bool requiresRequest() const {return true;} static ACLMethodStrategy *Instance(); - /* Not implemented to prevent copies of the instance. */ - /* Not private to prevent brain dead g+++ warnings about - * private constructors with no friends */ + /** + * Not implemented to prevent copies of the instance. + \par + * Not private to prevent brain dead g+++ warnings about + * private constructors with no friends + */ ACLMethodStrategy(ACLMethodStrategy const &); private: @@ -58,6 +62,7 @@ ACLMethodStrategy&operator=(ACLMethodStrategy const &); }; +/// \ingroup ACLAPI class ACLMethod { Index: squid3/src/ACLMethodData.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLMethodData.h,v retrieving revision 1.4.20.1 retrieving revision 1.4.20.2 diff -u -r1.4.20.1 -r1.4.20.2 --- squid3/src/ACLMethodData.h 15 Aug 2007 02:48:03 -0000 1.4.20.1 +++ squid3/src/ACLMethodData.h 17 Aug 2007 04:00:57 -0000 1.4.20.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLMethodData.h,v 1.4.20.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLMethodData.h,v 1.4.20.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,10 +34,12 @@ #ifndef SQUID_ACLMETHODDATA_H #define SQUID_ACLMETHODDATA_H + #include "ACL.h" #include "ACLData.h" #include "List.h" +/// \ingroup ACLAPI class ACLMethodData : public ACLData { Index: squid3/src/ACLMyIP.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLMyIP.h,v retrieving revision 1.5.26.1 retrieving revision 1.5.26.2 diff -u -r1.5.26.1 -r1.5.26.2 --- squid3/src/ACLMyIP.h 15 Aug 2007 02:48:03 -0000 1.5.26.1 +++ squid3/src/ACLMyIP.h 17 Aug 2007 04:00:57 -0000 1.5.26.2 @@ -1,6 +1,5 @@ - /* - * $Id: ACLMyIP.h,v 1.5.26.1 2007/08/15 02:48:03 amosjeffries Exp $ + * $Id: ACLMyIP.h,v 1.5.26.2 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,8 +34,10 @@ #ifndef SQUID_ACLMYIP_H #define SQUID_ACLMYIP_H + #include "ACLIP.h" +/// \ingroup ACLAPI class ACLMyIP : public ACLIP { Index: squid3/src/ACLMyPort.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/ACLMyPort.h,v retrieving revision 1.1 retrieving revision 1.1.32.1 diff -u -r1.1 -r1.1.32.1 --- squid3/src/ACLMyPort.h 26 Feb 2003 03:15:32 -0000 1.1 +++ squid3/src/ACLMyPort.h 17 Aug 2007 04:00:57 -0000 1.1.32.1 @@ -1,6 +1,5 @@ - /* - * $Id: ACLMyPort.h,v 1.1 2003/02/26 03:15:32 squidadm Exp $ + * $Id: ACLMyPort.h,v 1.1.32.1 2007/08/17 04:00:57 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -35,18 +34,23 @@ #ifndef SQUID_ACLMYPORT_H #define SQUID_ACLMYPORT_H + #include "ACLStrategy.h" #include "ACLStrategised.h" +/// \ingroup ACLAPI class ACLMyPortStrategy : public ACLStrategy { public: virtual int match (ACLData * &, ACLChecklist *); static ACLMyPortStrategy *Instance(); - /* Not implemented to prevent copies of the instance. */ - /* Not private to prevent brain dead g+++ warnings about - * private constructors with no friends */ + /** + * Not implemented to prevent copies of the instance. + \par + * Not private to prevent brain dead g+++ warnings about + * private constructors with no friends + */ ACLMyPortStrategy(ACLMyPortStrategy const &); private: @@ -56,6 +60,7 @@ ACLMyPortStrategy&operator=(ACLMyPortStrategy const &); }; +/// \ingroup ACLAPI class ACLMyPort {