apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From b..@apache.org
Subject cvs commit: apr/include apr_pools.h
Date Sun, 03 Jun 2001 11:31:47 GMT
ben         01/06/03 04:31:47

  Modified:    include  apr_pools.h
  Log:
  Doxygenation.
  
  Revision  Changes    Path
  1.49      +23 -2     apr/include/apr_pools.h
  
  Index: apr_pools.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_pools.h,v
  retrieving revision 1.48
  retrieving revision 1.49
  diff -u -r1.48 -r1.49
  --- apr_pools.h	2001/04/27 03:46:13	1.48
  +++ apr_pools.h	2001/06/03 11:31:47	1.49
  @@ -97,7 +97,10 @@
   /** A function that is called when allocation fails. */
   typedef int (*apr_abortfunc_t)(int retcode);
   
  -/* pools have nested lifetimes -- sub_pools are destroyed when the
  +/**
  + * @defgroup PoolDebug Pool Debugging functions.
  + *
  + * pools have nested lifetimes -- sub_pools are destroyed when the
    * parent pool is cleared.  We allow certain liberties with operations
    * on things such as tables (and on other structures in a more general
    * sense) where we allow the caller to insert values into a table which
  @@ -133,9 +136,24 @@
    * In this case the caller must call apr_pool_join() to indicate this
    * guarantee to the APR_POOL_DEBUG code.  There are a few examples spread
    * through the standard modules.
  + *
  + * These functions are only implemented when #APR_POOL_DEBUG is set.
  + *
  + * @{
  + */
  +#if defined(APR_POOL_DEBUG) || defined(DOXYGEN)
  +/**
  + * Guarantee that a subpool has the same lifetime as the parent.
  + * @param p The parent pool
  + * @param sub The subpool
    */
  -#ifdef APR_POOL_DEBUG
   APR_DECLARE(void) apr_pool_join(apr_pool_t *p, apr_pool_t *sub);
  +
  +/**
  + * Find a pool from something allocated in it.
  + * @param ts The thing allocated in the pool
  + * @return The pool it is allocated in
  + */
   APR_DECLARE(apr_pool_t *) apr_find_pool(const void *ts);
   
   /**
  @@ -146,6 +164,9 @@
    *         of all pools.
    */
   APR_DECLARE(int) apr_pool_is_ancestor(apr_pool_t *a, apr_pool_t *b);
  +
  +/* @} */
  +
   #else
   # ifdef apr_pool_join
   #  undef apr_pool_join
  
  
  

Mime
View raw message