From f2e3fd5952b23209b084bde4f464e6643c8a00ff Mon Sep 17 00:00:00 2001
From: Matt Schatz <genius3000@g3k.solutions>
Date: Tue, 8 Jan 2019 03:03:53 -0700
Subject: Improve X-line text consistency.

- Change any "-Line", ":Line", or "*line" to "-line" throughout
the X-line code, comments, and documentation.
- Add periods to the end of some notices.
- Correct a typo in the Q-line code comments.
- Update the filter module documentation (shun addition).

Co-authored-by: Robby <robby@chatbelgie.be>
---
 include/bancache.h     |  2 +-
 include/configreader.h |  4 ++--
 include/inspircd.h     |  2 +-
 include/users.h        |  8 ++++----
 include/xline.h        | 24 ++++++++++++------------
 5 files changed, 20 insertions(+), 20 deletions(-)

(limited to 'include')

diff --git a/include/bancache.h b/include/bancache.h
index 6e19e1ebe..e0c84ab54 100644
--- a/include/bancache.h
+++ b/include/bancache.h
@@ -62,7 +62,7 @@ class CoreExport BanCacheManager
 	 * @param ip The IP the item is for.
 	 * @param type The type of ban cache item. std::string. .empty() means it's a negative match (user is allowed freely).
 	 * @param reason The reason for the ban. Left .empty() if it's a negative match.
-	 * @param seconds Number of seconds before nuking the bancache entry, the default is a day. This might seem long, but entries will be removed as glines/etc expire.
+	 * @param seconds Number of seconds before nuking the bancache entry, the default is a day. This might seem long, but entries will be removed as G-lines/etc expire.
 	 */
 	BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds = 0);
 	BanCacheHit *GetHit(const std::string &ip);
diff --git a/include/configreader.h b/include/configreader.h
index 4360b8661..fd9401c0f 100644
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -379,8 +379,8 @@ class CoreExport ServerConfig
 	/** The number of seconds that the server clock can skip by before server operators are warned. */
 	time_t TimeSkipWarn;
 
-	/** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
-	 * K-Lines, Z-Lines)
+	/** True if we're going to hide ban reasons for non-opers (e.g. G-lines,
+	 * K-lines, Z-lines)
 	 */
 	bool HideBans;
 
diff --git a/include/inspircd.h b/include/inspircd.h
index 8ca2314eb..f5c7dbafb 100644
--- a/include/inspircd.h
+++ b/include/inspircd.h
@@ -284,7 +284,7 @@ class CoreExport InspIRCd
 	 */
 	TimerManager Timers;
 
-	/** X-Line manager. Handles G/K/Q/E line setting, removal and matching
+	/** X-line manager. Handles G/K/Q/E-line setting, removal and matching
 	 */
 	XLineManager* XLines;
 
diff --git a/include/users.h b/include/users.h
index ef19adb5d..469c17124 100644
--- a/include/users.h
+++ b/include/users.h
@@ -784,7 +784,7 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
 	 */
 	unsigned int lastping:1;
 
-	/** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
+	/** This is true if the user matched an exception (E-line). It is used to save time on ban checks.
 	 */
 	unsigned int exempt:1;
 
@@ -803,14 +803,14 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
 
 	already_sent_t already_sent;
 
-	/** Check if the user matches a G or K line, and disconnect them if they do.
-	 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
+	/** Check if the user matches a G- or K-line, and disconnect them if they do.
+	 * @param doZline True if Z-lines should be checked (if IP has changed since initial connect)
 	 * Returns true if the user matched a ban, false else.
 	 */
 	bool CheckLines(bool doZline = false);
 
 	/** Use this method to fully connect a user.
-	 * This will send the message of the day, check G/K/E lines, etc.
+	 * This will send the message of the day, check G/K/E-lines, etc.
 	 */
 	void FullConnect();
 
diff --git a/include/xline.h b/include/xline.h
index 44f16cadf..dbb89277b 100644
--- a/include/xline.h
+++ b/include/xline.h
@@ -22,7 +22,7 @@
 
 #pragma once
 
-/** XLine is the base class for ban lines such as G lines and K lines.
+/** 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
  * handled as expected by any protocol modules (e.g. m_spanningtree will
  * propogate them using AddLine). The process of translating a type+pattern
@@ -67,7 +67,7 @@ class CoreExport XLine : public classbase
 	}
 
 	/** Change creation time of an xline. Updates expiry
-	 * to be after the creation time
+	 * to be after the creation time.
 	 */
 	virtual void SetCreateTime(time_t created)
 	{
@@ -102,7 +102,7 @@ class CoreExport XLine : public classbase
 	virtual void Unset() { }
 
 	/** Called when the expiry message is to be displayed for the
-	 * line. Usually a line in the form 'expiring Xline blah, set by...'
+	 * line. Usually a line in the form 'expiring X-line blah, set by...'
 	 * see the DisplayExpiry methods of GLine, ELine etc.
 	 */
 	virtual void DisplayExpiry();
@@ -111,7 +111,7 @@ class CoreExport XLine : public classbase
 	 * 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 separately but will still return ident\@host
 	 * for its Displayable() method).
 	 */
 	virtual const std::string& Displayable() = 0;
@@ -157,7 +157,7 @@ class CoreExport KLine : public XLine
 {
   public:
 
-	/** Create a K-Line.
+	/** Create a K-line.
 	 * @param s_time The set time
 	 * @param d The duration of the xline
 	 * @param src The sender of the xline
@@ -203,7 +203,7 @@ class CoreExport KLine : public XLine
 class CoreExport GLine : public XLine
 {
   public:
-	/** Create a G-Line.
+	/** Create a G-line.
 	 * @param s_time The set time
 	 * @param d The duration of the xline
 	 * @param src The sender of the xline
@@ -247,7 +247,7 @@ class CoreExport GLine : public XLine
 class CoreExport ELine : public XLine
 {
   public:
-	/** Create an E-Line.
+	/** Create an E-line.
 	 * @param s_time The set time
 	 * @param d The duration of the xline
 	 * @param src The sender of the xline
@@ -291,7 +291,7 @@ class CoreExport ELine : public XLine
 class CoreExport ZLine : public XLine
 {
   public:
-	/** Create a Z-Line.
+	/** Create a Z-line.
 	 * @param s_time The set time
 	 * @param d The duration of the xline
 	 * @param src The sender of the xline
@@ -327,7 +327,7 @@ class CoreExport ZLine : public XLine
 class CoreExport QLine : public XLine
 {
   public:
-	/** Create a G-Line.
+	/** Create a Q-line.
 	 * @param s_time The set time
 	 * @param d The duration of the xline
 	 * @param src The sender of the xline
@@ -399,7 +399,7 @@ class CoreExport XLineFactory
 	virtual ~XLineFactory() { }
 };
 
-/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines,
+/** XLineManager is a class used to manage G-lines, K-lines, E-lines, Z-lines and Q-lines,
  * or any other line created by a module. It also manages XLineFactory classes which
  * can generate a specialized XLine for use by another module.
  */
@@ -436,7 +436,7 @@ class CoreExport XLineManager
 	 */
 	IdentHostPair IdentSplit(const std::string &ident_and_host);
 
-	/** Checks what users match e:lines and sets their ban exempt flag accordingly.
+	/** Checks what users match E-lines and sets their ban exempt flag accordingly.
 	 */
 	void CheckELines();
 
@@ -476,7 +476,7 @@ class CoreExport XLineManager
 	/** Registers an xline factory.
 	 * An xline factory is a class which when given a particular xline type,
 	 * will generate a new XLine specialized to that type. For example if you
-	 * pass the XLineFactory that handles glines some data it will return a
+	 * pass the XLineFactory that handles G-lines some data it will return a
 	 * pointer to a GLine, polymorphically represented as XLine. This is used where
 	 * you do not know the full details of the item you wish to create, e.g. in a
 	 * server protocol module like m_spanningtree, when you receive xlines from other
-- 
cgit v1.2.3