Changeset 196 for trunk/archive/pslib/include/psHash.h

Timestamp:

Mar 9, 2004, 5:19:15 PM (22 years ago)

Author:

Paul Price

Message:

Doxygenation of Lupton stuff partially complete. Still need to hack some more to conform everything to coding standards.

File:

• trunk/archive/pslib/include/psHash.h (modified) (1 diff)

trunk/archive/pslib/include/psHash.h

@@ -2 +2 @@
 #define PS_HASH_H
 
-typedef struct HashTable psHash;
+typedef struct HashTable psHash;        //!< Opaque type for a hash table
 
-psHash *psHashAlloc(int nbucket);       // initial number of buckets
-void psHashFree(psHash *table,          // hash table to be freed
-                void (*itemFree)(void *item)); // how to free hashed data;
-                                        // or NULL
+psHash *psHashAlloc(int nbucket         //!< initial number of buckets
+    );
+void psHashFree(psHash *table,          //!< hash table to be freed
+                void (*itemFree)(void *item) //!< how to free hashed data; or NULL
+    );
 
-void *psHashInsert(psHash *table,       // table to insert in
-                   const char *key,     // key to use
-                   void *data,          // data to insert
-                   void (*itemFree)(void *item)); // how to free hashed data;
-                                        // or NULL
-void *psHashLookup(psHash *table,       // table to lookup key in
-                   const char *key);    // key to lookup
+void *psHashInsert(psHash *table,       //!< table to insert in
+                   const char *key,     //!< key to use
+                   void *data,          //!< data to insert
+                   void (*itemFree)(void *item) //!< how to free hashed data; or NULL
+    );
+void *psHashLookup(psHash *table,       //!< table to lookup key in
+                   const char *key      //!< key to lookup
+    );
 
-void *psHashRemove(psHash *table,       // table to lookup key in
-                   const char *key);    // key to lookup
+void *psHashRemove(psHash *table,       //!< table to lookup key in
+                   const char *key      //!< key to lookup
+    );
+
+
 #endif