svn commit: r17925 - trunk/src/argouml-app/src/org/argouml/i18n/Translator.java

Author: linus
Date: 2010-01-27 11:55:47-0800
New Revision: 17925

Modified:
   trunk/src/argouml-app/src/org/argouml/i18n/Translator.java

Log:
Improved the documentation of localize(String, Object[]).

Issue 5782.

Modified: trunk/src/argouml-app/src/org/argouml/i18n/Translator.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/i18n/Translator.java?view=diff&pathrev=17925&r1=17924&r2=17925
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/i18n/Translator.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/i18n/Translator.java	2010-01-27 11:55:47-0800
@@ -312,7 +312,11 @@
     /**
      * Synonym for messageFormat to encourage developers to convert
      * existing uses of localize() + string concatenation to use
-     * this method instead.
+     * this method instead.<p>
+     *
+     * The localized string is a pattern to be processed by
+     * {@link MessageFormat}.
+     *
      * @see org.argouml.i18n.Translator#messageFormat(String, Object[])
      *
      * @param key the key to localize

------------------------------------------------------
http://argouml.tigris.org/ds/viewMessage.do?dsForumId=5905&dsMessageId=2442521

To unsubscribe from this discussion, e-mail: [[email protected]].