Changeset 1013 for trunk/psLib/src/sysUtils/psHash.h

Timestamp:

Jun 11, 2004, 7:50:01 PM (22 years ago)

Author:

gusciora

Message:

cosmetics...

File:

• trunk/psLib/src/sysUtils/psHash.h (modified) (4 diffs)

trunk/psLib/src/sysUtils/psHash.h

@@ -1 +1 @@
 /** @file  psHash.h
- *
  *  @brief Contains support for basic hashing functions.
+ *  @ingroup HashTable
  *
  *  This file will hold the prototypes for defining a hash table with arbitrary
@@ -7 +7 @@
  *  data from that hash table, and listing all keys defined in the hash table.
  *
- *  @ingroup HashTable
- *
  *  @author Robert Lupton, Princeton University
  *  @author George Gusciora, MHPCC
  *   
- *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-06-12 04:55:21 $
+ *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-12 05:50:01 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
  */
-
 #if !defined(PS_HASH_H)
 #define PS_HASH_H
@@ -25 +22 @@
  */
 #include "psList.h"
-
 
 /** A bucket that holds an item of data. */
@@ -40 +36 @@
 typedef struct psHash
 {
-    int nbucket;                        //< Number of buckets in hash table.
-    psHashBucket **buckets;             //< The bucket data.
+    int nbucket;                        ///< Number of buckets in hash table.
+    psHashBucket **buckets;             ///< The bucket data.
 }
 psHash;
 
 /// Allocate hash buckets in table.
-psHash *psHashAlloc(int nbucket);
+psHash *psHashAlloc(int nbucket       ///< The number of buckets to allocate.
+                   );
 
 /// Free hash buckets from table.