Fix various documentation and formatting issues.

diff --git a/include/clientprotocolmsg.h b/include/clientprotocolmsg.h
index 0dbac1396f8125e486740c14285e4c3050152ec5..b828934d48df22c867480c9d83d71dbf3992a447 100644 (file)
--- a/include/clientprotocolmsg.h
+++ b/include/clientprotocolmsg.h
@@ -488,6 +488,7 @@ class ClientProtocol::Messages::Privmsg : public ClientProtocol::Message
         * @param target Target string.
         * @param text Privmsg text, will be copied.
         * @param mt Message type.
+        * @param status Prefix character for status messages. If non-zero the message is a status message. Optional, defaults to 0.
         */
        Privmsg(const std::string& source, const std::string& target, const std::string& text, MessageType mt = MSG_PRIVMSG, char status = 0)
                : ClientProtocol::Message(CommandStrFromMsgType(mt), source)

diff --git a/include/ctables.h b/include/ctables.h
index 22c0ef67eb60003abd24366295def4fbac10f599..2049738c97c586c0303b4cbac0db8f98ecff8f8f 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -203,7 +203,7 @@ class CoreExport Command : public CommandBase
         * @param maxpara The maximum number of parameters that the command accepts.
         */
        Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
-       
+
  public:
        /** Unregisters this command from the command parser. */
        ~Command() CXX11_OVERRIDE;
@@ -262,7 +262,7 @@ protected:
        SplitCommand(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
 
  public:
-       /** @copydoc Commmand::Handle */
+       /** @copydoc Command::Handle */
        CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
 
        /** Handle the command from a local user.

diff --git a/include/extensible.h b/include/extensible.h
index a9b3704056eb19c62c28bd94f1d5b2fe0b7631ef..6c31468848c2d6d85b656c0e8189956972acafdc 100644 (file)
--- a/include/extensible.h
+++ b/include/extensible.h
@@ -54,7 +54,7 @@ class CoreExport ExtensionItem : public ServiceProvider, public usecountbase
        /** Initializes an instance of the ExtensionItem class.
         * @param key The name of the extension item (e.g. ssl_cert).
         * @param exttype The type of Extensible that this ExtensionItem applies to.
-        * @param owner The module which created this ExtensionItem 
+        * @param owner The module which created this ExtensionItem.
         */
        ExtensionItem(const std::string& key, ExtensibleType exttype, Module* owner);
 
@@ -171,10 +171,10 @@ class CoreExport Extensible
         */
        void FreeAllExtItems();
 
-       /** @copydoc Serializable::Deserialize. */
+       /** @copydoc Serializable::Deserialize */
        bool Deserialize(Data& data) CXX11_OVERRIDE;
 
-       /** @copydoc Serializable::Deserialize. */
+       /** @copydoc Serializable::Deserialize */
        bool Serialize(Serializable::Data& data) CXX11_OVERRIDE;
 };
 

diff --git a/include/modules.h b/include/modules.h
index 5e0c9ab077cd58aca711e95c4cafa888c86623cf..e4e439f7c610df71dfd88dda387a9195562d5efb 100644 (file)
--- a/include/modules.h
+++ b/include/modules.h
@@ -950,7 +950,6 @@ class CoreExport Module : public classbase, public usecountbase
 
        /** Called before a server shuts down.
         * @param reason The reason the server is shutting down.
-        * @param restart Whether the server is restarting.
         */
        virtual void OnShutdown(const std::string& reason);
 };

diff --git a/include/modules/ctctags.h b/include/modules/ctctags.h
index 7946c124349248206a072a8308f32cfbce004d51..5f102b5d725e415f913abbf6894169c9831538c1 100644 (file)
--- a/include/modules/ctctags.h
+++ b/include/modules/ctctags.h
@@ -137,7 +137,7 @@ class CTCTags::EventListener
         *         message, or MOD_RES_PASSTHRU to let another module handle the event.
         */
        virtual ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, TagMessageDetails& details) { return MOD_RES_PASSTHRU; }
-       
+
        /** Called immediately after a user sends a tag message to a channel, a user, or a server glob mask.
         * @param user The user sending the message.
         * @param target The target of the message. This can either be a channel, a user, or a server

diff --git a/include/serialize.h b/include/serialize.h
index 544fe3252bb0c28faa8333e69de0786ed3da88a2..b6eb16934c8377f98ce07b12527a6270802cdfdf 100644 (file)
--- a/include/serialize.h
+++ b/include/serialize.h
@@ -82,19 +82,19 @@ class CoreExport Serializable
 
                /** Stores the serialised data against the specified key.
                 * @param key The key by which this serialised data should be stored against.
-                * @param out The serialised data to store.
+                * @param value The serialised data to store.
                 */
                Data& Store(const std::string& key, const Data& value);
 
                /** Stores the value against the specified key.
                 * @param key The key by which this value should be stored against.
-                * @param out The value to store.
+                * @param value The value to store.
                 */
                Data& Store(const std::string& key, const std::string& value);
 
                /** Stores the value against the specified key. The value will be converted to a string using ConvToStr.
                 * @param key The key by which this value should be stored against.
-                * @param out The value to store.
+                * @param value The value to store.
                 */
                template <typename T>
                Data& Store(const std::string& key, const T& value)

diff --git a/include/socket.h b/include/socket.h
index 4c8a7b16606c0155f264dbc54bdd02193b55a2c3..143c8f809bb561b368c4fdf11bd2a05b845d231f 100644 (file)
--- a/include/socket.h
+++ b/include/socket.h
@@ -143,7 +143,6 @@ namespace irc
 /** Represents information about a failed port binding. */
 struct CoreExport FailedPort
 {
-       
        /** The error which happened during binding. */
        int error;
 

diff --git a/include/users.h b/include/users.h
index c08be8c6fec737ce208953e28c79743cf35a2884..bae2615c251748106e814e0c57be32641163c7e4 100644 (file)
--- a/include/users.h
+++ b/include/users.h
@@ -692,10 +692,10 @@ class CoreExport User : public Extensible
        virtual ~User();
        CullResult cull() CXX11_OVERRIDE;
 
-       /** @copydoc Serializable::Deserialize. */
+       /** @copydoc Serializable::Deserialize */
        bool Deserialize(Data& data) CXX11_OVERRIDE;
 
-       /** @copydoc Serializable::Deserialize. */
+       /** @copydoc Serializable::Deserialize */
        bool Serialize(Serializable::Data& data) CXX11_OVERRIDE;
 };
 
@@ -896,10 +896,10 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
         */
        void Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg);
 
-       /** @copydoc Serializable::Deserialize. */
+       /** @copydoc Serializable::Deserialize */
        bool Deserialize(Data& data) CXX11_OVERRIDE;
 
-       /** @copydoc Serializable::Deserialize. */
+       /** @copydoc Serializable::Deserialize */
        bool Serialize(Serializable::Data& data) CXX11_OVERRIDE;
 };
 

diff --git a/src/base.cpp b/src/base.cpp
index d44fcf04878ec023bc19a27ba61705f8f3142c6f..1f9ba3264d46bfb9be29403f8c14ba56257d9026 100644 (file)
--- a/src/base.cpp
+++ b/src/base.cpp
@@ -299,7 +299,7 @@ LocalStringExt::~LocalStringExt()
 
 std::string LocalStringExt::ToInternal(const Extensible* container, void* item) const
 {
-       return item ? *static_cast<std::string*>(item) : std::string(); 
+       return item ? *static_cast<std::string*>(item) : std::string();
 }
 
 void LocalStringExt::FromInternal(Extensible* container, const std::string& value)

diff --git a/src/configparser.cpp b/src/configparser.cpp
index 4748fa847a2b7c249fee0bad3c435adc80ea8b54..94a12e6e9044e204e581e75c141c71c528a66801 100644 (file)
--- a/src/configparser.cpp
+++ b/src/configparser.cpp
@@ -431,7 +431,7 @@ void ParseStack::DoInclude(ConfigTag* tag, int flags)
                if (!FileSystem::GetFileList(includedir, files, "*.conf"))
                        throw CoreException("Unable to read directory for include: " + includedir);
 
-               std::sort(files.begin(), files.end()); 
+               std::sort(files.begin(), files.end());
                for (std::vector<std::string>::const_iterator iter = files.begin(); iter != files.end(); ++iter)
                {
                        const std::string path = includedir + '/' + *iter;

diff --git a/src/modules/extra/m_geo_maxmind.cpp b/src/modules/extra/m_geo_maxmind.cpp
index b03933344731b022cbbb2f392c2142ca28e8d8b1..0cf082775b911a7283bd5fee4a6c86e622540946 100644 (file)
--- a/src/modules/extra/m_geo_maxmind.cpp
+++ b/src/modules/extra/m_geo_maxmind.cpp
@@ -179,7 +179,7 @@ class ModuleGeoMaxMind : public Module
        void OnGarbageCollect() CXX11_OVERRIDE
        {
                for (LocationMap::iterator iter = geoapi.locations.begin(); iter != geoapi.locations.end(); )
-               {       
+               {
                        Geolocation::Location* location = iter->second;
                        if (location->GetUseCount())
                        {

diff --git a/src/modules/extra/m_regex_pcre.cpp b/src/modules/extra/m_regex_pcre.cpp
index a3824d9cd0856011da34ce750dcad930b18c059c..6a742dba5feea074579a3de43c7cc41e51a6770f 100644 (file)
--- a/src/modules/extra/m_regex_pcre.cpp
+++ b/src/modules/extra/m_regex_pcre.cpp
@@ -28,7 +28,7 @@
 
 /// $PackageInfo: require_system("arch") pcre
 /// $PackageInfo: require_system("centos") pcre-devel
-/// $PackageInfo: require_system("darwin") pcre 
+/// $PackageInfo: require_system("darwin") pcre
 /// $PackageInfo: require_system("debian") libpcre3-dev
 /// $PackageInfo: require_system("ubuntu") libpcre3-dev
 

diff --git a/src/modules/m_codepage.cpp b/src/modules/m_codepage.cpp
index 5858acd977bde4802e72a86fe633afe8e5aa6f59..1e0a248e06a9edfcfffb55fb3f16395a3724e662 100644 (file)
--- a/src/modules/m_codepage.cpp
+++ b/src/modules/m_codepage.cpp
@@ -133,7 +133,7 @@ class ModuleCodepage
                        unsigned char begin = tag->getUInt("begin", tag->getUInt("index", 0), 1, UCHAR_MAX);
                        if (!begin)
                                throw ModuleException("<cpchars> tag without index or begin specified at " + tag->getTagLocation());
-       
+
                        unsigned char end = tag->getUInt("end", begin, 1, UCHAR_MAX);
                        if (begin > end)
                                throw ModuleException("<cpchars:begin> must be lower than <cpchars:end> at " + tag->getTagLocation());

diff --git a/src/modules/m_delayjoin.cpp b/src/modules/m_delayjoin.cpp
index a33a2a1d2553190035ecb21ca0e531d36de0150e..8eff602d822a0e6eaf53b9fd8b4ee07b270b741c 100644 (file)
--- a/src/modules/m_delayjoin.cpp
+++ b/src/modules/m_delayjoin.cpp
@@ -78,7 +78,7 @@ class JoinHook : public ClientProtocol::EventHook
 
 }
 
-class ModuleDelayJoin 
+class ModuleDelayJoin
        : public Module
        , public CTCTags::EventListener
        , public Names::EventListener

diff --git a/src/modules/m_ident.cpp b/src/modules/m_ident.cpp
index 15e46b83af92870940efc40982213814c13b8ebd..c22c6a0390e7584e68363b129761e184f01082c2 100644 (file)
--- a/src/modules/m_ident.cpp
+++ b/src/modules/m_ident.cpp
@@ -284,7 +284,7 @@ class ModuleIdent : public Module
                // Check that they haven't been prefixed already.
                if (user->ident[0] == '~')
                        return;
-               
+
                // All invalid usernames are prefixed with a tilde.
                std::string newident(user->ident);
                newident.insert(newident.begin(), '~');

diff --git a/src/modules/m_ircv3_ctctags.cpp b/src/modules/m_ircv3_ctctags.cpp
index 1bb803bc29c2a6a3b36ee7bc926dae93c88923ac..6123d3b31ebe320d8e2bf83d89887422a1517408 100644 (file)
--- a/src/modules/m_ircv3_ctctags.cpp
+++ b/src/modules/m_ircv3_ctctags.cpp
@@ -89,7 +89,7 @@ class CommandTagMsg : public Command
                {
                        LocalUser* luser = IS_LOCAL(iter->first);
 
-                       // Don't send to remote users or the user who is the source. 
+                       // Don't send to remote users or the user who is the source.
                        if (!luser || luser == source)
                                continue;
 

diff --git a/src/modules/m_spanningtree/main.cpp b/src/modules/m_spanningtree/main.cpp
index 5e6e9b0369b7a8733972dbf79e7cc18240f42f83..b688aed9f82fa0b290561aa641796d31cc3e4234 100644 (file)
--- a/src/modules/m_spanningtree/main.cpp
+++ b/src/modules/m_spanningtree/main.cpp
@@ -215,7 +215,7 @@ void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
                // If this fails then the IP sa will be AF_UNSPEC.
                irc::sockets::aptosa(x->IPAddr, x->Port, sa);
        }
-       
+
        /* Do we already have an IP? If so, no need to resolve it. */
        if (sa.family() != AF_UNSPEC)
        {

diff --git a/src/users.cpp b/src/users.cpp
index 2571d15f2590f78da83ce8dd64c7ebce86dce859..0f1ee74660968c2abb73dae51619dc9eb3d34c4b 100644 (file)
--- a/src/users.cpp
+++ b/src/users.cpp
@@ -91,7 +91,7 @@ User::User(const std::string& uid, Server* srv, UserType type)
        ServerInstance->Logs->Log("USERS", LOG_DEBUG, "New UUID for user: %s", uuid.c_str());
 
        if (srv->IsULine())
-               ServerInstance->Users.all_ulines.push_back(this);       
+               ServerInstance->Users.all_ulines.push_back(this);
 
        // Do not insert FakeUsers into the uuidlist so FindUUID() won't return them which is the desired behavior
        if (type != USERTYPE_SERVER)