Changeset 1426 for trunk/psLib/src/collections/psHash.h

Timestamp:

Aug 9, 2004, 12:44:25 PM (22 years ago)

Author:

desonia

Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

File:

• trunk/psLib/src/collections/psHash.h (modified) (3 diffs)

trunk/psLib/src/collections/psHash.h

@@ -11 +11 @@
  *  @author George Gusciora, MHPCC
  *   
- *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-09 20:29:43 $
+ *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-09 22:44:25 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -29 +29 @@
 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;
@@ -40 +40 @@
 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 // /< The number of buckets to allocate.
+psHash *psHashAlloc(int nbucket ///< The number of buckets to allocate.
                    );
 
 /// Insert entry into table.
-bool psHashAdd(psHash * table,  // /< table to insert in
-               const char *key, // /< key to use
-               void *data       // /< data to insert
+bool psHashAdd(psHash * table,  ///< table to insert in
+               const char *key, ///< key to use
+               void *data       ///< data to insert
               );
 
 /// Lookup key in table.
-void *psHashLookup(psHash * table,      // /< table to lookup key in
-                   const char *key      // /< key to lookup
+void *psHashLookup(psHash * table,      ///< table to lookup key in
+                   const char *key      ///< key to lookup
                   );
 
 /// Remove key from table.
-bool psHashRemove(psHash * table,       // /< table to lookup key in
-                  const char *key       // /< key to lookup
+bool psHashRemove(psHash * table,       ///< table to lookup key in
+                  const char *key       ///< key to lookup
                  );
 
 /// List all keys in table.
-psList *psHashKeyList(psHash * table    // /< table to list keys from.
+psList *psHashKeyList(psHash * table    ///< table to list keys from.
                      );