User: stevensa
Date: 02/06/11 15:03:55
Modified: core/src/xdoclet/util Translator.java
Log:
Improved javadoc comments
Revision Changes Path
1.9 +17 -15 xdoclet/core/src/xdoclet/util/Translator.java
Index: Translator.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/util/Translator.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -r1.8 -r1.9
--- Translator.java 3 Jun 2002 08:13:37 -0000 1.8
+++ Translator.java 11 Jun 2002 22:03:55 -0000 1.9
@@ -16,7 +16,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Andrew Stevens</a>
* @created Jan 18, 2002
- * @version $Revision: 1.8 $
+ * @version $Revision: 1.9 $
*/
public final class Translator
{
@@ -30,9 +30,9 @@
/**
* Gets the String attribute of the Translator class.
*
- * @param resourceKey Describe what the parameter does
- * @param clazz
- * @return The String value
+ * @param clazz Messages class containing resource key constants, from
which the bundle was generated.
+ * @param resourceKey The resource key to look up in the bundle.
+ * @return The localized string
*/
public static java.lang.String getString(Class clazz, String resourceKey)
{
@@ -42,10 +42,11 @@
/**
* Gets the String attribute of the Translator class.
*
- * @param resourceKey Describe what the parameter does
- * @param arguments Describe what the parameter does
- * @param clazz
- * @return The String value
+ * @param clazz Messages class containing resource key constants, from
which the bundle was generated.
+ * @param resourceKey The resource key to look up in the bundle.
+ * @param arguments A string array of the arguments to be substituted for
any placeholders ({0}, {1} etc.) in the
+ * resource value string.
+ * @return The localized string
*/
public static java.lang.String getString(Class clazz, String resourceKey,
String[] arguments)
{
@@ -55,9 +56,9 @@
/**
* Gets the String attribute of the Translator class.
*
- * @param bundleKey Full bundle name, with the tailing ".resources.Messages".
- * @param resourceKey Describe what the parameter does
- * @return The String value
+ * @param bundleKey Bundle name, without the tailing ".resources.Messages".
+ * @param resourceKey The resource key to look up in the bundle.
+ * @return The localized string
*/
public static java.lang.String getString(String bundleKey, String resourceKey)
{
@@ -67,10 +68,11 @@
/**
* Gets the String attribute of the Translator class.
*
- * @param bundleKey Describe what the parameter does
- * @param resourceKey Describe what the parameter does
- * @param arguments Describe what the parameter does
- * @return The String value
+ * @param bundleKey Full bundle name, including the tailing
".resources.Messages".
+ * @param resourceKey The resource key to look up in the bundle.
+ * @param arguments A string array of the arguments to be substituted for
any placeholders ({0}, {1} etc.) in the
+ * resource value string.
+ * @return The localized string
*/
public static java.lang.String getString(String bundleKey, String resourceKey,
String[] arguments)
{
_______________________________________________________________
Multimillion Dollar Computer Inventory
Live Webcast Auctions Thru Aug. 2002 - http://www.cowanalexander.com/calendar
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
