apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From i...@apache.org
Subject cvs commit: apr/include apr_file_info.h apr_mmap.h apr_shmem.h
Date Sat, 18 Aug 2001 15:15:46 GMT
ianh        01/08/18 08:15:46

  Modified:    include  apr_file_info.h apr_mmap.h apr_shmem.h
  Log:
  Changes to make Doxygen work
  
  Revision  Changes    Path
  1.23      +0 -3      apr/include/apr_file_info.h
  
  Index: apr_file_info.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_file_info.h,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- apr_file_info.h	2001/08/15 21:02:53	1.22
  +++ apr_file_info.h	2001/08/18 15:15:46	1.23
  @@ -77,9 +77,6 @@
    * @ingroup APR
    * @{
    */
  -/*
  - * @package APR File handling
  - */
   
   typedef enum {
       APR_NOFILE = 0,     /**< the file exists, but APR doesn't know its type */
  
  
  
  1.25      +14 -10    apr/include/apr_mmap.h
  
  Index: apr_mmap.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_mmap.h,v
  retrieving revision 1.24
  retrieving revision 1.25
  diff -u -r1.24 -r1.25
  --- apr_mmap.h	2001/07/12 23:35:56	1.24
  +++ apr_mmap.h	2001/08/18 15:15:46	1.25
  @@ -67,16 +67,23 @@
   #ifdef __cplusplus
   extern "C" {
   #endif /* __cplusplus */
  +/**
  + * @file apr_mmap.h
  + * @brief APR MMAP routines
  + */
  +/**
  + * @defgroup APR_MMAP MMAP (Memory Map) Routines
  + * @ingroup APR
  + * @{
  + */
   
   #define APR_MMAP_READ    1
   #define APR_MMAP_WRITE   2
   
  -/**
  - * @package APR MMAP library
  - */
  -
   typedef struct apr_mmap_t            apr_mmap_t;
  -/* As far as I can tell the only really sane way to store an MMAP is as a
  +/**
  + * @remark
  + * As far as I can tell the only really sane way to store an MMAP is as a
    * void * and a length.  BeOS requires this area_id, but that's just a little
    * something extra.  I am exposing this type, because it doesn't make much
    * sense to keep it private, and opening it up makes some stuff easier in
  @@ -106,7 +113,7 @@
       apr_size_t size;
   };
   
  -#if APR_HAS_MMAP
  +#if APR_HAS_MMAP || defined(DOXYGEN)
   
   /*   Function definitions */
   
  @@ -122,7 +129,6 @@
    *          APR_MMAP_WRITE      MMap opened for writing
    * </PRE>
    * @param cntxt The pool to use when creating the mmap.
  - * @deffunc apr_status_t apr_mmap_create(apr_mmap_t **newmmap, apr_file_t *file, apr_off_t
offset, apr_size_t size, apr_int32_t flag, apr_pool_t *cntxt)
    */
   APR_DECLARE(apr_status_t) apr_mmap_create(apr_mmap_t **newmmap, 
                                             apr_file_t *file, apr_off_t offset,
  @@ -132,7 +138,6 @@
   /**
    * Remove a mmap'ed.
    * @param mmap The mmap'ed file.
  - * @deffunc apr_status_t apr_mmap_delete(apr_mmap_t *mmap)
    */
   APR_DECLARE(apr_status_t) apr_mmap_delete(apr_mmap_t *mmap);
   
  @@ -141,13 +146,12 @@
    * @param addr The pointer to the offset specified.
    * @param mmap The mmap'ed file.
    * @param offset The offset to move to.
  - * @deffunc apr_status_t apr_mmap_offset(void **addr, apr_mmap_t *mmap, apr_off_t offset)
    */
   APR_DECLARE(apr_status_t) apr_mmap_offset(void **addr, apr_mmap_t *mmap, 
                                             apr_off_t offset);
   
   #endif /* APR_HAS_MMAP */
  -
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.18      +8 -12     apr/include/apr_shmem.h
  
  Index: apr_shmem.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_shmem.h,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- apr_shmem.h	2001/02/16 04:15:47	1.17
  +++ apr_shmem.h	2001/08/18 15:15:46	1.18
  @@ -54,9 +54,14 @@
   
   #ifndef APR_SHMEM_H
   #define APR_SHMEM_H
  -
  +/** 
  + * @file apr_shmem.h
  + * @brief APR Shared Memory Routines
  + */
   /**
  - * @package Shared Memory library
  + * @defgroup APR_shmem Shared Memory Routines
  + * @ingroup APR
  + * @{
    */
   
   #include "apr.h"
  @@ -87,7 +92,6 @@
    * @param file The file to use for the shared memory on platforms 
    *        that require it.
    * @param cont The pool to use
  - * @deffunc apr_status_t apr_shm_init(apr_shmem_t **m, apr_size_t reqsize, const char *file,
apr_pool_t *cont)
    */
   APR_DECLARE(apr_status_t) apr_shm_init(apr_shmem_t **m, apr_size_t reqsize,
                                          const char *file, apr_pool_t *cont);
  @@ -95,7 +99,6 @@
   /**
    * Destroy the shared memory block.
    * @param m The shared memory block to destroy. 
  - * @deffunc apr_status_t apr_shm_destroy(apr_shmem_t *m)
    */
   APR_DECLARE(apr_status_t) apr_shm_destroy(apr_shmem_t *m);
   
  @@ -103,7 +106,6 @@
    * allocate memory from the block of shared memory.
    * @param c The shared memory block to destroy. 
    * @param reqsize How much memory to allocate
  - * @deffunc void *apr_shm_malloc(apr_shmem_t *c, apr_size_t reqsize)
    */
   APR_DECLARE(void *) apr_shm_malloc(apr_shmem_t *c, apr_size_t reqsize);
   
  @@ -111,7 +113,6 @@
    * allocate memory from the block of shared memory and initialize it to zero.
    * @param shared The shared memory block to destroy. 
    * @param size How much memory to allocate
  - * @deffunc void *apr_shm_calloc(apr_shmem_t *shared, apr_size_t size)
    */
   APR_DECLARE(void *) apr_shm_calloc(apr_shmem_t *shared, apr_size_t size);
   
  @@ -119,7 +120,6 @@
    * free shared memory previously allocated.
    * @param shared The shared memory block to destroy. 
    * @param entity The actual data to free. 
  - * @deffunc apr_status_t apr_shm_free(apr_shmem_t *shared, void *entity)
    */
   APR_DECLARE(apr_status_t) apr_shm_free(apr_shmem_t *shared, void *entity);
   
  @@ -134,7 +134,6 @@
    *         based on file access.  APR_USES_KEYBASED_SHM if shared
    *         memory is based on a key value such as shmctl.  If the
    *         shared memory is anonymous, the name is NULL.
  - * @deffunc apr_status_t apr_shm_name_get(apr_shmem_t *c, apr_shm_name_t **name)
    */
   APR_DECLARE(apr_status_t) apr_shm_name_get(apr_shmem_t *c,
                                              apr_shm_name_t **name);
  @@ -149,7 +148,6 @@
    * @return APR_USES_ANONYMOUS_SHM if we are using anonymous shared
    *         memory.  APR_SUCCESS if we are using named shared memory
    *         and we were able to assign the name correctly. 
  - * @deffunc apr_status_t apr_shm_name_set(apr_shmem_t *c, apr_shm_name_t *name)
    */
   APR_DECLARE(apr_status_t) apr_shm_name_set(apr_shmem_t *c,
                                              apr_shm_name_t *name);
  @@ -157,7 +155,6 @@
   /**
    * Open the shared memory block in a child process.
    * @param  The shared memory block to open in the child. 
  - * @deffunc apr_status_t apr_shm_open(apr_shmem_t *c)
    */
   APR_DECLARE(apr_status_t) apr_shm_open(apr_shmem_t *c);
   
  @@ -165,13 +162,12 @@
    * Determine how much memory is available in the specified shared memory block
    * @param c The shared memory block to open in the child. 
    * @param avail The amount of space available in the shared memory block.
  - * @deffunc apr_status_t apr_shm_avail(apr_shmem_t *c, apr_size_t *avail)
    */
   APR_DECLARE(apr_status_t) apr_shm_avail(apr_shmem_t *c, apr_size_t *avail);
   
   #ifdef __cplusplus
   }
   #endif
  -
  +/** @} */
   #endif  /* ! APR_SHMEM_H */
   
  
  
  

Mime
View raw message