Check in not-quite-working hooks groupings.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@88513 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/doxygen.conf b/docs/doxygen.conf
index cf3da69b287bafc6b0635ffb54f7936351d92ef2..f214f1c99f71b9a24e33eee4a7297c306b941309 100644 (file)
--- a/docs/doxygen.conf
+++ b/docs/doxygen.conf
@@ -10,7 +10,8 @@ MACRO_EXPANSION=YES
 EXPAND_ONLY_PREDEF=YES
 EXPAND_AS_DEFINED=AP_DECLARE
 # not sure why this doesn't work as EXPAND_AS_DEFINED, it should!
-PREDEFINED=APR_DECLARE(x)=x APR_DECLARE_NONSTD(x)=x
+PREDEFINED=APR_DECLARE(x)=x APR_DECLARE_NONSTD(x)=x \
+       AP_DECLARE_HOOK(ret,name,args)="ret name args"
 
 OPTIMIZE_OUTPUT_FOR_C=YES
 

diff --git a/include/ap_config.h b/include/ap_config.h
index 82e5fd1226f8b09dc52f403d26ed2bffb83a8ae1..0db62e09ab8d657c3ec2b2fa84a783868172d708 100644 (file)
--- a/include/ap_config.h
+++ b/include/ap_config.h
@@ -59,9 +59,13 @@
 #include "apr_hooks.h"
 
 /**
- * @package Symbol Export Macros
+ * @file ap_config.h
+ * @brief Symbol Export Macros
  */
 
+/* Although this file doesn't declare any hooks, declare the hook group here */
+/** @defgroup hooks Apache Hooks */
+
 /**
  * AP_DECLARE_EXPORT is defined when building the Apache Core dynamic
  * library, so that all public symbols are exported.

diff --git a/include/http_request.h b/include/http_request.h
index 6e9fb642f09e4a6ad0de760d8be9769b037eb0ef..5d2112b1e2e45e87d9e8d9b66a7d11468a480873 100644 (file)
--- a/include/http_request.h
+++ b/include/http_request.h
@@ -67,7 +67,8 @@ extern "C" {
 #endif
 
 /**
- * @package Apache Request library
+ * @file http_request.h
+ * @brief Apache Request library
  */
 
 /* http_request.c is the code which handles the main line of request
@@ -240,14 +241,19 @@ void ap_process_request(request_rec *);
 AP_DECLARE(void) ap_die(int type, request_rec *r);
 #endif
 
-  /* Hooks */
+/* Hooks */
+
+/* XXX: doxygen grouping doesn't appear to work, but it should. Checking with
+ * doxygen (Ben).
+ */
+
 /**
  * This hook allow modules an opportunity to translate the URI into an
  * actual filename.  If no modules do anything special, the server's default
  * rules will be followed.
  * @param r The current request
  * @return OK, DECLINED, or HTTP_...
- * @deffunc int ap_run_translate_name(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(int,translate_name,(request_rec *r))
 
@@ -256,7 +262,7 @@ AP_DECLARE_HOOK(int,translate_name,(request_rec *r))
  * the request.
  * @param r The current request
  * @return OK, DECLINED, or HTTP_...
- * @deffunc int ap_run_check_user_id(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
 
@@ -265,7 +271,7 @@ AP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
  * is invoked just before any content-handler
  * @param r The current request
  * @return OK, DECLINED, or HTTP_...
- * @deffunc int ap_run_fixups(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(int,fixups,(request_rec *r))
  
@@ -275,7 +281,7 @@ AP_DECLARE_HOOK(int,fixups,(request_rec *r))
  * cetera.
  * @param r the current request
  * @return OK, DECLINED, or HTTP_...
- * @deffunc int ap_run_type_checker(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(int,type_checker,(request_rec *r))
 
@@ -284,7 +290,7 @@ AP_DECLARE_HOOK(int,type_checker,(request_rec *r))
  * upon the requested resource.
  * @param r the current request
  * @return OK, DECLINED, or HTTP_...
- * @deffunc int ap_run_access_checker(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(int,access_checker,(request_rec *r))
 
@@ -293,14 +299,14 @@ AP_DECLARE_HOOK(int,access_checker,(request_rec *r))
  * requires authorisation.
  * @param r the current request
  * @return OK, DECLINED, or HTTP_...
- * @deffunc int ap_run_auth_checker(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(int,auth_checker,(request_rec *r))
 
 /**
  * This hook allows modules to insert filters for the current request
  * @param r the current request
- * @deffunc void ap_run_insert_filter(request_rec *r)
+ * @ingroup hooks
  */
 AP_DECLARE_HOOK(void,insert_filter,(request_rec *r))