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

Timestamp:

Jun 9, 2004, 2:09:55 PM (22 years ago)

Author:

gusciora

Message:

Renamed psLog messages, commented the psHash code.

File:

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

trunk/psLib/src/sysUtils/psHash.h

@@ -1 @@
-/** @file  psHash.c
+/** @file  psHash.h
  *
  *  @brief Contains support for basic hashing functions.
@@ -10 +10 @@
  *  @author George Gusciora, MHPCC
  *   
- *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-06-08 19:08:40 $
+ *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-10 00:09:55 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -26 +26 @@
 
 
-/** DO WE NEED TO DEFINE HashTable? */
-//typedef struct HashTable psHash; ///< Opaque type for a hash table
-// An entire hash table
-
 // A bucket that holds an item of data
 typedef struct psHashBucket
 {
-    char *key;                          // key for this item of data
-    void *data;                         // the data itself
-    struct psHashBucket *next;          // list of other possible keys
+    char *key;                          ///< key for this item of data
+    void *data;                         ///< the data itself
+    struct psHashBucket *next;          ///< list of other possible keys
 }
 psHashBucket;
 
+//typedef struct HashTable psHash; ///< Opaque type for a hash table
 typedef struct psHash
 {
-    int nbucket;
-    psHashBucket **buckets;
+    int nbucket;                        //< Number of buckets in hash table.
+    psHashBucket **buckets;             //< The bucket data.
 }
 psHash;
@@ -78 +75 @@
 
 /// List all keys in table.
-psList *psHashKeyList(psHash *table);
+psList *psHashKeyList(psHash *table  ///< table to list keys from.
+                     );
 
 /* \} */ // End of DataGroup Functions