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 81828595152119b90d449a5d920eb3097c5365cd..89bbafef96459fd1aa468906f7a6fed5f5fd1a1c 100644 (file)
--- a/src/ngircd/irc-channel.h
+++ b/src/ngircd/irc-channel.h
@@ -2,29 +2,29 @@
  * ngIRCd -- The Next Generation IRC Daemon
  * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
  *
- * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
- * der GNU General Public License (GPL), wie von der Free Software Foundation
- * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
- * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
- * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
- * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
- *
- * $Id: irc-channel.h,v 1.2 2002/03/12 14:37:52 alex Exp $
- *
- * irc-channel.h: IRC-Channel-Befehle (Header)
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * 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.
  */
 
 
 #ifndef __irc_channel_h__
 #define __irc_channel_h__
 
-#include "parse.h"
-#include "client.h"
+/**
+ * @file
+ * IRC channel commands (header)
+ */
+
+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 bool IRC_LIST PARAMS((CLIENT *Client, REQUEST *Req ));
 
-GLOBAL BOOLEAN IRC_JOIN( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_PART( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_TOPIC( CLIENT *Client, REQUEST *Req );
+GLOBAL bool IRC_CHANINFO PARAMS((CLIENT *Client, REQUEST *Req ));
 
 
 #endif