httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s.@apache.org
Subject svn commit: r1044680 - in /httpd/httpd/trunk/include: ap_expr.h http_log.h
Date Sat, 11 Dec 2010 17:18:35 GMT
Author: sf
Date: Sat Dec 11 17:18:35 2010
New Revision: 1044680

URL: http://svn.apache.org/viewvc?rev=1044680&view=rev
Log:
doxygen improvements

Modified:
    httpd/httpd/trunk/include/ap_expr.h
    httpd/httpd/trunk/include/http_log.h

Modified: httpd/httpd/trunk/include/ap_expr.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/ap_expr.h?rev=1044680&r1=1044679&r2=1044680&view=diff
==============================================================================
--- httpd/httpd/trunk/include/ap_expr.h (original)
+++ httpd/httpd/trunk/include/ap_expr.h Sat Dec 11 17:18:35 2010
@@ -69,7 +69,7 @@ typedef struct {
  * @return > 0 if expression evaluates to true, == 0 if false, < 0 on error
  * @note err will be set to NULL on success, or to an error message on error
  * @note request headers used during evaluation will be added to the Vary:
- *       response header, unless AP_EXPR_FLAGS_DONT_VARY is set.
+ *       response header, unless ::AP_EXPR_FLAGS_DONT_VARY is set.
  */
 AP_DECLARE(int) ap_expr_exec(request_rec *r, const ap_expr_info_t *expr,
                              const char **err);
@@ -88,7 +88,7 @@ AP_DECLARE(int) ap_expr_exec(request_rec
  *       available to ap_expr_exec_re and to use ap_expr_exec_re's matches
  *       later on.
  * @note request headers used during evaluation will be added to the Vary:
- *       response header, unless AP_EXPR_FLAGS_DONT_VARY is set.
+ *       response header, unless ::AP_EXPR_FLAGS_DONT_VARY is set.
  */
 AP_DECLARE(int) ap_expr_exec_re(request_rec *r, const ap_expr_info_t *expr,
                                 apr_size_t nmatch, ap_regmatch_t *pmatch,
@@ -131,8 +131,8 @@ typedef struct {
  * If the argument to a function or operator is constant, the lookup function
  * may also parse that argument and store the parsed data in the context.
  *
- * The default lookup function is the hook 'ap_expr_lookup_default' which just
- * calls ap_expr_lookup_default. Modules can use it to make functions and
+ * The default lookup function is the hook ::ap_expr_lookup_default which just
+ * calls ap_run_expr_lookup. Modules can use it to make functions and
  * variables generally available.
  *
  * An ap_expr consumer can also provide its own custom lookup function to

Modified: httpd/httpd/trunk/include/http_log.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/http_log.h?rev=1044680&r1=1044679&r2=1044680&view=diff
==============================================================================
--- httpd/httpd/trunk/include/http_log.h (original)
+++ httpd/httpd/trunk/include/http_log.h Sat Dec 11 17:18:35 2010
@@ -88,7 +88,7 @@ extern "C" {
  */
 #define APLOG_NOERRNO		(APLOG_LEVELMASK + 1)
 
-/* Use APLOG_TOCLIENT on ap_log_rerror() to give content
+/** Use APLOG_TOCLIENT on ap_log_rerror() to give content
  * handlers the option of including the error text in the 
  * ErrorDocument sent back to the client. Setting APLOG_TOCLIENT
  * will cause the error text to be saved in the request_rec->notes 
@@ -112,7 +112,8 @@ extern "C" {
 /**
  * APLOG_NO_MODULE may be passed as module_index to ap_log_error() and related
  * functions if the module causing the log message is not known. Normally this
- * should not be used directly. Use APLOG_MARK or APLOG_MODULE_INDEX instead.
+ * should not be used directly. Use ::APLOG_MARK or ::APLOG_MODULE_INDEX
+ * instead.
  *
  * @see APLOG_MARK
  * @see APLOG_MODULE_INDEX
@@ -120,25 +121,26 @@ extern "C" {
  */
 #define APLOG_NO_MODULE         -1
 
-/*
+/**
+ * Constant to store module_index for the current file.
  * Objects with static storage duration are set to NULL if not
- * initialized explicitly. This means if aplog_module_index
- * is not initalized using the APLOG_USE_MODULE or the
- * AP_DECLARE_MODULE macro, we can safely fall back to
- * use APLOG_NO_MODULE. This variable will usually be optimized away.
+ * initialized explicitly. This means that if aplog_module_index
+ * is not initalized using the ::APLOG_USE_MODULE or the
+ * ::AP_DECLARE_MODULE macro, we can safely fall back to
+ * use ::APLOG_NO_MODULE. This variable will usually be optimized away.
  */
 static int * const aplog_module_index;
 
 /**
  * APLOG_MODULE_INDEX contains the module_index of the current module if
- * it has been set via the APLOG_USE_MODULE or AP_DECLARE_MODULE macro.
- * Otherwise it contains APLOG_NO_MODULE (for example in unmodified httpd 2.2
- * modules).
+ * it has been set via the ::APLOG_USE_MODULE or ::AP_DECLARE_MODULE macro.
+ * Otherwise it contains ::APLOG_NO_MODULE (for example in unmodified httpd
+ * 2.2 modules).
  *
- * If APLOG_MARK is used in ap_log_error() and related functions,
- * APLOG_MODULE_INDEX will be passed as module_index. In cases where
- * APLOG_MARK cannot be used, APLOG_MODULE_INDEX should normally be passed as
- * module_index.
+ * If ::APLOG_MARK is used in ap_log_error() and related functions,
+ * ::APLOG_MODULE_INDEX will be passed as module_index. In cases where
+ * ::APLOG_MARK cannot be used, ::APLOG_MODULE_INDEX should normally be passed
+ * as module_index.
  *
  * @see APLOG_MARK
  * @see ap_log_error
@@ -152,6 +154,9 @@ static int * const aplog_module_index;
  *
  * This requires a C99 compiler.
  */
+#ifdef DOXYGEN
+#define APLOG_MAX_LOGLEVEL
+#endif
 #ifndef APLOG_MAX_LOGLEVEL
 #define APLOG_MODULE_IS_LEVEL(s,module_index,level)              \
           ( (((level)&APLOG_LEVELMASK) <= APLOG_NOTICE) ||       \



Mime
View raw message