Add Doxygen @file documentation to each source and header file

[ngircd.git] / src / ngircd / client.h

diff --git a/src/ngircd/client.h b/src/ngircd/client.h
index bd000a564772f367ffb19a50b9722dc1277c8cd7..9c7cde4113bd75a1e87ed58ec083d18e882837ed 100644 (file)
--- a/src/ngircd/client.h
+++ b/src/ngircd/client.h
@@ -7,13 +7,16 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * Client management (header)
  */
 
 #ifndef __client_h__
 #define __client_h__
 
+/**
+ * @file
+ * Client management (header)
+ */
+
 #define CLIENT_UNKNOWN 1               /* connection of unknown type */
 #define CLIENT_GOTPASS 2               /* client did send PASS */
 #define CLIENT_GOTNICK 4               /* client did send NICK */
@@ -93,12 +96,14 @@ GLOBAL int Client_Type PARAMS(( CLIENT *Client ));
 GLOBAL CONN_ID Client_Conn PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_ID PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_Mask PARAMS(( CLIENT *Client ));
+GLOBAL char *Client_MaskCloaked PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_Info PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_User PARAMS(( CLIENT *Client ));
 #ifdef PAM
 GLOBAL char *Client_OrigUser PARAMS(( CLIENT *Client ));
 #endif
 GLOBAL char *Client_Hostname PARAMS(( CLIENT *Client ));
+GLOBAL char *Client_HostnameCloaked PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_Password PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_Modes PARAMS(( CLIENT *Client ));
 GLOBAL char *Client_Flags PARAMS(( CLIENT *Client ));
@@ -155,6 +160,12 @@ GLOBAL void Client_RegisterWhowas PARAMS(( CLIENT *Client ));
 
 GLOBAL const char *Client_TypeText PARAMS((CLIENT *Client));
 
+#ifdef DEBUG
+GLOBAL void Client_DebugDump PARAMS((void));
 #endif
 
+
+#endif
+
+
 /* -eof- */