* Update some code syntax for doxygen's naive parser.
* Fix duplicate section IDs in doxygen comments.
* Fix some doxygen markup typos.
* Remove an unnecessary todo.
No logical changes.
/**
\page 10_DelayPools Delay Pools
-\section Introduction Introduction
+\section DelayPoolsIntro Introduction
\par
A DelayPool is a Composite used to manage bandwidth for any request
assigned to the pool by an access expression. DelayId's are a used
#define RFC1738_ESCAPE_UNESCAPED (RFC1738_ESCAPE_UNSAFE|RFC1738_ESCAPE_CTRLS|RFC1738_ESCAPE_NOPERCENT)
/**
- * \group rfc1738 RFC 1738 URL-escaping library
+ * RFC 1738 URL-escaping
*
* Public API is formed of a triplet of encode functions mapping to the rfc1738_do_encode() engine.
*
* ASCII characters are split into four groups:
- * \item SAFE Characters which are safe to occur in any URL. For example A,B,C
- * \item CTRLS Binary control codes. Dangerous to include in URLs.
- * \item UNSAFE Characters which are completely usafe to occur in any URL. For example; backspace, tab, space, newline.
- * \item RESERVED Characters which are reserved for special meaning and may only occur in certain parts of a URL.
+ * \li SAFE Characters which are safe to occur in any URL. For example A,B,C
+ * \li CTRLS Binary control codes. Dangerous to include in URLs.
+ * \li UNSAFE Characters which are completely usafe to occur in any URL. For example; backspace, tab, space, newline.
+ * \li RESERVED Characters which are reserved for special meaning and may only occur in certain parts of a URL.
*
* Returns a static buffer containing the RFC 1738 compliant, escaped version of the given url.
*
if (pad_api_name == TRUE) /* Pad to a word boundary */
p = p + 1;
- /* SSVAL(p, 0, 65000); /* Check the result */
+ /* SSVAL(p, 0, 65000); */ /* Check the result */
SSVAL(p, 0, SMB_LMapi_SetUserInfo); /* The api call */
p = p + 2;
/**
\defgroup FileSystems Storage Filesystems
*
- \section Introduction Introduction
+ \section FileSystemsIntroduction Introduction
\par
* Traditionally, Squid has always used the Unix filesystem (\link UFS UFS\endlink)
* to store cache objects on disk. Over the years, the
\defgroup AsyncJobs Asynchronous Jobs
\ingroup Components
-\section Terminology Terminology
+\section AsyncJobsTerminology Terminology
- \b Job: an AsyncJob object.
- \b Creator: the code creating the job. Usually the Initiator.
- \b Start: the act of calling AsyncJob::Start with a job pointer.
- \b Initiator: the code starting the job. Usually the Creator.
-\section Life Typical life cycle
+\section AsyncJobsLifecycle Typical life cycle
-# Creator creates and initializes a job.
-# If Initiator expects to communicate with the job after start,
you call AsyncJob::Start with a job pointer.
-\section Rules Basic rules
+\section AsyncJobsBasicRules Basic rules
- To start a job, use AsyncJob::Start.
Do not start the same job more than once.
/**
\page CBDATA Callback Data Allocator API
- \section Introduction
+ \section CbDataIntro Introduction
\par
Squid's extensive use of callback functions makes it very
/**
\defgroup ClientStreamAPI Client Streams API
\ingroup Components
- \section Introduction Introduction
+ \section ClientStreamIntroduction Introduction
\par
* A ClientStream implements a unidirectional, non-blocking,
* pull pipeline. They allow code to be inserted into the
/// abnormal data transfer termination
/// \retval true the transaction will be terminated (abortAll called)
- /// \reval false the transaction will survive
+ /// \retval false the transaction will survive
virtual bool abortOnData(const char *reason);
/// a hack to reach HttpStateData::orignal_request
\defgroup ErrorPageInternal Error Page Internals
\ingroup ErrorPageAPI
*
- \section Abstract Abstract:
+ \section ErrorPagesAbstract Abstract:
* These routines are used to generate error messages to be
* sent to clients. The error type is used to select between
* the various message formats. (formats are stored in the
/**
\defgroup FQDNCacheAPI FQDN Cache API
\ingroup Components
- \section Introduction Introduction
+ \section FQDNCacheIntroduction Introduction
\par
* The FQDN cache is a built-in component of squid providing
* Hostname to IP-Number translation functionality and managing
* mechanisms that allow non-blocking access to these mappings.
* The FQDN cache usually doesn't block on a request except for
* special cases where this is desired (see below).
- *
- \todo FQDN Cache should have its own API *.h file.
*/
/**
\defgroup RockFsRebuild Rock Store Rebuild
\ingroup Filesystems
*
- \section Overview Overview
+ \section RockFsRebuildOverview Overview
* Several layers of information are manipualted during the rebuild:
\par
* Store Entry: Response message plus all the metainformation associated with
* Works on a raw character I/O buffer and tokenizes the content into
* the major CRLF delimited segments of an HTTP/1 procotol message:
*
- * \item first-line (request-line / simple-request / status-line)
- * \item mime-header 0*( header-name ':' SP field-value CRLF)
+ * \li first-line (request-line / simple-request / status-line)
+ * \li mime-header 0*( header-name ':' SP field-value CRLF)
*/
class Parser : public RefCountable
{
* Works on a raw character I/O buffer and tokenizes the content into
* the major CRLF delimited segments of an HTTP/1 request message:
*
- * \item request-line (method, URL, protocol, version)
- * \item mime-header (set of RFC2616 syntax header fields)
+ * \li request-line (method, URL, protocol, version)
+ * \li mime-header (set of RFC2616 syntax header fields)
*/
class RequestParser : public Http1::Parser
{
* Works on a raw character I/O buffer and tokenizes the content into
* the major CRLF delimited segments of an HTTP/1 respone message:
*
- * \item status-line (version SP status SP reash-phrase)
- * \item mime-header (set of RFC2616 syntax header fields)
+ * \li status-line (version SP status SP reash-phrase)
+ * \li mime-header (set of RFC2616 syntax header fields)
*/
class ResponseParser : public Http1::Parser
{
/**
\defgroup IPCacheAPI IP Cache API
\ingroup Components
- \section Introduction Introduction
+ \section IpcacheIntroduction Introduction
\par
* The IP cache is a built-in component of squid providing
* Hostname to IP-Number translation functionality and managing
typedef CbDataList<Security::CertError> CertErrors;
#if USE_OPENSSL
-CtoCpp1(X509_free, X509 *)
+CtoCpp1(X509_free, X509 *);
typedef Security::LockingPointer<X509, X509_free_cpp, HardFun<int, X509 *, X509_up_ref> > CertPointer;
#elif USE_GNUTLS
typedef std::shared_ptr<struct gnutls_x509_crt_int> CertPointer;
#endif
#if USE_OPENSSL
-CtoCpp1(X509_CRL_free, X509_CRL *)
+CtoCpp1(X509_CRL_free, X509_CRL *);
typedef Security::LockingPointer<X509_CRL, X509_CRL_free_cpp, HardFun<int, X509_CRL *, X509_CRL_up_ref> > CrlPointer;
#elif USE_GNUTLS
-CtoCpp1(gnutls_x509_crl_deinit, gnutls_x509_crl_t)
+CtoCpp1(gnutls_x509_crl_deinit, gnutls_x509_crl_t);
typedef Security::LockingPointer<struct gnutls_x509_crl_int, gnutls_x509_crl_deinit> CrlPointer;
#else
typedef void *CrlPointer;
* Retrieve error details for an error. This method examine the Accept-Language
* of the request to retrieve the error details for requested language else return
* the default error details.
- * \param vale the error code
+ * \param value the error code
* \param request the current HTTP request.
* \param entry where to store error details
* \return true on success, false otherwise
/**
* This class is responsible for composing or parsing messages destined to
- * or comming from a cert validator helper.
+ * or comming from a certificate validation helper.
* The messages format is:
- * response/request-code SP body-length SP [key=value ...] \x01
+\verbatim
+ response/request-code SP body-length SP [key=value ...] EOL
+\endverbatim
+ * \note EOL for this interface is character 0x01
*/
class CertValidationMsg : public CrtdMessage
{
projects / thirdparty / squid.git / commitdiff
