]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/usermanager.h
Fix Doxygen syntax errors.
[user/henk/code/inspircd.git] / include / usermanager.h
index 6fdddf115abfe129b344901acf8532a5f0a4de2c..92b40b373ba6b595768f40180945e6c6b04bd6c5 100644 (file)
@@ -1,18 +1,24 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd 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, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __USERMANAGER_H
-#define __USERMANAGER_H
+
+#ifndef USERMANAGER_H
+#define USERMANAGER_H
 
 #include <list>
 
@@ -67,7 +73,6 @@ class CoreExport UserManager
        /** Add a client to the system.
         * This will create a new User, insert it into the user_hash,
         * initialize it as not yet registered, and add it to the socket engine.
-        * @param Instance a pointer to the server instance
         * @param socket The socket id (file descriptor) this user is on
         * @param via The socket that this user connected using
         * @param client The IP address and client port of the user
@@ -78,8 +83,8 @@ class CoreExport UserManager
 
        /** Disconnect a user gracefully
         * @param user The user to remove
-        * @param r The quit reason to show to normal users
-        * @param oreason The quit reason to show to opers
+        * @param quitreason The quit reason to show to normal users
+        * @param operreason The quit reason to show to opers
         * @return Although this function has no return type, on exit the user provided will no longer exist.
         */
        void QuitUser(User *user, const std::string &quitreason, const char* operreason = "");