Doxyfy hash.h and hash.c.

[ircu2.10.12-pk.git] / include / hash.h

diff --git a/include/hash.h b/include/hash.h
index 05b36d9c00101e8ad861e0b6e59d024074a6dc60..02806192aa7366269135c19632f69e71c0a3a62c 100644 (file)
--- a/include/hash.h
+++ b/include/hash.h
@@ -29,7 +29,9 @@ struct Channel;
  * general defines
  */
 
-/* Now client and channel hash table must be of the same size */
+/** Size of client and channel hash tables.
+ * Both must be of the same size.
+ */
 #define HASHSIZE                32000
 
 /*
@@ -45,16 +47,24 @@ struct Channel;
  */
 
 /* Raw calls, expect a core if you pass a NULL or zero-length name */
+/** Search for a channel by name. */
 #define SeekChannel(name)       hSeekChannel((name))
+/** Search for any client by name. */
 #define SeekClient(name)        hSeekClient((name), ~0)
+/** Search for a registered user by name. */
 #define SeekUser(name)          hSeekClient((name), (STAT_USER))
+/** Search for a server by name. */
 #define SeekServer(name)        hSeekClient((name), (STAT_ME | STAT_SERVER))
 
 /* Safer macros with sanity check on name, WARNING: these are _macros_,
    no side effects allowed on <name> ! */
+/** Search for a channel by name. */
 #define FindChannel(name)       (BadPtr((name)) ? 0 : SeekChannel(name))
+/** Search for any client by name. */
 #define FindClient(name)        (BadPtr((name)) ? 0 : SeekClient(name))
+/** Search for a registered user by name. */
 #define FindUser(name)          (BadPtr((name)) ? 0 : SeekUser(name))
+/** Search for a server by name. */
 #define FindServer(name)        (BadPtr((name)) ? 0 : SeekServer(name))
 
 /*