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

Timestamp:

Mar 18, 2004, 9:37:58 PM (22 years ago)

Author:

eugene

Message:

code cleanup for Doxygen support & readability

File:

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

trunk/archive/pslib/include/psHash.h

@@ -8 +8 @@
 
 /** DO WE NEED TO DEFINE HashTable? */
-typedef struct HashTable psHash;        //!< Opaque type for a hash table
+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
-    );
+/** Functions **************************************************************/
+/** \addtogroup DataGroup General Data Container Utilities  
+ *  \{
+ */
 
-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
-    );
+/// Allocate hash buckets in table.
+psHash *psHashAlloc(int nbucket)        ///< initial number of buckets
+;
 
-void *psHashRemove(psHash *table,       //!< table to lookup key in
-                   const char *key      //!< key to lookup
-    );
+/// Free hash buckets from table.
+void psHashFree(psHash *table,          ///< hash table to be freed
+                void (*itemFree)(void *item)) ///< how to free hashed data; or NULL
+;
 
+/// Insert entry into table.
+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
+;
+
+/// Lookup key in table.
+void *psHashLookup(psHash *table,       ///< table to lookup key in
+                   const char *key)     ///< key to lookup
+;
+
+/// Remove key from table.
+void *psHashRemove(psHash *table,       ///< table to lookup key in
+                   const char *key)     ///< key to lookup
+;
+
+/* \} */ // End of DataGroup Functions
 
 #endif