Merge pull request #173 from Robby-/insp20-moddesc

[2.0] Module description updates

docs/modules.conf.example

@@ -1568,8 +1568,8 @@
 # showfromopers="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Shun module: Provides the /shun command, which stops a user executing 
-# most commands.
+# Shun module: Provides the /SHUN command, which stops a user from
+# executing all except configured commands.
 # This module is oper-only.
 # To use, SHUN must be in one of your oper class blocks.
 #<module name="m_shun.so">

src/modules/m_censor.cpp

@@ -20,6 +20,8 @@
  */
 
 
+/* $ModDesc: Provides user and channel +G mode */
+
 #define _CRT_SECURE_NO_DEPRECATE
 #define _SCL_SECURE_NO_DEPRECATE
 
@@ -28,8 +30,6 @@
 
 typedef std::map<irc::string,irc::string> censor_t;
 
-/* $ModDesc: Provides user and channel +G mode */
-
 /** Handles usermode +G
  */
 class CensorUser : public SimpleUserModeHandler

src/modules/m_chancreate.cpp

@@ -21,7 +21,7 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Creates a snomask with notices whenever a new channel is created */
+/* $ModDesc: Provides snomasks 'j' and 'J', to which notices about newly created channels are sent */
 
 class ModuleChanCreate : public Module
 {
@@ -36,7 +36,7 @@ class ModuleChanCreate : public Module
 
 	Version GetVersion()
 	{
-		return Version("Creates a snomask with notices whenever a new channel is created",VF_VENDOR);
+		return Version("Provides snomasks 'j' and 'J', to which notices about newly created channels are sent",VF_VENDOR);
 	}
 
 

src/modules/m_chanfilter.cpp

@@ -23,14 +23,14 @@
  */
 
 
+/* $ModDesc: Provides channel-specific censor lists (like mode +G but varies from channel to channel) */
+
 #define _CRT_SECURE_NO_DEPRECATE
 #define _SCL_SECURE_NO_DEPRECATE
 
 #include "inspircd.h"
 #include "u_listmode.h"
 
-/* $ModDesc: Provides channel-specific censor lists (like mode +G but varies from channel to channel) */
-
 /** Handles channel mode +g
  */
 class ChanFilter : public ListModeBase

src/modules/m_check.cpp

@@ -20,9 +20,9 @@
  */
 
 
-#include "inspircd.h"
+/* $ModDesc: Provides the /CHECK command to retrieve information on a user, channel, hostname or IP address */
 
-/* $ModDesc: Provides the /check command to retrieve information on a user, channel, or IP address */
+#include "inspircd.h"
 
 /** Handle /CHECK
  */
@@ -288,7 +288,7 @@ class ModuleCheck : public Module
 
 	Version GetVersion()
 	{
-		return Version("CHECK command, view user/channel details", VF_VENDOR|VF_OPTCOMMON);
+		return Version("CHECK command, view user, channel, IP address or hostname information", VF_VENDOR|VF_OPTCOMMON);
 	}
 };
 

src/modules/m_clones.cpp

@@ -21,9 +21,9 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Provides the /clones command to retrieve information on clones. */
+/* $ModDesc: Provides the /CLONES command to retrieve information on clones. */
 
-/** Handle /CHECK
+/** Handle /CLONES
  */
 class CommandClones : public Command
 {
@@ -44,7 +44,7 @@ class CommandClones : public Command
 		 * Syntax of a /clones reply:
 		 *  :server.name 304 target :CLONES START
 		 *  :server.name 304 target :CLONES <count> <ip>
-		 *  :server.name 304 target :CHECK END
+		 *  :server.name 304 target :CLONES END
 		 */
 
 		user->WriteServ(clonesstr + " START");
@@ -80,7 +80,7 @@ class ModuleClones : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides the /clones command to retrieve information on clones.", VF_VENDOR);
+		return Version("Provides the /CLONES command to retrieve information on clones.", VF_VENDOR);
 	}
 
 

src/modules/m_connectban.cpp

@@ -20,7 +20,7 @@
 #include "inspircd.h"
 #include "xline.h"
 
-/* $ModDesc: Throttles the connections of any users who try connect flood */
+/* $ModDesc: Throttles the connections of IP ranges who try to connect flood. */
 
 class ModuleConnectBan : public Module
 {
@@ -43,7 +43,7 @@ class ModuleConnectBan : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Throttles the connections of any users who try connect flood", VF_VENDOR);
+		return Version("Throttles the connections of IP ranges who try to connect flood.", VF_VENDOR);
 	}
 
 	virtual void OnRehash(User* user)

src/modules/m_dccallow.cpp

@@ -25,7 +25,7 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Povides support for the /DCCALLOW command */
+/* $ModDesc: Provides support for the /DCCALLOW command */
 
 class BannedFileList
 {
@@ -479,7 +479,7 @@ class ModuleDCCAllow : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Povides support for the /DCCALLOW command", VF_COMMON | VF_VENDOR);
+		return Version("Provides support for the /DCCALLOW command", VF_COMMON | VF_VENDOR);
 	}
 };
 

src/modules/m_delayjoin.cpp

@@ -20,6 +20,8 @@
  */
 
 
+/* $ModDesc: Allows for delay-join channels (+D) where users don't appear to join until they speak */
+
 #include "inspircd.h"
 #include <stdarg.h>
 
@@ -60,8 +62,6 @@ class ModuleDelayJoin : public Module
 	ModResult OnRawMode(User* user, Channel* channel, const char mode, const std::string &param, bool adding, int pcnt);
 };
 
-/* $ModDesc: Allows for delay-join channels (+D) where users don't appear to join until they speak */
-
 ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
 {
 	/* no change */
@@ -194,4 +194,3 @@ ModResult ModuleDelayJoin::OnRawMode(User* user, Channel* channel, const char mo
 }
 
 MODULE_INIT(ModuleDelayJoin)
-

src/modules/m_globops.cpp

@@ -19,11 +19,11 @@
  */
 
 
-// Globops and +g support module by C.J.Edwards
+// Globops and snomask +g module by C.J.Edwards
 
 #include "inspircd.h"
 
-/* $ModDesc: Provides support for GLOBOPS and user mode +g */
+/* $ModDesc: Provides support for GLOBOPS and snomask +g */
 
 /** Handle /GLOBOPS
  */
@@ -63,7 +63,7 @@ class ModuleGlobops : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides support for GLOBOPS and user mode +g", VF_VENDOR);
+		return Version("Provides support for GLOBOPS and snomask +g", VF_VENDOR);
 	}
 
 };

src/modules/m_halfop.cpp

@@ -17,6 +17,8 @@
  */
 
 
+/* $ModDesc: Channel half-operator mode provider */
+
 #include "inspircd.h"
 
 class ModeChannelHalfOp : public ModeHandler

src/modules/m_helpop.cpp

@@ -21,6 +21,8 @@
  */
 
 
+/* $ModDesc: Provides the /HELPOP command, works like UnrealIRCd's helpop */
+
 #include "inspircd.h"
 
 static std::map<irc::string, std::string> helpop_map;

src/modules/m_httpd_config.cpp

@@ -22,7 +22,7 @@
 #include "httpd.h"
 #include "protocol.h"
 
-/* $ModDesc: Provides statistics over HTTP via m_httpd.so */
+/* $ModDesc: Allows for the server configuration to be viewed over HTTP via m_httpd.so */
 
 class ModuleHttpConfig : public Module
 {
@@ -107,7 +107,7 @@ class ModuleHttpConfig : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides configuration over HTTP via m_httpd.so", VF_VENDOR);
+		return Version("Allows for the server configuration to be viewed over HTTP via m_httpd.so", VF_VENDOR);
 	}
 };
 

src/modules/m_jumpserver.cpp

@@ -21,7 +21,7 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Provides support for the RPL_REDIR numeric */
+/* $ModDesc: Provides support for the RPL_REDIR numeric and the /JUMPSERVER command. */
 
 /** Handle /JUMPSERVER
  */
@@ -174,7 +174,7 @@ class ModuleJumpServer : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides support for the RPL_REDIR numeric", VF_VENDOR);
+		return Version("Provides support for the RPL_REDIR numeric and the /JUMPSERVER command.", VF_VENDOR);
 	}
 
 };

src/modules/m_knock.cpp

@@ -21,7 +21,7 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Provides support for /KNOCK and mode +K */
+/* $ModDesc: Provides support for /KNOCK and channel mode +K */
 
 /** Handles the /KNOCK command
  */
@@ -109,7 +109,7 @@ class ModuleKnock : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides support for /KNOCK and mode +K", VF_OPTCOMMON | VF_VENDOR);
+		return Version("Provides support for /KNOCK and channel mode +K", VF_OPTCOMMON | VF_VENDOR);
 	}
 };
 

src/modules/m_mlock.cpp

@@ -16,6 +16,9 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
+/* $ModDesc: Implements the ability to have server-side MLOCK enforcement. */
+
 #include "inspircd.h"
 
 class ModuleMLock : public Module

src/modules/m_namedmodes.cpp

@@ -17,6 +17,8 @@
  */
 
 
+/* $ModDesc: Provides the ability to manipulate modes via long names. */
+
 #include "inspircd.h"
 
 static void DisplayList(User* user, Channel* channel)

src/modules/m_operlevels.cpp

@@ -20,9 +20,10 @@
  */
 
 
+/* $ModDesc: Gives each oper type a 'level', cannot kill opers 'above' your level. */
+
 #include "inspircd.h"
 
-/* $ModDesc: Gives each oper type a 'level', cannot kill opers 'above' your level. */
 class ModuleOperLevels : public Module
 {
 	public:

src/modules/m_passforward.cpp

@@ -17,6 +17,8 @@
  */
 
 
+/* $ModDesc: Forwards a password users can send on connect (for example for NickServ identification). */
+
 #include "inspircd.h"
 
 class ModulePassForward : public Module
@@ -100,4 +102,3 @@ class ModulePassForward : public Module
 };
 
 MODULE_INIT(ModulePassForward)
-

src/modules/m_randquote.cpp

@@ -21,6 +21,8 @@
  */
 
 
+/* $ModDesc: Provides random quotes on connect. */
+
 #include "inspircd.h"
 
 static FileReader *quotes = NULL;
@@ -28,8 +30,6 @@ static FileReader *quotes = NULL;
 std::string prefix;
 std::string suffix;
 
-/* $ModDesc: Provides random Quotes on Connect. */
-
 /** Handle /RANDQUOTE
  */
 class CommandRandquote : public Command
@@ -88,7 +88,7 @@ class ModuleRandQuote : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides random Quotes on Connect.",VF_VENDOR);
+		return Version("Provides random quotes on connect.",VF_VENDOR);
 	}
 
 	virtual void OnUserConnect(LocalUser* user)

src/modules/m_rline.cpp

@@ -20,6 +20,8 @@
  */
 
 
+/* $ModDesc: RLINE: Regexp user banning. */
+
 #include "inspircd.h"
 #include "m_regex.h"
 #include "xline.h"
@@ -27,8 +29,6 @@
 static bool ZlineOnMatch = false;
 static std::vector<ZLine *> background_zlines;
 
-/* $ModDesc: RLINE: Regexp user banning. */
-
 class RLine : public XLine
 {
  public:
@@ -316,4 +316,3 @@ class ModuleRLine : public Module
 };
 
 MODULE_INIT(ModuleRLine)
-

src/modules/m_seenicks.cpp

@@ -21,7 +21,7 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Provides support for seeing local and remote nickchanges via snomasks */
+/* $ModDesc: Provides support for seeing local and remote nickchanges via snomasks 'n' and 'N'. */
 
 class ModuleSeeNicks : public Module
 {

src/modules/m_services_account.cpp

@@ -21,11 +21,11 @@
  */
 
 
+/* $ModDesc: Provides support for ircu-style services accounts, including chmode +R, etc. */
+
 #include "inspircd.h"
 #include "account.h"
 
-/* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
-
 /** Channel mode +r - mark a channel as identified
  */
 class Channel_r : public ModeHandler
@@ -289,7 +289,7 @@ class ModuleServicesAccount : public Module
 
 	Version GetVersion()
 	{
-		return Version("Povides support for ircu-style services accounts, including chmode +R, etc.",VF_OPTCOMMON|VF_VENDOR);
+		return Version("Provides support for ircu-style services accounts, including chmode +R, etc.",VF_OPTCOMMON|VF_VENDOR);
 	}
 };
 

src/modules/m_shun.cpp

@@ -23,7 +23,7 @@
 #include "inspircd.h"
 #include "xline.h"
 
-/* $ModDesc: Provides the /shun command, which stops a user executing all commands except PING and PONG. */
+/* $ModDesc: Provides the /SHUN command, which stops a user from executing all except configured commands. */
 
 class Shun : public XLine
 {
@@ -308,7 +308,7 @@ class ModuleShun : public Module
 
 	virtual Version GetVersion()
 	{
-		return Version("Provides the /shun command, which stops a user executing all commands except PING and PONG.",VF_VENDOR|VF_COMMON);
+		return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
 	}
 };