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:24:54 UTC
cvs commit: apr/include apr_pools.h apr_allocator.h
ianh 02/03/18 08:24:54
Modified: include apr_pools.h apr_allocator.h
Log:
fix the doxygenization of these 2 files
Revision Changes Path
1.83 +13 -6 apr/include/apr_pools.h
Index: apr_pools.h
===================================================================
RCS file: /home/cvs/apr/include/apr_pools.h,v
retrieving revision 1.82
retrieving revision 1.83
diff -u -r1.82 -r1.83
--- apr_pools.h 18 Mar 2002 15:04:18 -0000 1.82
+++ apr_pools.h 18 Mar 2002 16:24:54 -0000 1.83
@@ -77,7 +77,7 @@
* and without thinking too hard about it either.
*/
/**
- * @defgroup APR_Pool Pool Allocation Functions
+ * @defgroup APR_Pool Memory Pool Functions
* @ingroup APR
* @{
*/
@@ -133,8 +133,11 @@
#define APR_POOL_DEBUG 0
#endif
+/** String to number */
#define APR_POOL_STRINGIZE(x) APR_POOL__STRINGIZE(x)
+/** String to number */
#define APR_POOL__STRINGIZE(x) #x
+/** the place in the code where the particular function was called */
#define APR_POOL__FILE_LINE__ __FILE__ ":" APR_POOL_STRINGIZE(__LINE__)
@@ -189,10 +192,10 @@
/**
* Debug version of apr_pool_create_ex.
- * @param newpool See: apr_pool_create.
- * @param parent See: apr_pool_create.
- * @param abort_fn See: apr_pool_create.
- * @param allocator See: apr_pool_create.
+ * @param newpool @see apr_pool_create.
+ * @param parent @see apr_pool_create.
+ * @param abort_fn @see apr_pool_create.
+ * @param allocator @see apr_pool_create.
* @param file_line Where the function is called from.
* This is usually APR_POOL__FILE_LINE__.
* @remark Only available when APR_POOL_DEBUG is defined.
@@ -632,7 +635,7 @@
#endif /* APR_POOL_DEBUG or DOXYGEN */
-/*
+/**
* Pool accessor functions.
*
* These standardized function are used by opaque (APR) data types to return
@@ -653,12 +656,16 @@
* Note: the linkage is specified for APR. It would be possible to expand
* the macros to support other linkages.
*/
+
#define APR_POOL_DECLARE_ACCESSOR(typename) \
APR_DECLARE(apr_pool_t *) apr_##typename##_pool_get \
(const apr_##typename##_t *ob)
+/** used to implement the pool accessor */
#define APR_POOL_IMPLEMENT_ACCESSOR(typename) \
APR_POOL_IMPLEMENT_ACCESSOR_X(typename, pool)
+
+/** used to implement the pool accessor */
#define APR_POOL_IMPLEMENT_ACCESSOR_X(typename, fieldname) \
APR_DECLARE(apr_pool_t *) apr_##typename##_pool_get \
(const apr_##typename##_t *ob) { return ob->fieldname; }
1.2 +9 -1 apr/include/apr_allocator.h
Index: apr_allocator.h
===================================================================
RCS file: /home/cvs/apr/include/apr_allocator.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- apr_allocator.h 15 Mar 2002 00:48:24 -0000 1.1
+++ apr_allocator.h 18 Mar 2002 16:24:54 -0000 1.2
@@ -64,6 +64,12 @@
* @brief APR memory allocation
*
*/
+/**
+ * @defgroup APR_Pool_allocator Allocator
+ * @ingroup APR_Pool
+ * @{
+ */
+
#include "apr.h"
#include "apr_errno.h"
@@ -74,7 +80,9 @@
#include "apr_pools.h"
+/** the allocator structure */
typedef struct apr_allocator_t apr_allocator_t;
+/** the structure which holds information about the allocation */
typedef struct apr_memnode_t apr_memnode_t;
/**
@@ -152,7 +160,7 @@
apr_allocator_t *allocator);
#endif /* APR_HAS_THREADS */
-
+/** @} */
#ifdef __cplusplus
}
#endif