Remove unneeded headers from spanningtree. This was done to the rest of the source...

[user/henk/code/inspircd.git] / include / command_parse.h

diff --git a/include/command_parse.h b/include/command_parse.h
index 4f8b8000003d1f5e5da3abfac5757691a817d3bd..2c883be203b696458ea4c6366af404c907161355 100644 (file)
--- 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);
 };