Add Doxygen @file documentation to each source and header file

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

diff --git a/src/ngircd/irc.h b/src/ngircd/irc.h
index b271248574b141253af76b19ac6940b52ddbcee5..cdeb74580984c2fee70198d83cb81e6e05c67649 100644 (file)
--- a/src/ngircd/irc.h
+++ b/src/ngircd/irc.h
@@ -1,34 +1,30 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001 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 comBase beteiligten Autoren finden Sie in der Datei AUTHORS.
- *
- * $Id: irc.h,v 1.1 2001/12/14 08:13:43 alex Exp $
- *
- * irc.h: IRC-Befehle (Header)
- *
- * $Log: irc.h,v $
- * Revision 1.1  2001/12/14 08:13:43  alex
- * - neues Modul begonnen :-)
+ * Copyright (c)2001-2008 Alexander Barton (alex@barton.de)
  *
+ * 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_h__
 #define __irc_h__
 
+/**
+ * @file
+ * IRC commands (header)
+ */
 
-GLOBAL VOID IRC_Init( VOID );
-GLOBAL VOID IRC_Exit( VOID );
-
+GLOBAL bool IRC_ERROR PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_KILL PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_NOTICE PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_PRIVMSG PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_SQUERY PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_TRACE PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_HELP PARAMS((CLIENT *Client, REQUEST *Req));
 
 #endif
 
-
 /* -eof- */