From 9ebda853f5bc470858501897442610699a5fd5de Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Mon, 30 Mar 2020 17:24:12 +0100 Subject: Fix various documentation and formatting issues. --- include/clientprotocolmsg.h | 1 + include/ctables.h | 4 ++-- include/extensible.h | 6 +++--- include/modules.h | 1 - include/modules/ctctags.h | 2 +- include/serialize.h | 6 +++--- include/socket.h | 1 - include/users.h | 8 ++++---- src/base.cpp | 2 +- src/configparser.cpp | 2 +- src/modules/extra/m_geo_maxmind.cpp | 2 +- src/modules/extra/m_regex_pcre.cpp | 2 +- src/modules/m_codepage.cpp | 2 +- src/modules/m_delayjoin.cpp | 2 +- src/modules/m_ident.cpp | 2 +- src/modules/m_ircv3_ctctags.cpp | 2 +- src/modules/m_spanningtree/main.cpp | 2 +- src/users.cpp | 2 +- 18 files changed, 24 insertions(+), 25 deletions(-) diff --git a/include/clientprotocolmsg.h b/include/clientprotocolmsg.h index 0dbac1396..b828934d4 100644 --- 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 22c0ef67e..2049738c9 100644 --- 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 a9b370405..6c3146884 100644 --- 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 5e0c9ab07..e4e439f7c 100644 --- 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 7946c1243..5f102b5d7 100644 --- 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 544fe3252..b6eb16934 100644 --- 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 Data& Store(const std::string& key, const T& value) diff --git a/include/socket.h b/include/socket.h index 4c8a7b166..143c8f809 100644 --- 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 c08be8c6f..bae2615c2 100644 --- 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(item) : std::string(); + return item ? *static_cast(item) : std::string(); } void LocalStringExt::FromInternal(Extensible* container, const std::string& value) diff --git a/src/configparser.cpp b/src/configparser.cpp index 4748fa847..94a12e6e9 100644 --- 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::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 b03933344..0cf082775 100644 --- 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 a3824d9cd..6a742dba5 100644 --- 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 5858acd97..1e0a248e0 100644 --- 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(" tag without index or begin specified at " + tag->getTagLocation()); - + unsigned char end = tag->getUInt("end", begin, 1, UCHAR_MAX); if (begin > end) throw ModuleException(" must be lower than at " + tag->getTagLocation()); diff --git a/src/modules/m_delayjoin.cpp b/src/modules/m_delayjoin.cpp index a33a2a1d2..8eff602d8 100644 --- 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 15e46b83a..c22c6a039 100644 --- 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 1bb803bc2..6123d3b31 100644 --- 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 5e6e9b036..b688aed9f 100644 --- 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 2571d15f2..0f1ee7466 100644 --- 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) -- cgit v1.2.3