Anonymous avatar Anonymous committed 3b9563e

updated javadoc (added example for i18n) ww-1002

git-svn-id: http://svn.opensymphony.com/svn/webwork/trunk@1883 573baa09-0c28-0410-bef9-dab3c582ae83

Comments (0)

Files changed (1)

src/java/com/opensymphony/webwork/components/Text.java

 
 /**
  * <!-- START SNIPPET: javadoc -->
- * <p>Render a I18n text message.</p>
+ * Render a I18n text message. 
+ * 
+ * <p/>
  *
- * <p>The message must be in a resource bundle
+ * The message must be in a resource bundle
  * with the same name as the action that it is associated with. In practice
  * this means that you should create a properties file in the same package
  * as your Java class with the same name as your class, but with .properties
- * extension.</p>
+ * extension.
  *
- * <p>If the named message is not found, then the body of the tag will be used as default message.
- * If no body is used, then the name of the message will be used.</p>
+ * <p/>
+ *
+ * If the named message is not found, then the body of the tag will be used as default message.
+ * If no body is used, then the name of the message will be used.
+ * 
  * <!-- END SNIPPET: javadoc -->
  *
+ *
+ *
  * <!-- START SNIPPET: params -->
+ * 
  * <ul>
  *      <li>name* (String) - the i18n message key</li>
  * </ul>
+ * 
  * <!-- END SNIPPET: params -->
  *
+ * <p/>
+ *
  * Example:
  * <pre>
  * <!-- START SNIPPET: exdescription -->
+ * 
  * Accessing messages from a given bundle (the i18n Shop example bundle in the first example) and using bundle defined through ww in the second example.</p>
+ * 
  * <!-- END SNIPPET: exdescription -->
  * </pre>
  *
  * <pre>
  * <!-- START SNIPPET: example -->
+ * 
  * &lt;!-- First Example --&gt;
  * &lt;ww:i18n name="webwork.action.test.i18n.Shop"&gt;
  *     &lt;ww:text name="main.title"/&gt;
  *
  * &lt;!-- Second Example --&gt;
  * &lt;ww:text name="main.title" /&gt;
+ * 
  * <!-- END SNIPPET: example -->
  * </pre>
+ * 
+ * 
+ * <pre>
+ * <!-- START SNIPPET: i18nExample -->
+ * 
+ * &lt;ww:text name="some.key" /&gt;
+ * 
+ * <!-- END SNIPPET: i18nExample -->
+ * </pre>
+ * 
  *
  * @author Jason Carreira
  * @author Patrick Lightbody
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.