diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/clientprotocolmsg.h | 1 | ||||
| -rw-r--r-- | include/ctables.h | 4 | ||||
| -rw-r--r-- | include/extensible.h | 6 | ||||
| -rw-r--r-- | include/modules.h | 1 | ||||
| -rw-r--r-- | include/modules/ctctags.h | 2 | ||||
| -rw-r--r-- | include/serialize.h | 6 | ||||
| -rw-r--r-- | include/socket.h | 1 | ||||
| -rw-r--r-- | include/users.h | 8 |
8 files changed, 14 insertions, 15 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 <typename T> 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<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; }; |