diff options
| -rw-r--r-- | include/channels.h | 2 | ||||
| -rw-r--r-- | include/clientprotocol.h | 6 | ||||
| -rw-r--r-- | include/clientprotocolmsg.h | 8 | ||||
| -rw-r--r-- | include/configreader.h | 4 | ||||
| -rw-r--r-- | include/event.h | 1 | ||||
| -rw-r--r-- | include/hashcomp.h | 4 | ||||
| -rw-r--r-- | include/inspircd.h | 4 | ||||
| -rw-r--r-- | include/inspsocket.h | 2 | ||||
| -rw-r--r-- | include/modules.h | 2 |
9 files changed, 16 insertions, 17 deletions
diff --git a/include/channels.h b/include/channels.h index 0557a5898..22a373a0f 100644 --- a/include/channels.h +++ b/include/channels.h @@ -235,7 +235,6 @@ class CoreExport Channel : public Extensible /** Write to all users on a channel except some users * @param protoev Event to send, may contain any number of messages. * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param text A std::string containing the output line without prefix * @param except_list List of users not to send to */ void Write(ClientProtocol::Event& protoev, char status = 0, const CUList& except_list = CUList()); @@ -244,7 +243,6 @@ class CoreExport Channel : public Extensible * @param protoevprov Protocol event provider for the message. * @param msg Message to send. * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone - * @param text A std::string containing the output line without prefix * @param except_list List of users not to send to */ void Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status = 0, const CUList& except_list = CUList()); diff --git a/include/clientprotocol.h b/include/clientprotocol.h index a3efcf984..260e463eb 100644 --- a/include/clientprotocol.h +++ b/include/clientprotocol.h @@ -467,7 +467,7 @@ class ClientProtocol::Event public: /** Constructor. - * @param protoevent Protocol event provider the event is an instance of. + * @param protoeventprov Protocol event provider the event is an instance of. */ Event(EventProvider& protoeventprov) : event(&protoeventprov) @@ -478,7 +478,7 @@ class ClientProtocol::Event } /** Constructor. - * @param protoevent Protocol event provider the event is an instance of. + * @param protoeventprov Protocol event provider the event is an instance of. * @param msg Message to include in this event by default. */ Event(EventProvider& protoeventprov, ClientProtocol::Message& msg) @@ -544,7 +544,7 @@ class ClientProtocol::MessageTagProvider : public Events::ModuleEventListener /** Called for each tag that the server receives from a client in a message. * @param user User that sent the tag. * @param tagname Name of the tag. - * @param value Value of the tag, empty string if the tag has no value. May be modified. + * @param tagvalue Value of the tag, empty string if the tag has no value. May be modified. * @return MOD_RES_ALLOW to accept the tag with the value in 'value', MOD_RES_DENY to reject the tag and act as if it wasn't sent, * MOD_RES_PASSTHRU to make no decision. If no hooks accept a tag, the tag is rejected. * The default implementation returns MOD_RES_PASSTHRU. diff --git a/include/clientprotocolmsg.h b/include/clientprotocolmsg.h index d1562d7d1..d2f838d69 100644 --- a/include/clientprotocolmsg.h +++ b/include/clientprotocolmsg.h @@ -484,7 +484,7 @@ class ClientProtocol::Messages::Privmsg : public ClientProtocol::Message /** Constructor, string source, string target, copies text. * @param source Source user. - * @param targetuser Target user. + * @param target Target string. * @param text Privmsg text, will be copied. * @param mt Message type. */ @@ -524,7 +524,7 @@ class ClientProtocol::Messages::Privmsg : public ClientProtocol::Message /** Constructor, user source, string target, copies text. * @param source Source user. - * @param targetuser Target string. + * @param target Target string. * @param text Privmsg text, will not be copied. * @param mt Message type. */ @@ -564,7 +564,7 @@ class ClientProtocol::Messages::Privmsg : public ClientProtocol::Message /** Constructor, string source, string target, does not copy text. * @param source Source string. - * @param targetuser Target string. + * @param target Target string. * @param text Privmsg text, will not be copied. * @param mt Message type. */ @@ -591,7 +591,7 @@ class ClientProtocol::Messages::Privmsg : public ClientProtocol::Message /** Constructor, string source, user target, does not copy text. * @param source Source string. - * @param targetchan Target user. + * @param targetuser Target user. * @param text Privmsg text, will not be copied. * @param mt Message type. */ diff --git a/include/configreader.h b/include/configreader.h index c63ea717a..1db64ae5a 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -150,12 +150,12 @@ struct CommandLineConf /** If this is true, a PID file will be written * to the file given in the "file" variable of - * the <pid> tag in the config file. This is + * the \<pid> tag in the config file. This is * the default. * Passing --nopid as a command line argument * sets this to false; in this case, a PID file * will not be written, even the default PID - * file that is usually written when the <pid> + * file that is usually written when the \<pid> * tag is not defined in the config file. */ bool writepid; diff --git a/include/event.h b/include/event.h index 73a45a541..1bcb0a5ed 100644 --- a/include/event.h +++ b/include/event.h @@ -104,6 +104,7 @@ class Events::ModuleEventListener : private dynamic_reference_base::CaptureHook /** Constructor * @param mod Module subscribing * @param eventid Identifier of the event to subscribe to + * @param eventprio The priority to give this event listener */ ModuleEventListener(Module* mod, const std::string& eventid, unsigned int eventprio = DefaultPriority) : prov(mod, eventid) diff --git a/include/hashcomp.h b/include/hashcomp.h index b9c568135..f0e092729 100644 --- a/include/hashcomp.h +++ b/include/hashcomp.h @@ -199,13 +199,13 @@ namespace irc /** Create a tokenstream and fill it with the provided data. */ tokenstream(const std::string& msg, size_t start = 0); - /** Retrieve the next <middle> token in the token stream. + /** Retrieve the next \<middle> token in the token stream. * @param token The next token available, or an empty string if none remain. * @return True if tokens are left to be read, false if the last token was just retrieved. */ bool GetMiddle(std::string& token); - /** Retrieve the next <trailing> token in the token stream. + /** Retrieve the next \<trailing> token in the token stream. * @param token The next token available, or an empty string if none remain. * @return True if tokens are left to be read, false if the last token was just retrieved. */ diff --git a/include/inspircd.h b/include/inspircd.h index 934f2f82b..1e0ca1925 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -348,9 +348,9 @@ class CoreExport InspIRCd static void DefaultGenRandom(char* output, size_t max); /** Bind to a specific port from a config tag. - * @param Tag the tag that contains bind information. + * @param tag the tag that contains bind information. * @param sa The endpoint to listen on. - * @params old_ports Previously listening ports that may be on the same endpoint. + * @param old_ports Previously listening ports that may be on the same endpoint. */ bool BindPort(ConfigTag* tag, const irc::sockets::sockaddrs& sa, std::vector<ListenSocket*>& old_ports); diff --git a/include/inspsocket.h b/include/inspsocket.h index 5bdbfd652..d88c350ba 100644 --- a/include/inspsocket.h +++ b/include/inspsocket.h @@ -301,7 +301,7 @@ class CoreExport StreamSocket : public EventHandler * @param local The new local endpoint. * @param remote The new remote endpoint. */ - virtual void OnSetEndPoint(const irc::sockets::sockaddrs& server, const irc::sockets::sockaddrs& remote) { } + virtual void OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) { } /** Send the given data out the socket, either now or when writes unblock */ diff --git a/include/modules.h b/include/modules.h index 43ab2ae3a..8acf9089d 100644 --- a/include/modules.h +++ b/include/modules.h @@ -570,7 +570,7 @@ class CoreExport Module : public classbase, public usecountbase /** Called whenever a user's real name is changed. * This event triggers after the name has been set. * @param user The user who's real name is being changed - * @param name The new real name being set on the user + * @param real The new real name being set on the user */ virtual void OnChangeRealName(User* user, const std::string& real); |