Merge pull request #545 from SaberUK/master+logging-cleanup

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

diff --git a/include/xline.h b/include/xline.h
index bde3d3fda7e4b93b39e2df5c4eea5ac372091885..5403a0933f7b117cc8cffcfdc5c5ea7d4bcf0a18 100644 (file)
--- a/include/xline.h
+++ b/include/xline.h
@@ -20,8 +20,7 @@
  */
 
 
-#ifndef XLINE_H
-#define XLINE_H
+#pragma once
 
 /** XLine is the base class for ban lines such as G lines and K lines.
  * Modules may derive from this, and their xlines will automatically be
@@ -101,16 +100,16 @@ class CoreExport XLine : public classbase
         * line. Usually a line in the form 'expiring Xline blah, set by...'
         * see the DisplayExpiry methods of GLine, ELine etc.
         */
-       virtual void DisplayExpiry() = 0;
+       virtual void DisplayExpiry();
 
        /** 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
-        * for its Displayable() method)
+        * ident and host parts seperately but will still return ident\@host
+        * for its Displayable() method).
         */
-       virtual const char* Displayable() = 0;
+       virtual const std::string& Displayable() = 0;
 
        /** Called when the xline has just been added.
         */
@@ -177,9 +176,7 @@ class CoreExport KLine : public XLine
 
        virtual void Apply(User* u);
 
-       virtual void DisplayExpiry();
-
-       virtual const char* Displayable();
+       virtual const std::string& Displayable();
 
        virtual bool IsBurstable();
 
@@ -225,9 +222,7 @@ class CoreExport GLine : public XLine
 
        virtual void Apply(User* u);
 
-       virtual void DisplayExpiry();
-
-       virtual const char* Displayable();
+       virtual const std::string& Displayable();
 
        /** Ident mask (ident part only)
         */
@@ -269,11 +264,9 @@ class CoreExport ELine : public XLine
 
        virtual void Unset();
 
-       virtual void DisplayExpiry();
-
        virtual void OnAdd();
 
-       virtual const char* Displayable();
+       virtual const std::string& Displayable();
 
        /** Ident mask (ident part only)
         */
@@ -314,9 +307,7 @@ class CoreExport ZLine : public XLine
 
        virtual void Apply(User* u);
 
-       virtual void DisplayExpiry();
-
-       virtual const char* Displayable();
+       virtual const std::string& Displayable();
 
        /** IP mask (no ident part)
         */
@@ -351,9 +342,7 @@ class CoreExport QLine : public XLine
 
        virtual void Apply(User* u);
 
-       virtual void DisplayExpiry();
-
-       virtual const char* Displayable();
+       virtual const std::string& Displayable();
 
        /** Nickname mask
         */
@@ -376,7 +365,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) { }
@@ -428,7 +416,6 @@ class CoreExport XLineManager
  public:
 
        /** Constructor
-        * @param Instance A pointer to the creator object
         */
        XLineManager();
 
@@ -448,7 +435,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);
@@ -531,6 +518,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
@@ -538,4 +526,3 @@ class CoreExport XLineManager
        void InvokeStats(const std::string &type, int numeric, User* user, string_list &results);
 };
 
-#endif