Skip to content

Commit 251a1b1

Browse files
krytonkryton
committed
Doxygen fixup / cleanup
submited by: Neale Ranns neale ranns.org reviewed by: Ian Holsman git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@263931 13f79535-47bb-0310-9956-ffa450edef68
1 parent 52c3d38 commit 251a1b1

106 files changed

Lines changed: 1358 additions & 528 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Changes with Apache 2.3.0
33
[Remove entries to the current 2.0 and 2.2 section below, when backported]
44

5+
*) Doxygen fixup [Neale Ranns neale ranns.org, Ian Holsman]
6+
57
*) prefork and worker MPMs: Support a graceful-stop procedure:
68
Server will wait until existing requests are finished or until
79
"GracefulShutdownTimeout" number of seconds before exiting.

‎docs/doxygen.conf‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1-
PROJECT_NAME=Apache
1+
PROJECT_NAME=Apache2
22

3-
#INPUT=srclib/apr
3+
# make the generated documentation searchable
4+
SEARCHENGINE=YES
45
INPUT=.
56
RECURSIVE=YES
67
FILE_PATTERNS=*.h
78

89
OUTPUT_DIRECTORY=docs/dox
910

11+
#EXTRACT_STATIC=YES
12+
EXTRACT_ALL=YES
13+
14+
# add documentation for functions that are declared internal use only
15+
INTERNAL_DOCS=YES
16+
1017
ENABLE_PREPROCESSING=YES
1118
MACRO_EXPANSION=YES
1219
QUIET=YES
@@ -16,8 +23,11 @@ EXPAND_ONLY_PREDEF=YES
1623
PREDEFINED="APR_DECLARE(x)=x" \
1724
"APR_DECLARE_NONSTD(x)=x" \
1825
"AP_DECLARE_HOOK(ret,name,args)=ret name args;" \
26+
"APR_DECLARE_OPTIONAL_FN(ret,name,args)=ret name args;" \
1927
"AP_DECLARE(x)=x" \
2028
"AP_DECLARE_NONSTD(x)=x" \
29+
AP_CORE_DECLARE(x)=x \
30+
"AP_CORE_DECLARE_NONSTD(x)=x" \
2131
"APR_HAS_THREADS" \
2232
"APR_HAS_MMAP" \
2333
APR_HAS_INLINE \
@@ -49,4 +59,7 @@ OPTIMIZE_OUTPUT_FOR_C=YES
4959

5060
FULL_PATH_NAMES=YES
5161
# some autoconf guru needs to make configure set this correctly...
52-
STRIP_FROM_PATH=/var/www/lxr/source
62+
#STRIP_FROM_PATH=/var/www/lxr/source
63+
64+
#GENERATE_TAGFILE=docs/dox/httpd.tag
65+
#TAGFILES=../apr/docs/dox/apr.tag=/apr ../apr-util/docs/dox/apu.tag=/apr-util

‎include/ap_compat.h‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* @file ap_compat.h
19+
* @brief Redefine Apache 1.3 symbols
20+
*/
21+
1722
#ifndef AP_COMPAT_H
1823
#define AP_COMPAT_H
1924

‎include/ap_config.h‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,23 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* @file ap_config.h
19+
* @brief Symbol export macros and hook functions
20+
*/
21+
1722
#ifndef AP_CONFIG_H
1823
#define AP_CONFIG_H
1924

2025
#include "apr.h"
2126
#include "apr_hooks.h"
2227
#include "apr_optional_hooks.h"
2328

24-
/**
25-
* @file ap_config.h
26-
* @brief Symbol export macros and hook functions
27-
*/
28-
2929
/* Although this file doesn't declare any hooks, declare the hook group here */
30-
/** @defgroup hooks Apache Hooks */
30+
/**
31+
* @defgroup hooks Apache Hooks
32+
* @ingroup APACHE_CORE
33+
*/
3134

3235
#ifdef DOXYGEN
3336
/* define these just so doxygen documents them */

‎include/ap_config_layout.h.in‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* @file ap_config_layout.h
19+
* @brief Apache Config Layout
20+
*/
21+
1722
#ifndef AP_CONFIG_LAYOUT_H
1823
#define AP_CONFIG_LAYOUT_H
1924

‎include/ap_listen.h‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,29 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* @file ap_listen.h
19+
* @brief Apache Listeners Library
20+
*
21+
* @defgroup APACHE_CORE_LISTEN Apache Listeners Library
22+
* @ingroup APACHE_CORE
23+
* @{
24+
*/
25+
1726
#ifndef AP_LISTEN_H
1827
#define AP_LISTEN_H
1928

2029
#include "apr_network_io.h"
2130
#include "httpd.h"
2231
#include "http_config.h"
2332

24-
/**
25-
* @package Apache Listeners Library
26-
*/
27-
2833
typedef struct ap_listen_rec ap_listen_rec;
2934
typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
3035

3136
/**
32-
* Apache's listeners record. These are used in the Multi-Processing Modules
37+
* @brief Apache's listeners record.
38+
*
39+
* These are used in the Multi-Processing Modules
3340
* to setup all of the sockets for the MPM to listen to and accept on.
3441
*/
3542
struct ap_listen_rec {
@@ -109,3 +116,4 @@ AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
109116
RSRC_CONF, "Receive buffer size in bytes")
110117

111118
#endif
119+
/** @} */

‎include/ap_mmn.h‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,18 @@
1414
* limitations under the License.
1515
*/
1616

17-
#ifndef APACHE_AP_MMN_H
18-
#define APACHE_AP_MMN_H
19-
2017
/**
21-
* @package Module Magic Number
18+
* @file ap_mpm.h
19+
* @brief Module Magic Number
20+
*
21+
* @defgroup APACHE_CORE_MMN Module Magic Number
22+
* @ingroup APACHE_CORE
23+
* @{
2224
*/
2325

26+
#ifndef APACHE_AP_MMN_H
27+
#define APACHE_AP_MMN_H
28+
2429
/*
2530
* MODULE_MAGIC_NUMBER_MAJOR
2631
* Major API changes that could cause compatibility problems for older modules
@@ -137,3 +142,4 @@
137142
#define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
138143

139144
#endif /* !APACHE_AP_MMN_H */
145+
/** @} */

‎include/ap_mpm.h‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,20 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* @file ap_mmn.h
19+
* @brief Apache Multi-Processing Module library
20+
*
21+
* @defgroup APACHE_CORE_MPM Multi-Processing Module library
22+
* @ingroup APACHE_CORE
23+
* @{
24+
*/
25+
1726
#ifndef AP_MPM_H
1827
#define AP_MPM_H
1928

2029
#include "apr_thread_proc.h"
2130

22-
/**
23-
* @package Multi-Processing Module library
24-
*/
25-
2631
/*
2732
The MPM, "multi-processing model" provides an abstraction of the
2833
interface with the OS for distributing incoming connections to
@@ -175,3 +180,4 @@ AP_DECLARE_HOOK(int,fatal_exception,(ap_exception_info_t *ei))
175180
#endif /*AP_ENABLE_EXCEPTION_HOOK*/
176181

177182
#endif
183+
/** @} */

‎include/ap_provider.h‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,20 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* @file ap_provider.h
19+
* @brief Apache Provider API
20+
*
21+
* @defgroup APACHE_CORE_PROVIDER Provider API
22+
* @ingroup APACHE_CORE
23+
* @{
24+
*/
25+
1726
#ifndef AP_PROVIDER_H
1827
#define AP_PROVIDER_H
1928

2029
#include "ap_config.h"
2130

22-
/**
23-
* @package Provider API
24-
*/
25-
2631
/**
2732
* This function is used to register a provider with the global
2833
* provider pool.
@@ -52,3 +57,4 @@ AP_DECLARE(void *) ap_lookup_provider(const char *provider_group,
5257
const char *provider_version);
5358

5459
#endif
60+
/** @} */

‎include/ap_regex.h‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ POSSIBILITY OF SUCH DAMAGE.
4747
-----------------------------------------------------------------------------
4848
*/
4949

50+
/**
51+
* @file ap_regex.h
52+
* @brief Apache Regex defines
53+
*/
54+
5055
#ifndef AP_REGEX_H
5156
#define AP_REGEX_H
5257

0 commit comments

Comments
 (0)