dlr 01/10/25 16:12:58
Modified: src/tool/org/apache/turbine/tool LocalizationTool.java
Log:
Cleaned up JavaDoc mess.
Revision Changes Path
1.17 +17 -4
jakarta-turbine-3/src/tool/org/apache/turbine/tool/LocalizationTool.java
Index: LocalizationTool.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-3/src/tool/org/apache/turbine/tool/LocalizationTool.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -u -r1.16 -r1.17
--- LocalizationTool.java 2001/10/25 23:07:16 1.16
+++ LocalizationTool.java 2001/10/25 23:12:58 1.17
@@ -177,7 +177,7 @@
* @param key The identifier for the localized text to retrieve,
* @param arg1 The object to use as {0} when formatting the localized text.
* @return Formatted localized text.
- * @see #format(String, Object[])
+ * @see #format(String, List)
*/
public String format(String key, Object arg1)
{
@@ -191,7 +191,7 @@
* @param arg1 The object to use as {0} when formatting the localized text.
* @param arg2 The object to use as {1} when formatting the localized text.
* @return Formatted localized text.
- * @see #format(String, Object[])
+ * @see #format(String, List)
*/
public String format(String key, Object arg1, Object arg2)
{
@@ -199,9 +199,22 @@
}
/**
- * Formats a localized value using the provided objects.
+ * <p>Formats a localized value using the provided objects.</p>
+ *
+ * <p>ResourceBundle:
+ * <blockquote><code><pre>
+ * VelocityUsersNotWrong={0} out of {1} users can't be wrong!
+ * </pre></code></blockquote>
+ *
+ * Template:
+ * <blockquote><code><pre>
+ * $l10n.format("VelocityUsersNotWrong", ["9", "10"])
+ * </pre></code></blockquote>
*
- * ['foo', 'bar']
+ * Result:
+ * <blockquote><code><pre>
+ * 9 out of 10 Velocity users can't be wrong!
+ * </pre></code></blockquote></p>
*
* @param key The identifier for the localized text to retrieve,
* @param args The objects to use as {0}, {1}, etc. when
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
