From ffbbfa9cd6c5e30f4ba84d51bb31e42a3e7ebd41 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 27 Aug 2007 16:08:21 +0000 Subject: Add documentation comments git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7894 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/command_parse.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/command_parse.h b/include/command_parse.h index 4f8b80000..2c883be20 100644 --- a/include/command_parse.h +++ b/include/command_parse.h @@ -203,6 +203,10 @@ class CoreExport CommandParser : public classbase void SetupCommandTable(userrec* user); /** Translate nicknames in a string into UIDs, based on the TranslationType given. + * @param to The translation type to use for the process. + * @param source The input string + * @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT. + * @return returns the number of substitutions made. Will always be 0 or 1 for TR_TEXT and 0..n for other types. */ int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest); }; -- cgit v1.2.3