From 8d021c6cafcac766b0c5348678def1497ae59f7d Mon Sep 17 00:00:00 2001 From: David Anderson Date: Sat, 19 Apr 2008 00:44:28 +0000 Subject: [PATCH] fixed some doc inconsistencies on ProcessTargetString --HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%402081 --- plugins/include/commandfilters.inc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/plugins/include/commandfilters.inc b/plugins/include/commandfilters.inc index bc432a85..825ba5ce 100644 --- a/plugins/include/commandfilters.inc +++ b/plugins/include/commandfilters.inc @@ -57,6 +57,10 @@ * Processes a generic command target string, and resolves it to a list * of clients or one client, based on filtering rules and a pattern. * + * Note that you should use LoadTranslations("common.phrases") in OnPluginStart(), + * as that file is guaranteed to contain all of the translatable phrases that + * ProcessTargetString() will return. + * * @param pattern Pattern to find clients against. * @param admin Admin performing the action, or 0 if the server. * @param targets Array to hold targets. @@ -64,11 +68,11 @@ * @param filter_flags Filter flags. * @param target_name Buffer to store the target name. * @param tn_maxlength Maximum length of the target name buffer. - * @param tn_is_ml Set to true if the target name buffer is an ML phrase, + * @param tn_is_ml OUTPUT: Will be true if the target name buffer is an ML phrase, * false if it is a normal string. * @return If a multi-target pattern was used, the number of clients found * is returned. If a single-target pattern was used, 1 is returned - * if one valid client is found. Otherwise, a CLIENT_TARGET reason + * if one valid client is found. Otherwise, a COMMAND_TARGET reason * for failure is returned. */ native ProcessTargetString(const String:pattern[],