apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From i...@apache.org
Subject cvs commit: apr/memory/unix sms_private.h
Date Fri, 24 Aug 2001 17:15:01 GMT
ianh        01/08/24 10:15:01

  Modified:    include  apr_general.h apr_signal.h apr_sms_blocks.h
                        apr_sms.h apr_sms_threads.h apr_sms_tracking.h
                        apr_sms_trivial.h apr_thread_proc.h
               memory/unix sms_private.h
  Log:
  Doxygen updates
  
  Revision  Changes    Path
  1.61      +47 -34    apr/include/apr_general.h
  
  Index: apr_general.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_general.h,v
  retrieving revision 1.60
  retrieving revision 1.61
  diff -u -r1.60 -r1.61
  --- apr_general.h	2001/08/19 05:45:41	1.60
  +++ apr_general.h	2001/08/24 17:15:00	1.61
  @@ -54,7 +54,10 @@
   
   #ifndef APR_GENERAL_H
   #define APR_GENERAL_H
  -
  +/**
  + * @file apr_general.h
  + * @brief APR Misc routines
  + */
   #include "apr.h"
   #include "apr_pools.h"
   #include "apr_errno.h"
  @@ -67,6 +70,12 @@
   extern "C" {
   #endif /* __cplusplus */
   
  +/**
  + * @defgroup APR_Misc Misc routines
  + * @ingroup APR
  + * @{
  + */
  +
   #ifndef FALSE
   #define FALSE 0
   #endif
  @@ -83,7 +92,8 @@
   
   typedef int               apr_signum_t;
   
  -/* Finding offsets of elements within structures.
  +/**
  + * Finding offsets of elements within structures.
    * Taken from the X code... they've sweated portability of this stuff
    * so we don't have to.  Sigh...
    */
  @@ -116,7 +126,8 @@
   #endif
   
   
  -/* A couple of prototypes for functions in case some platform doesn't 
  +/**
  + * A couple of prototypes for functions in case some platform doesn't 
    * have it
    */
   #if (!APR_HAVE_STRCASECMP) && (APR_HAVE_STRICMP) 
  @@ -131,7 +142,7 @@
   int strncasecmp(const char *a, const char *b, size_t n);
   #endif
   
  -/*
  +/**
    * String and memory functions
    */
   
  @@ -144,24 +155,6 @@
   #endif
   
   /**
  - * @package APR Random Functions
  - */
  -
  -#if APR_HAS_RANDOM
  -
  -/* TODO: I'm not sure this is the best place to put this prototype...*/
  -/**
  - * Generate a string of random bytes.
  - * @param buf Random bytes go here
  - * @param length size of the buffer
  - * @deffunc apr_status_t apr_generate_random_bytes(unsigned char * buf, int length)
  - */
  -APR_DECLARE(apr_status_t) apr_generate_random_bytes(unsigned char * buf, 
  -                                                    int length);
  -
  -#endif
  -
  -/**
    * Setup any APR internal data structures.  This MUST be the first function 
    * called for any APR program.
    * @deffunc apr_status_t apr_initialize(void)
  @@ -171,26 +164,46 @@
   /**
    * Tear down any APR internal data structures which aren't torn down 
    * automatically.
  - * @tip An APR program must call this function at termination once it 
  - *      has stopped using APR services.  The APR developers suggest using
  - *      atexit to ensure this is called.  When using APR from a language
  - *      other than C that has problems with the calling convention, use
  - *      apr_terminate2() instead.
  - * @deffunc void apr_terminate(void)
  + * @remark An APR program must call this function at termination once it 
  + *         has stopped using APR services.  The APR developers suggest using
  + *         atexit to ensure this is called.  When using APR from a language
  + *         other than C that has problems with the calling convention, use
  + *         apr_terminate2() instead.
    */
   APR_DECLARE_NONSTD(void) apr_terminate(void);
   
   /**
    * Tear down any APR internal data structures which aren't torn down 
    * automatically, same as apr_terminate
  - * @tip An APR program must call either the apr_terminate or apr_terminate2 
  - *      function once it it has finished using APR services.  The APR 
  - *      developers suggest using atexit(apr_terminate) to ensure this is done.
  - *      apr_terminate2 exists to allow non-c language apps to tear down apr, 
  - *      while apr_terminate is recommended from c language applications.
  - * @deffunc void apr_terminate2(void)
  + * @remark An APR program must call either the apr_terminate or apr_terminate2 
  + *         function once it it has finished using APR services.  The APR 
  + *         developers suggest using atexit(apr_terminate) to ensure this is done.
  + *         apr_terminate2 exists to allow non-c language apps to tear down apr, 
  + *         while apr_terminate is recommended from c language applications.
    */
   APR_DECLARE(void) apr_terminate2(void);
  +
  +/** @} */
  +
  +/**
  + * @defgroup APR_Random Random Functions
  + * @ingroup APR
  + * @{
  + */
  +
  +#if APR_HAS_RANDOM
  +
  +/* TODO: I'm not sure this is the best place to put this prototype...*/
  +/**
  + * Generate a string of random bytes.
  + * @param buf Random bytes go here
  + * @param length size of the buffer
  + */
  +APR_DECLARE(apr_status_t) apr_generate_random_bytes(unsigned char * buf, 
  +                                                    int length);
  +
  +#endif
  +/** @} */
   
   #ifdef __cplusplus
   }
  
  
  
  1.9       +14 -3     apr/include/apr_signal.h
  
  Index: apr_signal.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_signal.h,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- apr_signal.h	2001/07/26 15:58:57	1.8
  +++ apr_signal.h	2001/08/24 17:15:00	1.9
  @@ -54,6 +54,10 @@
   
   #ifndef APR_SIGNAL_H
   #define APR_SIGNAL_H
  +/**
  + * @file apr_signal.h 
  + * @brief APR Signal Handling
  + */
   
   #include "apr.h"
   #include "apr_pools.h"
  @@ -67,7 +71,9 @@
   #endif /* __cplusplus */
   
   /**
  - * @package APR signal handling
  + * @defgroup APR_Signal Signal Handling
  + * @ingroup APR
  + * @{
    */
   
   #if APR_HAVE_SIGACTION
  @@ -75,6 +81,11 @@
   typedef void apr_sigfunc_t(int);
   
   /* ### how to doc this? */
  +/**
  + * Set the signal handler function for a given signal
  + * @param signo The signal (eg... SIGWINCH)
  + * @parm the function to get called
  + */
   APR_DECLARE(apr_sigfunc_t *) apr_signal(int signo, apr_sigfunc_t * func);
   
   #if defined(SIG_IGN) && !defined(SIG_ERR)
  @@ -90,17 +101,17 @@
    * Get the description for a specific signal number
    * @param signum The signal number
    * @return The description of the signal
  - * @deffunc const char *apr_signal_get_description(int signum)
    */
   APR_DECLARE(const char *) apr_signal_get_description(int signum);
   
   /**
    * APR-private function for initializing the signal package
  + * @internal
    * @param pglobal The internal, global pool
  - * @deffunc apr_signal_init(apr_pool_t *pglobal)
    */
   void apr_signal_init(apr_pool_t *pglobal);
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif /* __cplusplus */
  
  
  
  1.2       +8 -3      apr/include/apr_sms_blocks.h
  
  Index: apr_sms_blocks.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_sms_blocks.h,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- apr_sms_blocks.h	2001/06/13 14:12:04	1.1
  +++ apr_sms_blocks.h	2001/08/24 17:15:00	1.2
  @@ -69,9 +69,14 @@
   #ifdef __cplusplus
   extern "C" {
   #endif
  -
  +/**
  + * @file apr_sms_blocks.h
  + * @brief APR SMS Blocks Memory System
  + */
   /**
  - * @package APR blocks memory system
  + * @defgroup APR_SMS_Blocks Blocks SMS
  + * @ingroup APR_SMS
  + * @{
    */
   
   /**
  @@ -85,8 +90,8 @@
                                                   apr_sms_t *pms,
                                                   apr_size_t block_size);
   
  -
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.43      +1 -1      apr/include/apr_sms.h
  
  Index: apr_sms.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_sms.h,v
  retrieving revision 1.42
  retrieving revision 1.43
  diff -u -r1.42 -r1.43
  --- apr_sms.h	2001/08/15 21:02:53	1.42
  +++ apr_sms.h	2001/08/24 17:15:01	1.43
  @@ -65,7 +65,7 @@
    * @brief APR SMS Memory routines
    */
   /**
  - * @defgroup SMS SMS Stackable Memory allocation system
  + * @defgroup APR_SMS SMS Stackable Memory allocation system
    * @ingroup APR
    * @{
    */
  
  
  
  1.4       +8 -9      apr/include/apr_sms_threads.h
  
  Index: apr_sms_threads.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_sms_threads.h,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- apr_sms_threads.h	2001/07/13 17:47:58	1.3
  +++ apr_sms_threads.h	2001/08/24 17:15:01	1.4
  @@ -63,9 +63,14 @@
   #endif
   
   #if APR_HAS_THREADS
  - 
  + /**
  + * @file apr_sms_threads.h
  + * @brief APR SMS Threads Memory System
  + */
   /**
  - * @package APR threads memory system
  + * @defgroup APR_SMS_Threads Threads SMS
  + * @ingroup APR_SMS
  + * @{
    */
   
   /**
  @@ -73,8 +78,6 @@
    * @param mem_sys A pointer to the returned apr_sms_t*
    * @param pms The parent memory system, used to allocate the memory
    *            that we will be threads.
  - * @deffunc apr_status_t apr_sms_threads_create(apr_sms_t **mem_sys,
  - *                                               apr_sms_t *pms);
    */
   APR_DECLARE(apr_status_t) apr_sms_threads_create(apr_sms_t **sms,
                                                     apr_sms_t *pms);
  @@ -89,11 +92,6 @@
    * @param min_free  The minimal amount of memory to make sure is
    *                  free in an allocated block from the parent 
    * @param max_free  The amount of memory the sms may hold on to
  - * @deffunc apr_status_t apr_sms_threads_create_ex(apr_sms_t **mem_sys,
  - *                                                 apr_sms_t *pms,
  - *                                                 apr_size_t min_alloc,
  - *                                                 apr_size_t min_free,
  - *                                                 apr_size_t max_free);
    */
   APR_DECLARE(apr_status_t) apr_sms_threads_create_ex(apr_sms_t **sms,
                                                       apr_sms_t *pms,
  @@ -101,6 +99,7 @@
                                                       apr_size_t min_free,
                                                       apr_size_t max_free);
   
  +/** @} */
   #endif /* APR_HAS_THREADS */
   
   #ifdef __cplusplus
  
  
  
  1.3       +8 -5      apr/include/apr_sms_tracking.h
  
  Index: apr_sms_tracking.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_sms_tracking.h,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- apr_sms_tracking.h	2001/05/14 23:19:39	1.2
  +++ apr_sms_tracking.h	2001/08/24 17:15:01	1.3
  @@ -69,9 +69,14 @@
   #ifdef __cplusplus
   extern "C" {
   #endif
  -
  +/**
  + * @file apr_sms_tracking.h
  + * @brief APR SMS Tracking Memory System
  + */
   /**
  - * @package APR tracking memory system
  + * @defgroup APR_SMS_Tracking Tracking SMS
  + * @ingroup APR_SMS
  + * @{
    */
   
   /**
  @@ -79,14 +84,12 @@
    * @param mem_sys A pointer to the returned apr_sms_t*
    * @param pms The parent memory system, used to allocate the memory
    *            that we will be tracking.
  - * @deffunc apr_status_t apr_sms_tracking_create(apr_sms_t **mem_sys,
  - *                                               apr_sms_t *pms);
    */
   APR_DECLARE(apr_status_t) apr_sms_tracking_create(apr_sms_t **mem_sys,
                                                     apr_sms_t *pms);
   
  -
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.2       +8 -10     apr/include/apr_sms_trivial.h
  
  Index: apr_sms_trivial.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_sms_trivial.h,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- apr_sms_trivial.h	2001/07/01 06:23:10	1.1
  +++ apr_sms_trivial.h	2001/08/24 17:15:01	1.2
  @@ -61,9 +61,14 @@
   #ifdef __cplusplus
   extern "C" {
   #endif
  -
  +/**
  + * @file apr_sms_trivial.h
  + * @brief APR SMS Trivial Memory System
  + */
   /**
  - * @package APR trivial memory system
  + * @defgroup APR_SMS_Trivial Trivial SMS
  + * @ingroup APR_SMS
  + * @{
    */
   
   /**
  @@ -71,8 +76,6 @@
    * @param mem_sys A pointer to the returned apr_sms_t*
    * @param pms The parent memory system, used to allocate the memory
    *            that we will be trivial.
  - * @deffunc apr_status_t apr_sms_trivial_create(apr_sms_t **mem_sys,
  - *                                               apr_sms_t *pms);
    */
   APR_DECLARE(apr_status_t) apr_sms_trivial_create(apr_sms_t **sms,
                                                     apr_sms_t *pms);
  @@ -87,18 +90,13 @@
    * @param min_free  The minimal amount of memory to make sure is
    *                  free in an allocated block from the parent 
    * @param max_free  The amount of memory the sms may hold on to
  - * @deffunc apr_status_t apr_sms_trivial_create_ex(apr_sms_t **mem_sys,
  - *                                                 apr_sms_t *pms,
  - *                                                 apr_size_t min_alloc,
  - *                                                 apr_size_t min_free,
  - *                                                 apr_size_t max_free);
    */
   APR_DECLARE(apr_status_t) apr_sms_trivial_create_ex(apr_sms_t **sms,
                                                       apr_sms_t *pms,
                                                       apr_size_t min_alloc,
                                                       apr_size_t min_free,
                                                       apr_size_t max_free);
  -
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.72      +1 -1      apr/include/apr_thread_proc.h
  
  Index: apr_thread_proc.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_thread_proc.h,v
  retrieving revision 1.71
  retrieving revision 1.72
  diff -u -r1.71 -r1.72
  --- apr_thread_proc.h	2001/08/14 04:05:16	1.71
  +++ apr_thread_proc.h	2001/08/24 17:15:01	1.72
  @@ -71,7 +71,7 @@
   #endif /* __cplusplus */
   /**
    * @file apr_thread_proc.h
  - * @brief APR Thread Libraru
  + * @brief APR Thread Library
    */
   /**
    * @defgroup APR_Thread Thread Library
  
  
  
  1.9       +9 -9      apr/memory/unix/sms_private.h
  
  Index: sms_private.h
  ===================================================================
  RCS file: /home/cvs/apr/memory/unix/sms_private.h,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- sms_private.h	2001/08/12 05:10:28	1.8
  +++ sms_private.h	2001/08/24 17:15:01	1.9
  @@ -58,8 +58,8 @@
    */
   /**
    *
  - * @defgroup SMS_Private Private  routines
  - * @ingroup SMS
  + * @defgroup APR_SMS_Private Private  routines
  + * @ingroup APR_SMS
    * @{
    */
   #ifndef SMS_PRIVATE_H
  @@ -85,14 +85,14 @@
       apr_sms_t  *parent;  /**< parent of the current SMS  */
       apr_sms_t  *child;   /**< children of the current SMS */
       apr_sms_t  *sibling; /**< next SMS at the same level */
  -    apr_sms_t **ref;
  -    apr_sms_t  *accounting;
  +    apr_sms_t **ref; /**< a pointer to the pointer pointing to memory */
  +    apr_sms_t  *accounting; /**< SMS for accounting type tasks */
       const char *identity; /**< a string identifying the module */
   
  -    apr_pool_t *pool;
  -    apr_lock_t *sms_lock;
  +    apr_pool_t *pool; /**< pool to associate with this SMS */
  +    apr_lock_t *sms_lock; /**< lock to use when allocated memory in this SMS */
       
  -    struct apr_sms_cleanup *cleanups;
  +    struct apr_sms_cleanup *cleanups; /**< stuff to call when the SMS is being freed
*/
   
       void * (*malloc_fn)            (apr_sms_t *sms, apr_size_t size); /**< malloc fn
for this SMS */
       void * (*calloc_fn)            (apr_sms_t *sms, apr_size_t size); /**< calloc fn
for this SMS */
  @@ -106,8 +106,8 @@
       apr_status_t (*lock_fn)        (apr_sms_t *sms); /**< locking function */
       apr_status_t (*unlock_fn)      (apr_sms_t *sms); /**< unlocking function */
   
  -    apr_status_t (*apr_abort)(int retcode);
  -    struct apr_hash_t *prog_data;
  +    apr_status_t (*apr_abort)(int retcode); /**< function to call when a malloc fails
*/
  +    struct apr_hash_t *prog_data; /**< has to store userdata */
   
   #ifdef APR_POOLS_ARE_SMS
       struct process_chain *subprocesses;
  
  
  

Mime
View raw message