/** 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());
* @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());
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)
}
/** 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)
/** 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.
/** 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.
*/
/** 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.
*/
/** 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.
*/
/** 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.
*/
/** 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;
/** 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)
/** 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.
*/
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);
* @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
*/
/** 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);
projects / user / henk / code / inspircd.git / commitdiff