Add Doxygen @file documentation to each source and header file

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

diff --git a/src/ngircd/irc-login.h b/src/ngircd/irc-login.h
index 17a7c533babea9e3262ec37d36c1cfc97135c731..f06a5ffae80ff36d486b66cf733ea287e26549e9 100644 (file)
--- a/src/ngircd/irc-login.h
+++ b/src/ngircd/irc-login.h
@@ -1,41 +1,31 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2010 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-login.h,v 1.2 2002/03/03 17:15:11 alex Exp $
- *
- * irc-login.h: Anmeldung und Abmeldung im IRC (Header)
- *
- * $Log: irc-login.h,v $
- * Revision 1.2  2002/03/03 17:15:11  alex
- * - Source in weitere Module fuer IRC-Befehle aufgesplitted.
- *
- * Revision 1.1  2002/02/27 23:26:21  alex
- * - Modul aus irc.c bzw. irc.h ausgegliedert.
+ * 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_login_h__
 #define __irc_login_h__
 
-#include "parse.h"
-#include "client.h"
-
-
-GLOBAL BOOLEAN IRC_PASS( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_NICK( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_USER( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_PING( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_PONG( CLIENT *Client, REQUEST *Req );
-GLOBAL BOOLEAN IRC_QUIT( CLIENT *Client, REQUEST *Req );
+/**
+ * @file
+ * Login and logout (header)
+ */
 
+GLOBAL bool IRC_PASS PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_NICK PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_USER PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_SERVICE PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_WEBIRC PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_PING PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_PONG PARAMS((CLIENT *Client, REQUEST *Req));
+GLOBAL bool IRC_QUIT PARAMS((CLIENT *Client, REQUEST *Req));
 
 #endif