cvs commit: apr/include apr_hash.h

[rb...@locus.apache.org]

rbb         00/12/03 21:56:34

  Modified:    include  apr_hash.h
  Log:
  Cleanup the hash table docs.
  
  Revision  Changes    Path
  1.17      +9 -7      apr/include/apr_hash.h
  
  Index: apr_hash.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_hash.h,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- apr_hash.h	2000/11/29 01:09:15	1.16
  +++ apr_hash.h	2000/12/04 05:56:34	1.17
  @@ -81,18 +81,20 @@
    */
   #define APR_HASH_KEY_STRING     (-1)
   
  -/*
  +/**
    * Abstract type for hash tables.
  + * @defvar apr_hash_t
    */
   typedef struct apr_hash_t apr_hash_t;
   
  -/*
  +/**
    * Abstract type for scanning hash tables.
  + * @defvar apr_hash_index_t
    */
   typedef struct apr_hash_index_t apr_hash_index_t;
   
   /**
  - * Create a hash table within a pool.
  + * Create a hash table.
    * @param pool The pool to allocate the hash table out of
    * @return The hash table just created
    * @deffunc apr_hash_t *apr_make_hash(apr_pool_t *pool)
  @@ -103,7 +105,7 @@
    * Associate a value with a key in a hash table.
    * @param ht The hash table
    * @param key Pointer to the key
  - * @param klen Length of the key. Can be APR_HASH_KEY_STRING.
  + * @param klen Length of the key. Can be APR_HASH_KEY_STRING to use the string length.
    * @param val Value to associate with the key
    * @tip If the value is NULL the hash entry is deleted.
    * @deffunc void apr_hash_set(apr_hash_t *ht, const void *key, apr_size_t klen, const void *val)
  @@ -115,7 +117,7 @@
    * Look up the value associated with a key in a hash table.
    * @param ht The hash table
    * @param key Pointer to the key
  - * @param klen Length of the key. Can be APR_HASH_KEY_STRING.
  + * @param klen Length of the key. Can be APR_HASH_KEY_STRING to use the string length.
    * @return Returns NULL if the key is not present.
    * @deffunc void *apr_hash_get(apr_hash_t *ht, const void *key, apr_size_t klen)
    */
  @@ -146,7 +148,7 @@
    * is delete the current entry) and multiple iterations can be in
    * progress at the same time.
    * </PRE>
  - * @deffunc apr_hash_index_t * apr_hash_first(apr_hash_t *ht)
  + * @deffunc apr_hash_index_t *apr_hash_first(apr_hash_t *ht)
    */
   APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_hash_t *ht);
   
  @@ -154,7 +156,7 @@
    * Continue iterating over the entries in a hash table.
    * @param hi The iteration state
    * @return a pointer to the updated iteration state.  NULL if there are no more  *         entries.
  - * @deffunc apr_hash_index_t * apr_hash_next(apr_hash_index_t *hi)
  + * @deffunc apr_hash_index_t *apr_hash_next(apr_hash_index_t *hi)
    */
   APR_DECLARE(apr_hash_index_t *) apr_hash_next(apr_hash_index_t *hi);