From 7de28b5b350c97562b4696aaa42a0a64a91d854d Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 8 Aug 2006 20:12:36 +0000 Subject: Document new methods git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4801 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/users.h | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/include/users.h b/include/users.h index bd60726c0..a66062383 100644 --- a/include/users.h +++ b/include/users.h @@ -580,34 +580,51 @@ class userrec : public connection void WriteServ(const char* text, ...); /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter. + * @param user The user to prepend the :nick!user@host of * @param text A std::string to send to the user */ void WriteFrom(userrec *user, const std::string &text); /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter. + * @param user The user to prepend the :nick!user@host of * @param text The format string for text to send to the user * @param ... POD-type format arguments */ void WriteFrom(userrec *user, const char* text, ...); /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host. + * @param dest The user to route the message to * @param text A std::string to send to the user - * @param ... POD-type format arguments */ void WriteTo(userrec *dest, const std::string &data); /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host. + * @param dest The user to route the message to * @param text The format string for text to send to the user * @param ... POD-type format arguments */ void WriteTo(userrec *dest, const char *data, ...); + /** Write to all users that can see this user (including this user in the list), appending CR/LF + * @param text A std::string to send to the users + */ void WriteCommon(const std::string &text); + /** Write to all users that can see this user (including this user in the list), appending CR/LF + * @param text The format string for text to send to the users + * @param ... POD-type format arguments + */ void WriteCommon(char* text, ...); + /** Write to all users that can see this user (not including this user in the list), appending CR/LF + * @param text The format string for text to send to the users + * @param ... POD-type format arguments + */ void WriteCommonExcept(char* text, ...); + /** Write to all users that can see this user (not including this user in the list), appending CR/LF + * @param text A std::string to send to the users + */ void WriteCommonExcept(const std::string &text); /** Default destructor -- cgit v1.2.3