Add Doxygen @file documentation to each source and header file

[ngircd-alex.git] / src / ngircd / irc-channel.h

diff --git a/src/ngircd/irc-channel.h b/src/ngircd/irc-channel.h
index 5a7ffd5cd58fdd78eba1b4e937dc42796cdc3ffb..89bbafef96459fd1aa468906f7a6fed5f5fd1a1c 100644 (file)
--- a/src/ngircd/irc-channel.h
+++ b/src/ngircd/irc-channel.h
@@ -7,24 +7,24 @@
  * 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.
- *
- * $Id: irc-channel.h,v 1.6 2002/12/12 12:23:43 alex Exp $
- *
- * IRC channel commands (header)
  */
 
 
 #ifndef __irc_channel_h__
 #define __irc_channel_h__
 
+/**
+ * @file
+ * IRC channel commands (header)
+ */
 
-GLOBAL BOOLEAN IRC_JOIN PARAMS((CLIENT *Client, REQUEST *Req ));
-GLOBAL BOOLEAN IRC_PART PARAMS((CLIENT *Client, REQUEST *Req ));
-GLOBAL BOOLEAN IRC_TOPIC PARAMS((CLIENT *Client, REQUEST *Req ));
+GLOBAL bool IRC_JOIN PARAMS((CLIENT *Client, REQUEST *Req ));
+GLOBAL bool IRC_PART PARAMS((CLIENT *Client, REQUEST *Req ));
+GLOBAL bool IRC_TOPIC PARAMS((CLIENT *Client, REQUEST *Req ));
 
-GLOBAL BOOLEAN IRC_LIST PARAMS((CLIENT *Client, REQUEST *Req ));
+GLOBAL bool IRC_LIST PARAMS((CLIENT *Client, REQUEST *Req ));
 
-GLOBAL BOOLEAN IRC_CHANINFO PARAMS((CLIENT *Client, REQUEST *Req ));
+GLOBAL bool IRC_CHANINFO PARAMS((CLIENT *Client, REQUEST *Req ));
 
 
 #endif