Merge pull request #1018 from SaberUK/insp20+hidekills

[user/henk/code/inspircd.git] / include / xline.h

diff --git a/include/xline.h b/include/xline.h
index f7495847f480240640cfaee7335efc6fc87191ea..2a49d8b80efe1c49230137a847a4838a049485be 100644 (file)
--- a/include/xline.h
+++ b/include/xline.h
@@ -1,16 +1,25 @@
-/*       +------------------------------------+
- *       | 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) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2004-2007 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- * 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 XLINE_H
 #define XLINE_H
 
@@ -95,10 +104,10 @@ class CoreExport XLine : public classbase
        virtual void DisplayExpiry() = 0;
 
        /** Returns the displayable form of the pattern for this xline,
-        * e.g. '*@foo' or '*baz*'. This must always return the full pattern
+        * e.g. '*\@foo' or '*baz*'. This must always return the full pattern
         * in a form which can be used to construct an entire derived xline,
         * even if it is stored differently internally (e.g. GLine stores the
-        * ident and host parts seperately but will still return ident@host
+        * ident and host parts seperately but will still return ident\@host
         * for its Displayable() method)
         */
        virtual const char* Displayable() = 0;
@@ -367,7 +376,6 @@ class CoreExport XLineFactory
  public:
 
        /** Create an XLine factory
-        * @param Instance creator
         * @param t Type of XLine this factory generates
         */
        XLineFactory(const std::string &t) : type(t) { }
@@ -419,7 +427,6 @@ class CoreExport XLineManager
  public:
 
        /** Constructor
-        * @param Instance A pointer to the creator object
         */
        XLineManager();
 
@@ -439,7 +446,7 @@ class CoreExport XLineManager
        /** Get all lines of a certain type to an XLineLookup (std::map<std::string, XLine*>).
         * NOTE: When this function runs any expired items are removed from the list before it
         * is returned to the caller.
-        * @param The type to look up
+        * @param type The type to look up
         * @return A list of all XLines of the given type.
         */
        XLineLookup* GetAll(const std::string &type);
@@ -522,6 +529,7 @@ class CoreExport XLineManager
        /** Handle /STATS for a given type.
         * NOTE: Any items in the list for this particular line type which have expired
         * will be expired and removed before the list is displayed.
+        * @param type The type of stats to show
         * @param numeric The numeric to give to each result line
         * @param user The username making the query
         * @param results The string_list to receive the results