ben 01/06/17 07:34:15
Modified: docs doxygen.conf
include ap_config.h
include apr_hooks.h apr_optional_hooks.h apr_sha1.h
Log:
Documentation updates.
Revision Changes Path
1.6 +1 -1 httpd-2.0/docs/doxygen.conf
Index: doxygen.conf
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/doxygen.conf,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- doxygen.conf 2001/05/28 15:32:50 1.5
+++ doxygen.conf 2001/06/17 14:34:14 1.6
@@ -12,7 +12,7 @@
# not sure why this doesn't work as EXPAND_AS_DEFINED, it should!
PREDEFINED=APR_DECLARE(x)=x APR_DECLARE_NONSTD(x)=x \
AP_DECLARE_HOOK(ret,name,args)="ret name args" AP_DECLARE(x)=x \
- AP_DECLARE_NONSTD(x)=x DOXYGEN
+ AP_DECLARE_NONSTD(x)=x DOXYGEN APU_DECLARE_DATA APU_DECLARE(x)=x
OPTIMIZE_OUTPUT_FOR_C=YES
1.64 +37 -23 httpd-2.0/include/ap_config.h
Index: ap_config.h
===================================================================
RCS file: /home/cvs/httpd-2.0/include/ap_config.h,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -r1.63 -r1.64
--- ap_config.h 2001/06/09 11:33:07 1.63
+++ ap_config.h 2001/06/17 14:34:14 1.64
@@ -61,42 +61,55 @@
/**
* @file ap_config.h
- * @brief Symbol Export Macros
+ * @brief Symbol export macros and hook functions
*/
/* Although this file doesn't declare any hooks, declare the hook group here
*/
/** @defgroup hooks Apache Hooks */
+#ifdef DOXYGEN
+/* define these just so doxygen documents them */
+
/**
- * AP_DECLARE_EXPORT is defined when building the Apache Core dynamic
- * library, so that all public symbols are exported.
- *
* AP_DECLARE_STATIC is defined when including Apache's Core headers,
* to provide static linkage when the dynamic library may be unavailable.
*
+ * @see AP_DECLARE_EXPORT
+ *
* AP_DECLARE_STATIC and AP_DECLARE_EXPORT are left undefined when
* including Apache's Core headers, to import and link the symbols from the
* dynamic Apache Core library and assure appropriate indirection and
calling
* conventions at compile time.
+ */
+# define AP_DECLARE_STATIC
+/**
+ * AP_DECLARE_EXPORT is defined when building the Apache Core dynamic
+ * library, so that all public symbols are exported.
*
- * @deffunc AP_DECLARE_EXPORT/AP_DECLARE_STATIC
+ * @see AP_DECLARE_STATIC
*/
+# define AP_DECLARE_EXPORT
+
+#endif /* def DOXYGEN */
#if !defined(WIN32)
/**
* Apache Core dso functions are declared with AP_DECLARE(), so they may
* use the most appropriate calling convention. Hook functions and other
* Core functions with variable arguments must use AP_DECLARE_NONSTD().
- *
- * @deffunc AP_DECLARE(rettype) ap_func(args)
+ * @code
+ * AP_DECLARE(rettype) ap_func(args)
+ * @endcode
*/
#define AP_DECLARE(type) type
/**
* Apache Core dso variable argument and hook functions are declared with
* AP_DECLARE_NONSTD(), as they must use the C language calling convention.
- *
- * @deffunc AP_DECLARE_NONSTD(rettype) ap_func(args [...])
+ * @see AP_DECLARE
+ * @code
+ * AP_DECLARE_NONSTD(rettype) ap_func(args [...])
+ * @endcode
*/
#define AP_DECLARE_NONSTD(type) type
@@ -104,9 +117,11 @@
* Apache Core dso variables are declared with AP_MODULE_DECLARE_DATA.
* This assures the appropriate indirection is invoked at compile time.
*
- * @tip AP_DECLARE_DATA extern type apr_variable; syntax is required for
+ * @note AP_DECLARE_DATA extern type apr_variable; syntax is required for
* declarations within headers to properly import the variable.
- * @deffunc AP_DECLARE_DATA type apr_variable
+ * @code
+ * AP_DECLARE_DATA type apr_variable
+ * @endcode
*/
#define AP_DECLARE_DATA
@@ -130,8 +145,9 @@
*
* Unless AP_MODULE_DECLARE_STATIC is defined at compile time, symbols
* declared with AP_MODULE_DECLARE_DATA are always exported.
- *
- * @deffunc module AP_MODULE_DECLARE_DATA mod_tag
+ * @code
+ * module AP_MODULE_DECLARE_DATA mod_tag
+ * @endcode
*/
#if defined(WIN32)
#define AP_MODULE_DECLARE(type) type __stdcall
@@ -147,8 +163,6 @@
*
* The old SHARED_MODULE compile-time symbol is now the default behavior,
* so it is no longer referenced anywhere with Apache 2.0.
- *
- * @deffunc AP_MODULE_DECLARE_EXPORT
*/
#define AP_MODULE_DECLARE_EXPORT
#define AP_MODULE_DECLARE(type) __declspec(dllexport) type __stdcall
@@ -157,12 +171,15 @@
#endif
/**
- * @package Hook Functions
+ * Declare a hook function
+ * @param ret The return type of the hook
+ * @param name The hook's name (as a literal)
+ * @param args The arguments the hook function takes, in brackets.
*/
-
#define AP_DECLARE_HOOK(ret,name,args) \
APR_DECLARE_EXTERNAL_HOOK(ap,AP,ret,name,args)
+/** @internal */
#define AP_IMPLEMENT_HOOK_BASE(name) \
APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ap,AP,name)
@@ -176,9 +193,8 @@
* "(int x,void *y)"
* @param args_use The arguments for the hook as used in a call, for example
* "(x,y)"
- * @tip If IMPLEMENTing a hook that is not linked into the Apache core,
+ * @note If IMPLEMENTing a hook that is not linked into the Apache core,
* (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_VOID.
- * @deffunc AP_IMPLEMENT_HOOK_VOID(name, args_decl, args_use)
*/
#define AP_IMPLEMENT_HOOK_VOID(name,args_decl,args_use) \
APR_IMPLEMENT_EXTERNAL_HOOK_VOID(ap,AP,name,args_decl,args_use)
@@ -200,9 +216,8 @@
* @param ok The "ok" return value
* @param decline The "decline" return value
* @return ok, decline or an error.
- * @tip If IMPLEMENTing a hook that is not linked into the Apache core,
+ * @note If IMPLEMENTing a hook that is not linked into the Apache core,
* (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL.
- * @deffunc AP_IMPLEMENT_HOOK_RUN_ALL(ret, name, args_decl, args_use, ok,
decline)
*/
#define AP_IMPLEMENT_HOOK_RUN_ALL(ret,name,args_decl,args_use,ok,decline) \
APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ap,AP,ret,name,args_decl, \
@@ -222,9 +237,8 @@
* "(x,y)"
* @param decline The "decline" return value
* @return decline or an error.
- * @tip If IMPLEMENTing a hook that is not linked into the Apache core
+ * @note If IMPLEMENTing a hook that is not linked into the Apache core
* (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST.
- * @deffunc AP_IMPLEMENT_HOOK_RUN_FIRST(ret, name, args_decl, args_use,
decline)
*/
#define AP_IMPLEMENT_HOOK_RUN_FIRST(ret,name,args_decl,args_use,decline) \
APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(ap,AP,ret,name,args_decl, \
1.41 +5 -14 apr-util/include/apr_hooks.h
Index: apr_hooks.h
===================================================================
RCS file: /home/cvs/apr-util/include/apr_hooks.h,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -r1.40 -r1.41
--- apr_hooks.h 2001/06/09 04:19:56 1.40
+++ apr_hooks.h 2001/06/17 14:34:14 1.41
@@ -64,7 +64,8 @@
#endif
/**
- * @package Apache hooks functions
+ * @file apr_hooks.h
+ * @brief Apache hook functions
*/
#define APR_IMPLEMENT_HOOK_GET_PROTO(ns,link,name) \
@@ -124,8 +125,7 @@
* @param name The name of the hook
* @param args_decl The declaration of the arguments for the hook
* @param args_used The names for the arguments for the hook
- * @deffunc void APR_IMPLEMENT_EXTERNAL_HOOK_VOID(ns, link, name, args_decl,
args_use)
- * @tip The link prefix FOO corresponds to FOO_DECLARE() macros, which
+ * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which
* provide export linkage from the module that IMPLEMENTs the hook, and
* import linkage from external modules that link to the hook's module.
*/
@@ -155,8 +155,7 @@
* @param name The name of the hook
* @param args_decl The declaration of the arguments for the hook
* @param args_used The names for the arguments for the hook
- * @deffunc int APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ns, link, name,
args_decl, args_use)
- * @tip The link prefix FOO corresponds to FOO_DECLARE() macros, which
+ * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which
* provide export linkage from the module that IMPLEMENTs the hook, and
* import linkage from external modules that link to the hook's module.
*/
@@ -191,8 +190,7 @@
* @param name The name of the hook
* @param args_decl The declaration of the arguments for the hook
* @param args_used The names for the arguments for the hook
- * @deffunc int APR_IMPLEMENT_HOOK_RUN_FIRST(ns, link, name, args_decl,
args_use, decline)
- * @tip The link prefix FOO corresponds to FOO_DECLARE() macros, which
+ * @note The link prefix FOO corresponds to FOO_DECLARE() macros, which
* provide export linkage from the module that IMPLEMENTs the hook, and
* import linkage from external modules that link to the hook's module.
*/
@@ -227,20 +225,17 @@
/**
* The global pool used to allocate any memory needed by the hooks.
- * @defvar apr_pool_t *apr_global_hook_pool
*/
APU_DECLARE_DATA extern apr_pool_t *apr_global_hook_pool;
/**
* A global variable to determine if debugging information about the
* hooks functions should be printed
- * @defvar apr_pool_t *apr_debug_module_hooks
*/
APU_DECLARE_DATA extern int apr_debug_module_hooks;
/**
* The name of the module that is currently registering a function
- * @defvar apr_pool_t *apr_current_hooking_module
*/
APU_DECLARE_DATA extern const char *apr_current_hooking_module;
@@ -248,13 +243,11 @@
* Register a hook function to be sorted
* @param szHookName The name of the Hook the function is registered for
* @param aHooks The array which stores all of the functions for this hook
- * @deffunc void apr_hook_sort_register(const char *szHookName,
apr_array_header_t **aHooks)
*/
APU_DECLARE(void) apr_hook_sort_register(const char *szHookName,
apr_array_header_t **aHooks);
/**
* Sort all of the registerd functions for a given hook
- * @deffunc void apr_sort_hooks(void)
*/
APU_DECLARE(void) apr_sort_hooks(void);
@@ -264,14 +257,12 @@
* @param szName The name of the hook
* @param aszPre All of the functions in the predecessor array
* @param aszSucc All of the functions in the successor array
- * @deffunc void apr_show_hook(const char *szName, const char *const
*aszPre, const char *const *aszSucc)
*/
APU_DECLARE(void) apr_show_hook(const char *szName,const char * const
*aszPre,
const char * const *aszSucc);
/**
* Remove all currently registered functions.
- * @deffunc void apr_hook_deregister_all(void)
*/
APU_DECLARE(void) apr_hook_deregister_all(void);
1.2 +2 -1 apr-util/include/apr_optional_hooks.h
Index: apr_optional_hooks.h
===================================================================
RCS file: /home/cvs/apr-util/include/apr_optional_hooks.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- apr_optional_hooks.h 2001/05/20 12:45:54 1.1
+++ apr_optional_hooks.h 2001/06/17 14:34:14 1.2
@@ -62,7 +62,8 @@
#endif
/**
- * @package Apache optional hook functions
+ * @file apr_optional_hooks.h
+ * @brief Apache optional hook functions
*/
APU_DECLARE(void) apr_optional_hook_add(const char *szName,void (*pfn)(void),
1.19 +3 -8 apr-util/include/apr_sha1.h
Index: apr_sha1.h
===================================================================
RCS file: /home/cvs/apr-util/include/apr_sha1.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- apr_sha1.h 2001/02/16 04:17:10 1.18
+++ apr_sha1.h 2001/06/17 14:34:14 1.19
@@ -69,7 +69,8 @@
#endif
/**
- * @package SHA1 library
+ * @file apr_sha1.h
+ * @brief SHA1 library
*/
#define APR_SHA1_DIGESTSIZE 20
@@ -77,7 +78,6 @@
/**
* Define the Magic String prefix that identifies a password as being
* hashed using our algorithm.
- * @defvar APR_SHA1PW_ID "{SHA}"
*/
#define APR_SHA1PW_ID "{SHA}"
#define APR_SHA1PW_IDLEN 5
@@ -105,21 +105,19 @@
* @param clear The plaintext password
* @param len The length of the plaintext password
* @param out The encrypted/encoded password
- * @tip SHA1 support is useful for migration purposes, but is less
+ * @note SHA1 support is useful for migration purposes, but is less
* secure than Apache's password format, since Apache's (MD5)
* password format uses a random eight character salt to generate
* one of many possible hashes for the same password. Netscape
* uses plain SHA1 without a salt, so the same password
* will always generate the same hash, making it easier
* to break since the search space is smaller.
- * @deffunc void apr_sha1_base64(const char *clear, int len, char *out)
*/
APU_DECLARE(void) apr_sha1_base64(const char *clear, int len, char *out);
/**
* Initialize the SHA digest
* @param context The SHA context to initialize
- * @deffunc void apr_sha1_init(apr_sha1_ctx_t *context);
*/
APU_DECLARE(void) apr_sha1_init(apr_sha1_ctx_t *context);
@@ -128,7 +126,6 @@
* @param context The SHA1 context to update
* @param input The buffer to add to the SHA digest
* @param inputLen The length of the input buffer
- * @deffunc void apr_sha1_update(apr_sha1_ctx_t *context, const char *input,
unsigned int inputLen)
*/
APU_DECLARE(void) apr_sha1_update(apr_sha1_ctx_t *context, const char *input,
unsigned int inputLen);
@@ -138,7 +135,6 @@
* @param context The SHA1 context to update
* @param input The buffer to add to the SHA digest
* @param inputLen The length of the input buffer
- * @deffunc void apr_sha1_update_binary(apr_sha1_ctx_t *context, const
unsigned char *input, unsigned int inputLen)
*/
APU_DECLARE(void) apr_sha1_update_binary(apr_sha1_ctx_t *context,
const unsigned char *input,
@@ -148,7 +144,6 @@
* Finish computing the SHA digest
* @param digest the output buffer in which to store the digest
* @param context The context to finalize
- * @deffunc void apr_sha1_final(unsigned char digest[APR_SHA1_DIGESTSIZE],
apr_sha1_ctx_t *context)
*/
APU_DECLARE(void) apr_sha1_final(unsigned char digest[APR_SHA1_DIGESTSIZE],
apr_sha1_ctx_t *context);
