Module description updates

conf/inspircd.conf.example

@@ -704,7 +704,7 @@
 #
 # An example log tag would be:
 #  <log method="file" type="OPER" level="default" target="opers.log">
-# which  would log all information on /oper (failed and successful) to
+# which would log all information on /oper (failed and successful) to
 # a file called opers.log.
 #
 # There are many different types which may be used, and modules may

conf/links.conf.example

@@ -11,9 +11,7 @@
 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
 #                                                                     #
 #  If you want to link servers to InspIRCd you must load the          #
-#  m_spanningtree.so module! Please see the modules list below for    #
-#  information on how to load this module! If you do not load this    #
-#  module, server links will NOT work!                                #
+#  m_spanningtree.so module!                                          #
 #                                                                     #
 #                                                                     #
 

conf/modules.conf.example

@@ -592,8 +592,8 @@
 #  quitmsg           -  The message that users get if they attempt to
 #                       connect while the throttle is active.
 #
-#  bootwait          -  Amount of time to wait before enforcing the
-#                       throttling when the server just booted.
+#  bootwait          -  Amount of time in seconds to wait before enforcing
+#                       the throttling when the server just booted.
 #
 #<connflood seconds="30" maxconns="3" timeout="30"
 #   quitmsg="Throttled" bootwait="10">
@@ -1505,8 +1505,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

@@ -19,6 +19,8 @@
  */
 
 
+/* $ModDesc: Provides user and channel +G mode */
+
 #define _CRT_SECURE_NO_DEPRECATE
 #define _SCL_SECURE_NO_DEPRECATE
 
@@ -27,8 +29,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
 {

src/modules/m_chanfilter.cpp

@@ -22,15 +22,15 @@
  */
 
 
+/* $ModDesc: Provides channel-specific censor lists (like mode +G but varies from channel to channel) */
+/* $ModDep: ../../include/u_listmode.h */
+
 #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) */
-/* $ModDep: ../../include/u_listmode.h */
-
 /** 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
  */

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
 {
@@ -45,7 +45,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");

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
 {

src/modules/m_dccallow.cpp

@@ -24,7 +24,7 @@
 
 #include "inspircd.h"
 
-/* $ModDesc: Povides support for the /DCCALLOW command */
+/* $ModDesc: Provides support for the /DCCALLOW command */
 
 static ConfigReader *Conf;
 

src/modules/m_delayjoin.cpp

@@ -19,6 +19,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
 	void WriteCommonFrom(User *user, Channel* channel, const char* text, ...) CUSTOM_PRINTF(4, 5);
 };
 
-/* $ModDesc: Allows for delay-join channels (+D) where users dont appear to join until they speak */
-
 ModeAction DelayJoinMode::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
 {
 	/* no change */
@@ -249,4 +249,3 @@ void ModuleDelayJoin::WriteCommonFrom(User *user, Channel* channel, const char*
 }
 
 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
  */

src/modules/m_helpop.cpp

@@ -20,9 +20,10 @@
  */
 
 
+/* $ModDesc: Provides the /HELPOP command, works like UnrealIRCd's helpop */
+
 #include "inspircd.h"
 
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
 static std::map<irc::string, std::string> helpop_map;
 
 

src/modules/m_httpd_config.cpp

@@ -21,7 +21,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 */
 /* $ModDep: httpd.h */
 
 class ModuleHttpStats : public Module

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
  */

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
  */

src/modules/m_operinvex.cpp

@@ -21,7 +21,6 @@
 #include "u_listmode.h"
 
 /* $ModDep: ../../include/u_listmode.h */
-
 /* $ModDesc: Implements extban/invex +I O: - opertype bans */
 
 class ModuleOperInvex : public Module

src/modules/m_operlevels.cpp

@@ -19,9 +19,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
 {
 	private:

src/modules/m_randquote.cpp

@@ -28,7 +28,7 @@ std::string q_file;
 std::string prefix;
 std::string suffix;
 
-/* $ModDesc: Provides random Quotes on Connect. */
+/* $ModDesc: Provides random quotes on connect. */
 
 /** Handle /RANDQUOTE
  */

src/modules/m_rline.cpp

@@ -19,6 +19,8 @@
  */
 
 
+/* $ModDesc: RLINE: Regexp user banning. */
+
 #include "inspircd.h"
 #include "m_regex.h"
 #include "xline.h"
@@ -26,8 +28,6 @@
 static Module* rxengine = NULL;
 static Module* mymodule = NULL; /* Needed to let RLine send request! */
 
-/* $ModDesc: RLINE: Regexp user banning. */
-
 class RLine : public XLine
 {
  public:

src/modules/m_safelist.cpp

@@ -19,6 +19,8 @@
  */
 
 
+/* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
+
 #include "inspircd.h"
 
 /** Holds a users m_safelist state
@@ -37,8 +39,6 @@ class ListData : public classbase
 	ListData(long pos, time_t t, const std::string &pattern, int mi, int ma) : list_start(t), list_position(pos), list_ended(false), glob(pattern), minusers(mi), maxusers(ma) {};
 };
 
-/* $ModDesc: A module overriding /list, and making it safe - stop those sendq problems. */
-
 class ModuleSafeList : public Module
 {
 	time_t ThrottleSecs;

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,12 +21,12 @@
  */
 
 
+/* $ModDesc: Provides support for ircu-style services accounts, including chmode +R, etc. */
+
 #include "inspircd.h"
 #include "account.h"
 #include "u_listmode.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

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
 {