You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by ia...@apache.org on 2002/03/18 17:46:42 UTC
cvs commit: apr/include apr_pools.h apr_version.h
ianh 02/03/18 08:46:41
Modified: docs doxygen.conf
include apr_pools.h apr_version.h
Log:
small minor fixes to Doxygen
Revision Changes Path
1.4 +1 -0 apr/docs/doxygen.conf
Index: doxygen.conf
===================================================================
RCS file: /home/cvs/apr/docs/doxygen.conf,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- doxygen.conf 15 Feb 2002 21:15:44 -0000 1.3
+++ doxygen.conf 18 Mar 2002 16:46:41 -0000 1.4
@@ -14,6 +14,7 @@
PREDEFINED="APR_DECLARE(x)=x" \
"APR_DECLARE_NONSTD(x)=x" \
"APR_HAS_XLATE" \
+ "APR_HAS_THREADS" \
DOXYGEN=
OPTIMIZE_OUTPUT_FOR_C=YES
1.84 +2 -0 apr/include/apr_pools.h
Index: apr_pools.h
===================================================================
RCS file: /home/cvs/apr/include/apr_pools.h,v
retrieving revision 1.83
retrieving revision 1.84
diff -u -r1.83 -r1.84
--- apr_pools.h 18 Mar 2002 16:24:54 -0000 1.83
+++ apr_pools.h 18 Mar 2002 16:46:41 -0000 1.84
@@ -94,6 +94,7 @@
/**
* Pool debug levels
*
+ * <pre>
* | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
* ---------------------------------
* | | | | | | | | x | General debug code enabled (usefull in
@@ -123,6 +124,7 @@
*
* When no debug level was specified, assume general debug mode.
* If level 0 was specified, debugging is switched off
+ * </pre>
*/
#if defined(APR_POOL_DEBUG)
#if (APR_POOL_DEBUG != 0) && (APR_POOL_DEBUG - 0 == 0)
1.3 +66 -45 apr/include/apr_version.h
Index: apr_version.h
===================================================================
RCS file: /home/cvs/apr/include/apr_version.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- apr_version.h 13 Mar 2002 20:39:15 -0000 1.2
+++ apr_version.h 18 Mar 2002 16:46:41 -0000 1.3
@@ -61,49 +61,66 @@
extern "C" {
#endif
-/*
- APR's Version
-
- There are several different mechanisms for accessing the version. There
- is a string form, and a set of numbers; in addition, there are constants
- which can be compiled into your application, and you can query the library
- being used for its actual version.
-
- Note that it is possible for an application to detect that it has been
- compiled against a different version of APR by use of the compile-time
- constants and the use of the run-time query function.
-
- ### we have not defined source/binary compatibility guidelines yet and
- ### how those map against these (release) version numbers. a strawman
- ### would be the following text:
-
- APR is binary-compatible (an app compiled against one version does not
- need to be recompiled to work against another version) for the same
- MAJOR and MINOR versions.
-
- APR is source-compatible (an app needs to be recompiled, but will work
- the same) for the same MAJOR version.
-
- If the MAJOR version changes, then an application may need source changes.
-
- Note that APR is defined to be forward compatible only, meaning that a
- given application will be compatible with APR releases moving forward in
- time. An application may not be compatible with earlier versions of an
- APR library (even if the major and minor versions match). This restriction
- is because a later version of APR can introduce new APIs.
-*/
+/**
+ * @file apr_version.h
+ * @brief
+ *
+ * APR's Version
+ *
+ * There are several different mechanisms for accessing the version. There
+ * is a string form, and a set of numbers; in addition, there are constants
+ * which can be compiled into your application, and you can query the library
+ * being used for its actual version.
+ *
+ * Note that it is possible for an application to detect that it has been
+ * compiled against a different version of APR by use of the compile-time
+ * constants and the use of the run-time query function.
+ *
+ * ### we have not defined source/binary compatibility guidelines yet and
+ * ### how those map against these (release) version numbers. a strawman
+ * ### would be the following text:
+ *
+ * APR is binary-compatible (an app compiled against one version does not
+ * need to be recompiled to work against another version) for the same
+ * MAJOR and MINOR versions.
+ *
+ * APR is source-compatible (an app needs to be recompiled, but will work
+ * the same) for the same MAJOR version.
+ *
+ * If the MAJOR version changes, then an application may need source changes.
+ *
+ * Note that APR is defined to be forward compatible only, meaning that a
+ * given application will be compatible with APR releases moving forward in
+ * time. An application may not be compatible with earlier versions of an
+ * APR library (even if the major and minor versions match). This restriction
+ * is because a later version of APR can introduce new APIs.
+ */
/* The numeric compile-time version constants. These constants are the
- authoritative version numbers for APR. */
+ * authoritative version numbers for APR.
+ */
+/** major version
+ * Major API changes that could cause compatibility problems for older programs
+ * such as structure size changes. No binary compatibility is possible across
+ * a change in the major version.
+ */
#define APR_MAJOR_VERSION 0
+/**
+ * Minor API changes that do not cause binary compatibility problems.
+ * Should be reset to 0 when upgrading APR_MAJOR_VERSION
+ */
#define APR_MINOR_VERSION 9
+/** patch level */
#define APR_PATCH_VERSION 0
-/* This symbol is defined for internal, "development" copies of APR. This
- symbol will be #undef'd for releases. */
+
+/**
+ * This symbol is defined for internal, "development" copies of APR. This
+ * symbol will be #undef'd for releases.
+ */
#define APR_IS_DEV_VERSION
-/* The formatted string of APR's version */
+/** The formatted string of APR's version */
#define APR_VERSION_STRING \
APR_STRINGIFY(APR_MAJOR_VERSION) "." \
APR_STRINGIFY(APR_MINOR_VERSION) "." \
@@ -111,8 +128,10 @@
APR_IS_DEV_STRING
-/* The numeric version information is broken out into fields within this
- structure. */
+/**
+ * The numeric version information is broken out into fields within this
+ * structure.
+ */
typedef struct {
int major;
int minor;
@@ -120,22 +139,24 @@
int is_dev;
} apr_version_t;
-/* Return APR's version information information in a numeric form.
-
- @param pvsn Pointer to a version structure for returning the version
- information.
-*/
+/**
+ * Return APR's version information information in a numeric form.
+ *
+ * @param pvsn Pointer to a version structure for returning the version
+ * information.
+ */
APR_DECLARE(void) apr_version(apr_version_t *pvsn);
-/* Return APR's version information as a string. */
+/** Return APR's version information as a string. */
APR_DECLARE(const char *) apr_version_string(void);
-/* Internal: helper macros for stringifying the version numbers */
+/** Internal: helper macro for stringifying the version numbers */
#define APR_STRINGIFY(n) APR_STRINGIFY_HELPER(n)
+/** Internal: helper macro for stringifying the version numbers */
#define APR_STRINGIFY_HELPER(n) #n
-/* Internal: string form of the "is dev" flag */
+/** Internal: string form of the "is dev" flag */
#ifdef APR_IS_DEV_VERSION
#define APR_IS_DEV_STRING "-dev"
#else