improve documentation + Doxygen formatting

[cdsspec-compiler.git] / hashtable.h

diff --git a/hashtable.h b/hashtable.h
index 5b0086f24282393b47cdb15ac9377ba3928b8178..c09b3ff3e77f344f1dd3fa8ab0f4685be5801b87 100644 (file)
--- a/hashtable.h
+++ b/hashtable.h
@@ -12,8 +12,9 @@
 #include "common.h"
 
 /**
- * Hashtable linked node class, for chained storage of hash table conflicts. By
- * default it is snapshotting, but you can pass in your own allocation
+ * @brief HashTable linked node class, for chained storage of hash table conflicts
+ *
+ * By default it is snapshotting, but you can pass in your own allocation
  * functions.
  *
  * @tparam _Key    Type name for the key
@@ -33,8 +34,10 @@ struct hashlistnode {
 };
 
 /**
- * Hashtable class. By default it is snapshotting, but you can pass in your own
- * allocation functions.
+ * @brief A simple, custom hash table
+ *
+ * By default it is snapshotting, but you can pass in your own allocation
+ * functions.
  *
  * @tparam _Key    Type name for the key
  * @tparam _Val    Type name for the values to be stored