http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/com/opensymphony/xwork2/validator/validators/StringLengthFieldValidator.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/StringLengthFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/StringLengthFieldValidator.java index 47916d0..9d28a55 100644 --- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/StringLengthFieldValidator.java +++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/StringLengthFieldValidator.java @@ -26,9 +26,7 @@ import org.apache.commons.lang3.StringUtils; * characters. The "trim" parameter determines whether it will {@link String#trim() trim} the * String before performing the length check. If unspecified, the String will be trimmed. * <!-- END SNIPPET: javadoc --> - * <p/> - * <p/> - * <p/> + * * <!-- START SNIPPET: parameters --> * <ul> * <li>fieldName - The field name this validator is validating. Required if using Plain-Validator Syntax otherwise not required</li> @@ -40,11 +38,11 @@ import org.apache.commons.lang3.StringUtils; * <li>trimExpression - (Optional) String. Defines th trim param as an OGNL expression</li> * </ul> * <!-- END SNIPPET: parameters --> - * <p/> + * * <!-- START SNIPPET: parameters-warning --> * Do not use ${minLengthExpression}, ${maxLengthExpression} and ${trimExpression} as an expression as this will turn into infinitive loop! * <!-- END SNIPPET: parameters-warning --> - * <p/> + * * <pre> * <!--START SNIPPET: example --> * <validators> @@ -83,7 +81,6 @@ import org.apache.commons.lang3.StringUtils; * @author Jason Carreira * @author Mark Woon * @author tmjee - * @version $Date$ $Id$ */ public class StringLengthFieldValidator extends FieldValidatorSupport {
http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/com/opensymphony/xwork2/validator/validators/VisitorFieldValidator.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/VisitorFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/VisitorFieldValidator.java index e0be5f0..1a99e4f 100644 --- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/VisitorFieldValidator.java +++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/VisitorFieldValidator.java @@ -28,14 +28,17 @@ import java.util.Collection; /** * <!-- START SNIPPET: javadoc --> + * + * <p> * The VisitorFieldValidator allows you to forward validation to object * properties of your action using the object's own validation files. This * allows you to use the ModelDriven development pattern and manage your * validations for your models in one place, where they belong, next to your * model classes. The VisitorFieldValidator can handle either simple Object * properties, Collections of Objects, or Arrays. + * </p> + * * <!-- END SNIPPET: javadoc --> - * <p/> * * <!-- START SNIPPET: parameters --> * <ul> @@ -75,7 +78,6 @@ import java.util.Collection; * * @author Jason Carreira * @author Rainer Hermanns - * @version $Date$ $Id$ */ public class VisitorFieldValidator extends FieldValidatorSupport { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/StrutsStatics.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/StrutsStatics.java b/core/src/main/java/org/apache/struts2/StrutsStatics.java index af5796e..d204f52 100644 --- a/core/src/main/java/org/apache/struts2/StrutsStatics.java +++ b/core/src/main/java/org/apache/struts2/StrutsStatics.java @@ -23,19 +23,22 @@ package org.apache.struts2; /** + * <p> * Constants used by Struts. The constants can be used to get or set objects * out of the action context or other collections. + * </p> * - * <p/> - * + * <p> * Example: - * <ul><code>ActionContext.getContext().put(HTTP_REQUEST, request);</code></ul> - * <p/> + * + * <code>ActionContext.getContext().put(HTTP_REQUEST, request);</code> + * * or - * <p/> - * <ul><code> + * + * <code> * ActionContext context = ActionContext.getContext();<br> - * HttpServletRequest request = (HttpServletRequest)context.get(HTTP_REQUEST);</code></ul> + * HttpServletRequest request = (HttpServletRequest)context.get(HTTP_REQUEST);</code> + * </p> */ public interface StrutsStatics { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/ActionError.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/ActionError.java b/core/src/main/java/org/apache/struts2/components/ActionError.java index d005333..4ce34a3 100644 --- a/core/src/main/java/org/apache/struts2/components/ActionError.java +++ b/core/src/main/java/org/apache/struts2/components/ActionError.java @@ -40,7 +40,7 @@ import java.util.List; * * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/ActionMessage.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/ActionMessage.java b/core/src/main/java/org/apache/struts2/components/ActionMessage.java index 10ba59f..c62dd5d 100644 --- a/core/src/main/java/org/apache/struts2/components/ActionMessage.java +++ b/core/src/main/java/org/apache/struts2/components/ActionMessage.java @@ -40,7 +40,7 @@ import java.util.List; * * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Anchor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Anchor.java b/core/src/main/java/org/apache/struts2/components/Anchor.java index 5819294..118ae6f 100644 --- a/core/src/main/java/org/apache/struts2/components/Anchor.java +++ b/core/src/main/java/org/apache/struts2/components/Anchor.java @@ -39,13 +39,14 @@ import java.util.Map; /** * <!-- START SNIPPET: javadoc --> - * <p/> + * <p> * A tag that creates a HTML <a >.This tag supports the same attributes as the "url" tag, - * including nested parameters using the "param" tag.<p/> + * including nested parameters using the "param" tag. + * </p> * <!-- END SNIPPET: javadoc --> - * <p/> - * <p/> <b>Examples</b> - * <p/> + * + * <p><b>Examples</b></p> + * * <pre> * <!-- START SNIPPET: example1 --> * <s:a id="link1" href="/do-it.action"> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Bean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Bean.java b/core/src/main/java/org/apache/struts2/components/Bean.java index 2039d95..bb0b913 100644 --- a/core/src/main/java/org/apache/struts2/components/Bean.java +++ b/core/src/main/java/org/apache/struts2/components/Bean.java @@ -36,10 +36,10 @@ import java.io.Writer; * <!-- START SNIPPET: javadoc --> * <p>Instantiates a class that conforms to the JavaBeans specification. This tag has a body which can contain * a number of {@link Param} elements to set any mutator methods on that class.</p> - * <p/> + * * <p>If the var attribute is set on the BeanTag, it will place the instantiated bean into the * stack's Context.</p> - * <p/> + * * <!-- END SNIPPET: javadoc --> * * @@ -52,7 +52,7 @@ import java.io.Writer; * * * <p>Examples:</p> - * <p/> + * * <pre> * <!-- START SNIPPET: examples --> * <-- in freemarker form --> @@ -68,16 +68,16 @@ import java.io.Writer; * </s:bean> * <!-- END SNIPPET: examples --> * </pre> - * <p/> + * * * <!-- START SNIPPET: examplesdescription --> * <p>This example instantiates a bean called SimpleCounter and sets the foo property (setFoo('BAR')). The * SimpleCounter object is then pushed onto the Valuestack, which means that we can call its accessor methods (getFoo()) * with the Property tag and get their values.</p> - * <p/> + * * <p>In the above example, the id has been set to a value of <i>counter</i>. This means that the SimpleCounter class * will be placed into the stack's context. You can access the SimpleCounter class using a Struts tag:</p> - * <p/> + * * <pre> * <-- jsp form --> * <s:property value="#counter" /> @@ -85,7 +85,7 @@ import java.io.Writer; * <-- freemarker form --> * [s:property value="#counter.foo"/] * </pre> - * <p/> + * * <p>In the property tag example, the <i>#</i> tells Ognl to search the context for the SimpleCounter class which has * an id(key) of <i>counter</i></p> * <!-- END SNIPPET: examplesdescription --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Checkbox.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Checkbox.java b/core/src/main/java/org/apache/struts2/components/Checkbox.java index e1765b2..a9f0fdc 100644 --- a/core/src/main/java/org/apache/struts2/components/Checkbox.java +++ b/core/src/main/java/org/apache/struts2/components/Checkbox.java @@ -34,7 +34,7 @@ import com.opensymphony.xwork2.util.ValueStack; * Renders an HTML input element of type checkbox, populated by the specified property from the ValueStack. * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/CheckboxList.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/CheckboxList.java b/core/src/main/java/org/apache/struts2/components/CheckboxList.java index e83c8be..fde4037 100644 --- a/core/src/main/java/org/apache/struts2/components/CheckboxList.java +++ b/core/src/main/java/org/apache/struts2/components/CheckboxList.java @@ -36,7 +36,7 @@ import com.opensymphony.xwork2.util.ValueStack; * * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/ComboBox.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/ComboBox.java b/core/src/main/java/org/apache/struts2/components/ComboBox.java index d7ac8dc..99ae38d 100644 --- a/core/src/main/java/org/apache/struts2/components/ComboBox.java +++ b/core/src/main/java/org/apache/struts2/components/ComboBox.java @@ -34,21 +34,27 @@ import java.util.Map; /** * <!-- START SNIPPET: javadoc --> + * <p> * The combo box is basically an HTML INPUT of type text and HTML SELECT grouped together to give you a combo box * functionality. You can place text in the INPUT control by using the SELECT control or type it in directly in - * the text field.<p/> + * the text field. + * </p> * + * <p> * In this example, the SELECT will be populated from id=year attribute. Counter is itself an Iterator. It will * span from first to last. The population is done via javascript, and requires that this tag be surrounded by a - * <form>.<p/> + * <form>. + * </p> * + * <p> * Note that unlike the <s:select/> tag, there is no ability to define the individual <option> tags' id attribute * or content separately. Each of these is simply populated from the toString() method of the list item. Presumably * this is because the select box isn't intended to actually submit useful data, but to assist the user in filling - * out the text field.<p/> + * out the text field. + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Component.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Component.java b/core/src/main/java/org/apache/struts2/components/Component.java index b34178d..2fd8c14 100644 --- a/core/src/main/java/org/apache/struts2/components/Component.java +++ b/core/src/main/java/org/apache/struts2/components/Component.java @@ -51,8 +51,8 @@ import java.util.concurrent.ConcurrentMap; /** * Base class to extend for UI components. - * <p/> - * This class is a good extension point when building reuseable UI components. + * <br> + * This class is a good extension point when building reusable UI components. * */ public class Component { @@ -116,8 +116,8 @@ public class Component { this.urlHelper = urlHelper; } /** - * Gets the OGNL value stack assoicated with this component. - * @return the OGNL value stack assoicated with this component. + * Gets the OGNL value stack associated with this component. + * @return the OGNL value stack associated with this component. */ public ValueStack getStack() { return stack; @@ -150,7 +150,7 @@ public class Component { /** * Callback for the end tag of this component. * Should the body be evaluated again? - * <p/> + * <br> * <b>NOTE:</b> will pop component stack. * @param writer the output writer. * @param body the rendered body. @@ -163,7 +163,7 @@ public class Component { /** * Callback for the start tag of this component. * Should the body be evaluated again? - * <p/> + * <br> * <b>NOTE:</b> has a parameter to determine to pop the component stack. * @param writer the output writer. * @param body the rendered body. @@ -225,7 +225,7 @@ public class Component { /** * Evaluates the OGNL stack to find a String value. - * <p/> + * <br> * If the given expression is <tt>null</tt/> a error is logged and a <code>RuntimeException</code> is thrown * constructed with a messaged based on the given field and errorMsg parameter. * @@ -245,7 +245,7 @@ public class Component { /** * Constructs a <code>RuntimeException</code> based on the given information. - * <p/> + * <br> * A message is constructed and logged at ERROR level before being returned * as a <code>RuntimeException</code>. * @param field field name used when throwing <code>RuntimeException</code>. @@ -290,7 +290,7 @@ public class Component { /** * Is the altSyntax enabled? [TRUE] - * <p/> + * <br> * See <code>struts.properties</code> where the altSyntax flag is defined. */ public boolean altSyntax() { @@ -324,12 +324,16 @@ public class Component { } /** + * <p> * Evaluates the OGNL stack to find an Object value. - * <p/> + * </p> + * + * <p> * Function just like <code>findValue(String)</code> except that if the * given expression is <tt>null</tt/> a error is logged and * a <code>RuntimeException</code> is thrown constructed with a - * messaged based on the given field and errorMsg paramter. + * messaged based on the given field and errorMsg parameter. + * </p> * * @param expr OGNL expression. * @param field field name used when throwing <code>RuntimeException</code>. @@ -362,7 +366,7 @@ public class Component { * <code>expr</code> the portion wrapped with altSyntax (%{...}) * against stack when altSyntax is on, else the whole <code>expr</code> * is evaluated against the stack. - * <p/> + * <br> * This method only supports the altSyntax. So this should be set to true. * @param expr OGNL expression. * @param toType the type expected to find. @@ -490,7 +494,7 @@ public class Component { /** * Adds the given key and value to this component's own parameter. - * <p/> + * <br> * If the provided key is <tt>null</tt> nothing happens. * If the provided value is <tt>null</tt> any existing parameter with * the given key name is removed. http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Date.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Date.java b/core/src/main/java/org/apache/struts2/components/Date.java index cedb6af..befc1eb 100644 --- a/core/src/main/java/org/apache/struts2/components/Date.java +++ b/core/src/main/java/org/apache/struts2/components/Date.java @@ -61,12 +61,12 @@ import java.util.TimeZone; * <li>format</li> * </ul> * - * <p/> + * <br> * * Following how the date component will work, depending on the value of nice attribute * (which by default is false) and the format attribute. * - * <p/> + * <br> * * <b><u>Condition 1: With nice attribute as true</u></b> * <table border="1"> @@ -104,12 +104,12 @@ import java.util.TimeZone; * </tr> * </table> * - * <p/> + * <br> * * <b><u>Condition 2: With nice attribute as false and format attribute is specified eg. dd/MM/yyyyy </u></b> * <p>In this case the format attribute will be used.</p> * - * <p/> + * <br> * * <b><u>Condition 3: With nice attribute as false and no format attribute is specified </u></b> * <table border="1"> @@ -126,7 +126,7 @@ import java.util.TimeZone; * * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * <pre> * <!-- START SNIPPET: example --> * <s:date name="person.birthday" format="dd/MM/yyyy" /> @@ -208,8 +208,8 @@ public class Date extends ContextBean { } /** - * Calculates the difference in time from now to the given date, and outputs it nicely. <p/> An example: <br/>Now = - * 2006/03/12 13:38:00, date = 2006/03/12 15:50:00 will output "in 1 hour, 12 minutes". + * Calculates the difference in time from now to the given date, and outputs it nicely. <br> An example: <br> + * Now = 2006/03/12 13:38:00, date = 2006/03/12 15:50:00 will output "in 1 hour, 12 minutes". * * @param tp text provider * @param date the date http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/DoubleListUIBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/DoubleListUIBean.java b/core/src/main/java/org/apache/struts2/components/DoubleListUIBean.java index f6b4b8d..22e53fa 100644 --- a/core/src/main/java/org/apache/struts2/components/DoubleListUIBean.java +++ b/core/src/main/java/org/apache/struts2/components/DoubleListUIBean.java @@ -29,15 +29,16 @@ import javax.servlet.http.HttpServletResponse; import java.util.Map; /** + * <p> * DoubleListUIBean is the standard superclass of all Struts double list handling components. - * - * <p/> + * </p> * * <!-- START SNIPPET: javadoc --> - * + * <p> * Note that the doublelistkey and doublelistvalue attribute will default to "key" and "value" * respectively only when the doublelist attribute is evaluated to a Map or its decendant. * Other thing else, will result in doublelistkey and doublelistvalue to be null and not used. + * </p> * * <!-- END SNIPPET: javadoc --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/DoubleSelect.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/DoubleSelect.java b/core/src/main/java/org/apache/struts2/components/DoubleSelect.java index 4b0e1ce..539d3ae 100644 --- a/core/src/main/java/org/apache/struts2/components/DoubleSelect.java +++ b/core/src/main/java/org/apache/struts2/components/DoubleSelect.java @@ -33,7 +33,7 @@ import javax.servlet.http.HttpServletResponse; * Renders two HTML select elements with second one changing displayed values depending on selected entry of first one. * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/FieldError.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/FieldError.java b/core/src/main/java/org/apache/struts2/components/FieldError.java index 581ca46..809253a 100644 --- a/core/src/main/java/org/apache/struts2/components/FieldError.java +++ b/core/src/main/java/org/apache/struts2/components/FieldError.java @@ -39,7 +39,7 @@ import java.util.List; * * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> @@ -74,14 +74,13 @@ import java.util.List; * </pre> * * - * <p/> <b>Description</b><p/> - * + * <p><b>Description</b></p> * * <pre> * <!-- START SNIPPET: description --> * - * Example 1: display all field errors<p/> - * Example 2: display field errors only for 'field1' and 'field2'<p/> + * Example 1: display all field errors<br> + * Example 2: display field errors only for 'field1' and 'field2'<br> * * <!-- END SNIPPET: description --> * </pre> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/File.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/File.java b/core/src/main/java/org/apache/struts2/components/File.java index d98df90..752c31c 100644 --- a/core/src/main/java/org/apache/struts2/components/File.java +++ b/core/src/main/java/org/apache/struts2/components/File.java @@ -35,7 +35,7 @@ import javax.servlet.http.HttpServletResponse; * Renders an HTML file input element. * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Form.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Form.java b/core/src/main/java/org/apache/struts2/components/Form.java index 5e85adf..69ad61e 100644 --- a/core/src/main/java/org/apache/struts2/components/Form.java +++ b/core/src/main/java/org/apache/struts2/components/Form.java @@ -46,14 +46,19 @@ import java.util.Set; /** * <!-- START SNIPPET: javadoc --> - * <p/> - * Renders HTML an input form.<p/> - * <p/> + * <p> + * Renders HTML an input form. + * </p> + * + * <p> * The remote form allows the form to be submitted without the page being refreshed. The results from the form - * can be inserted into any HTML element on the page.<p/> - * <p/> - * NOTE:<p/> - * The order / logic in determining the posting url of the generated HTML form is as follows:- + * can be inserted into any HTML element on the page. + * </p> + * <p> + * NOTE:<br> + * The order / logic in determining the posting url of the generated HTML form is as follows: + * </p> + * * <ol> * <li> * If the action attribute is not specified, then the current request will be used to @@ -61,7 +66,7 @@ import java.util.Set; * </li> * <li> * If the action is given, Struts will try to obtain an ActionConfig. This will be - * successfull if the action attribute is a valid action alias defined struts.xml. + * successful if the action attribute is a valid action alias defined struts.xml. * </li> * <li> * If the action is given and is not an action alias defined in struts.xml, Struts @@ -69,16 +74,16 @@ import java.util.Set; * from it and using UrlHelper to generate the final url. * </li> * </ol> - * <p/> + * * <!-- END SNIPPET: javadoc --> - * <p/> - * <p/> <b>Examples</b> - * <p/> + * + * <p><b>Examples</b></p> + * * <pre> * <!-- START SNIPPET: example --> - * <p/> + * * <s:form ... /> - * <p/> + * * <!-- END SNIPPET: example --> * </pre> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/GenericUIBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/GenericUIBean.java b/core/src/main/java/org/apache/struts2/components/GenericUIBean.java index 9521e1f..53cbef0 100644 --- a/core/src/main/java/org/apache/struts2/components/GenericUIBean.java +++ b/core/src/main/java/org/apache/struts2/components/GenericUIBean.java @@ -31,41 +31,50 @@ import com.opensymphony.xwork2.util.ValueStack; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * Renders an custom UI widget using the specified templates. Additional objects can be passed in to the template - * using the param tags.<p/> - * - * <b>Freemarker:</b><p/> - * Objects provided can be retrieve from within the template via $parameters._paramname_.<p/> + * using the param tags. + * </p> * - * <b>Jsp:</b><p/> - * Objects provided can be retrieve from within the template via <s:property value="%{parameters._paramname_}" /><p/> + * <p><b>Freemarker:</b></p> + * <pre>Objects provided can be retrieve from within the template via $parameters._paramname_.</pre> * + * <p><b>JSP:</b></p> + * <pre>Objects provided can be retrieve from within the template via <s:property value="%{parameters._paramname_}" /></pre> * + * <p> * In the bottom JSP and Velocity samples, two parameters are being passed in to the component. From within the - * component, they can be accessed as:- <p/> + * component, they can be accessed as: + * </p> * - * <b>Freemarker:</b><p/> - * $parameters.get('key1') and $parameters.get('key2') or $parameters.key1 and $parameters.key2<p/> + * <p><b>Freemarker:</b></p> + * <pre>$parameters.get('key1') and $parameters.get('key2') or $parameters.key1 and $parameters.key2</pre> * - * <b>Jsp:</b><p/> + * <p><b>JSP:</b></p> + * <pre> * <s:property value="%{parameters.key1}" /> and <s:property value="%{'parameters.key2'}" /> or - * <s:property value="%{parameters.get('key1')}" /> and <s:property value="%{parameters.get('key2')}" /><p/> + * <s:property value="%{parameters.get('key1')}" /> and <s:property value="%{parameters.get('key2')}" /> + * </pre> * + * <p> * Currently, your custom UI components can be written in Velocity, JSP, or Freemarker, and the correct rendering - * engine will be found based on file extension.<p/> + * engine will be found based on file extension. + * </p> * + * <p> * <b>Remember:</b> the value params will always be resolved against the ValueStack so if you mean to pass a * string literal to your component, make sure to wrap it in single quotes i.e. value="'value1'" (note the opening "' and closing '" otherwise, the the value - * stack will search for an Object on the stack with a method of getValue1().<p/> - * + * stack will search for an Object on the stack with a method of getValue1(). + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * - * <pre> * <!-- START SNIPPET: example --> + * <p> * JSP + * </p> + * <pre> * <s:component template="/my/custom/component.vm"/> * * or @@ -74,8 +83,12 @@ import com.opensymphony.xwork2.util.ValueStack; * <s:param name="key1" value="value1"/> * <s:param name="key2" value="value2"/> * </s:component> + * </pre> * + * <p> * Velocity + * </p> + * <pre> * #s-component( "template=/my/custom/component.vm" ) * * or @@ -84,8 +97,12 @@ import com.opensymphony.xwork2.util.ValueStack; * #s-param( "name=key1" "value=value1" ) * #s-param( "name=key2" "value=value2" ) * #end + * </pre> * + * <p> * Freemarker + * </p> + * <pre> * <@s..component template="/my/custom/component.ftl" /> * * or @@ -96,10 +113,8 @@ import com.opensymphony.xwork2.util.ValueStack; * </@s..component> * * <!-- END SNIPPET: example --> - * </pre> - * - * <p/> * + * <p> * <b>NOTE:</b> * <!-- START SNIPPET: note --> * @@ -108,7 +123,7 @@ import com.opensymphony.xwork2.util.ValueStack; * could not be picked up from the classpath. * * <!-- END SNIPPET: note --> - * + * </p> */ @StrutsTag(name="component", tldTagClass="org.apache.struts2.views.jsp.ui.ComponentTag", description="Render a custom ui widget") public class GenericUIBean extends UIBean { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Head.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Head.java b/core/src/main/java/org/apache/struts2/components/Head.java index 756799c..2cc4710 100644 --- a/core/src/main/java/org/apache/struts2/components/Head.java +++ b/core/src/main/java/org/apache/struts2/components/Head.java @@ -35,7 +35,7 @@ import javax.servlet.http.HttpServletResponse; * Renders parts of the HEAD section for an HTML file. Encoding can be set using this tag. * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example1 --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Hidden.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Hidden.java b/core/src/main/java/org/apache/struts2/components/Hidden.java index b513340..9a85d90 100644 --- a/core/src/main/java/org/apache/struts2/components/Hidden.java +++ b/core/src/main/java/org/apache/struts2/components/Hidden.java @@ -33,7 +33,7 @@ import com.opensymphony.xwork2.util.ValueStack; * Renders an HTML input element of type hidden, populated by the specified property from the ValueStack. * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/I18n.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/I18n.java b/core/src/main/java/org/apache/struts2/components/I18n.java index 651fd5a..4db0e07 100644 --- a/core/src/main/java/org/apache/struts2/components/I18n.java +++ b/core/src/main/java/org/apache/struts2/components/I18n.java @@ -48,8 +48,6 @@ import java.util.ResourceBundle; * * <!-- END SNIPPET: javadoc --> * - * <p/> - * * <!-- START SNIPPET: params--> * * <ul> @@ -58,9 +56,9 @@ import java.util.ResourceBundle; * * <!-- END SNIPPET: params --> * - * <p/> - * + * <p> * Example: + * </p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Include.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Include.java b/core/src/main/java/org/apache/struts2/components/Include.java index 298829c..37e9c43 100644 --- a/core/src/main/java/org/apache/struts2/components/Include.java +++ b/core/src/main/java/org/apache/struts2/components/Include.java @@ -60,7 +60,7 @@ import java.util.*; * <!-- END SNIPPET: params --> * * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * <pre> * <!-- START SNIPPET: example --> * <-- One: --> @@ -313,15 +313,19 @@ public class Include extends Component { /** + * <p> * Simple wrapper to HTTPServletResponse that will allow getWriter() * and getResponse() to be called as many times as needed without * causing conflicts. - * <p/> + * </p> + * <p> * The underlying outputStream is a wrapper around * {@link PageOutputStream} which will store * the written content to a buffer. - * <p/> + * </p> + * <p> * This buffer can later be retrieved by calling {@link #getContent}. + * </p> * * @author <a href="mailto:[email protected]";>Joe Walnes</a> * @author <a href="mailto:[email protected]";>Scott Farquhar</a> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/InputTransferSelect.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/InputTransferSelect.java b/core/src/main/java/org/apache/struts2/components/InputTransferSelect.java index c137ec8..c401200 100644 --- a/core/src/main/java/org/apache/struts2/components/InputTransferSelect.java +++ b/core/src/main/java/org/apache/struts2/components/InputTransferSelect.java @@ -35,28 +35,23 @@ import java.util.Map; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * Create a input transfer select component which is basically an text input * and <select ...> tag with buttons in the middle of them allowing text * to be added to the transfer select. Will auto-select all its * elements upon its containing form submission. - * + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> - * - * * <!-- START SNIPPET: notice --> - * + * <p> * NOTE: The id and doubleId need not be supplied as they will generated provided * that the inputtransferselect tag is being used in a form tag. The generated id * and doubleId will be <form_id>_<inputtransferselect_doubleName> and * <form_id>_<inputtransferselect_doubleName> respectively. - * + * </p> * <!-- END SNIPPET: notice --> * - * <p/> - * * <pre> * <!-- START SNIPPET: example --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/IteratorComponent.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/IteratorComponent.java b/core/src/main/java/org/apache/struts2/components/IteratorComponent.java index 9ca073d..b62424f 100644 --- a/core/src/main/java/org/apache/struts2/components/IteratorComponent.java +++ b/core/src/main/java/org/apache/struts2/components/IteratorComponent.java @@ -38,7 +38,9 @@ import java.util.List; * <!-- START SNIPPET: javadoc --> * * <p>Iterator will iterate over a value. An iterable value can be any of: java.util.Collection, java.util.Iterator, - * java.util.Enumeration, java.util.Map, or an array.</p> <p/> <!-- END SNIPPET: javadoc --> + * java.util.Enumeration, java.util.Map, or an array.</p> + * + * <!-- END SNIPPET: javadoc --> * * <!-- START SNIPPET: params --> * @@ -96,12 +98,12 @@ import java.util.List; * <s:param name="day" value="'foo'"/> * <s:param name="day" value="'bar'"/> * </s:bean> - * <p/> + * * <table border="0" cellspacing="0" cellpadding="1"> * <tr> * <th>Days of the week</th> * </tr> - * <p/> + * * <s:iterator value="#it.days" status="rowstatus"> * <tr> * <s:if test="#rowstatus.odd == true"> @@ -142,11 +144,10 @@ import java.util.List; * * <!-- END SNIPPET: example3code --> * </pre> - * <p> * * <!-- START SNIPPET: example4description --> * - * </p> The next example iterates over a an action collection and passes every iterator value to another action. The + * <p> The next example iterates over a an action collection and passes every iterator value to another action. The * trick here lies in the use of the '[0]' operator. It takes the current iterator value and passes it on to the edit * action. Using the '[0]' operator has the same effect as using <s:property />. (The latter, however, does not * work from inside the param tag). </p> @@ -172,7 +173,7 @@ import java.util.List; * * <!-- START SNIPPET: example5description --> * - * </p>A loop that iterates 5 times + * <p>A loop that iterates 5 times</p> * * <!-- END SNIPPET: example5description --> * @@ -189,10 +190,10 @@ import java.util.List; * * <!-- START SNIPPET: example6description --> * - * </p>Another way to create a simple loop, similar to JSTL's + * <p>Another way to create a simple loop, similar to JSTL's * <c:forEach begin="..." end="..." ...> is to use some * OGNL magic, which provides some under-the-covers magic to - * make 0-n loops trivial. This example also loops five times. + * make 0-n loops trivial. This example also loops five times.</p> * * <!-- END SNIPPET: example6description --> * @@ -208,7 +209,7 @@ import java.util.List; * * <!-- START SNIPPET: example7description --> * - * </p>A loop that iterates over a partial list + * <p>A loop that iterates over a partial list</p> * * <!-- END SNIPPET: example7description --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Label.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Label.java b/core/src/main/java/org/apache/struts2/components/Label.java index 9a162f7..d0e9f39 100644 --- a/core/src/main/java/org/apache/struts2/components/Label.java +++ b/core/src/main/java/org/apache/struts2/components/Label.java @@ -36,12 +36,12 @@ import com.opensymphony.xwork2.util.ValueStack; * the rest of your UI controls.</p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> - * <p/> + * <p><b>Examples</b></p> + * * <!-- START SNIPPET: exdescription --> - * In this example, a label is rendered. The label is retrieved from a ResourceBundle via the key attribute + * <p>In this example, a label is rendered. The label is retrieved from a ResourceBundle via the key attribute * giving you an output of 'User Name: Ford.Prefect'. Assuming that i18n message userName corresponds - * to 'User Name' and the action's getUserName() method returns 'Ford.Prefect'<p/> + * to 'User Name' and the action's getUserName() method returns 'Ford.Prefect'</p> * <!-- END SNIPPET: exdescription --> * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/ListUIBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/ListUIBean.java b/core/src/main/java/org/apache/struts2/components/ListUIBean.java index cd11326..94be9d1 100644 --- a/core/src/main/java/org/apache/struts2/components/ListUIBean.java +++ b/core/src/main/java/org/apache/struts2/components/ListUIBean.java @@ -34,16 +34,17 @@ import java.util.Collection; import java.util.Map; /** + * <p> * DoubleListUIBean is the standard superclass of all Struts list handling components. - * <p/> - * <p/> - * <p/> + * </p> + * + * * <!-- START SNIPPET: javadoc --> - * <p/> + * <p> * Note that the listkey and listvalue attribute will default to "key" and "value" * respectively only when the list attribute is evaluated to a Map or its decendant. * Everything else will result in listkey and listvalue to be null and not used. - * <p/> + * </p> * <!-- END SNIPPET: javadoc --> */ public abstract class ListUIBean extends UIBean { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Number.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Number.java b/core/src/main/java/org/apache/struts2/components/Number.java index 400ade8..a52bff2 100644 --- a/core/src/main/java/org/apache/struts2/components/Number.java +++ b/core/src/main/java/org/apache/struts2/components/Number.java @@ -38,23 +38,32 @@ import java.util.Currency; /** * <!-- START SNIPPET: javadoc --> - * <p/> + * <p> * Format Number object in different ways. + * </p> + * * <p> * The number tag will allow you to format a Number in a quick and easy way, * based on the java.text.NumberFormat class. There are four basic number types, * a number, a currency, a percentage and an integer. If a currency is * specified, the number format will match the given currency. Further * parameters can be overridden as needed. - * <p/> + * </p> + * + * <p> * If a type is not defined, it will finally fall back to the default * NumberFormat.getNumberInstance() formatting. - * <p/> + * </p> + * + * <p> * <b>Note</b>: If the requested Number object isn't found on the stack, a blank * will be returned. * </p> - * <p/> - * Configurable attributes are :- + * + * <p> + * Configurable attributes are: + * </p> + * * <ul> * <li>name</li> * <li>currency - you can specify your own currency or as an OGNL expression</li> @@ -67,10 +76,12 @@ import java.util.Currency; * <li>parseIntegerOnly - see NumberFormat.isParseIntegerOnly</li> * <li>roundingMode - see below</li> * </ul> - * <p/> - * <p/> - * <p/> - * Possible values for rounding mode are :- + * + * + * <p> + * Possible values for rounding mode are: + * </p> + * * <ul> * <li>ceiling</li> * <li>down</li> @@ -81,14 +92,11 @@ import java.util.Currency; * <li>unnecessary</li> * <li>up</li> * </ul> - * <p/> - * <p/> - * <p/> + * * <!-- END SNIPPET: javadoc --> - * <p/> - * <p/> - * <b>Examples</b> - * <p/> + * + * <p><b>Examples</b></p> + * * <pre> * <!-- START SNIPPET: example --> * <s:number name="invoice.total" type="currency" currency="XYZ" /> @@ -97,8 +105,10 @@ import java.util.Currency; * <s:number name="invoice.terms" type="integer" /> * <!-- END SNIPPET: example --> * </pre> - * <p/> + * + * <p> * <code>Number</code> + * </p> */ @StrutsTag(name = "number", tldBodyContent = "empty", tldTagClass = "org.apache.struts2.views.jsp.NumberTag", description = "Render a formatted number.") public class Number extends ContextBean { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/OptGroup.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/OptGroup.java b/core/src/main/java/org/apache/struts2/components/OptGroup.java index d3e4d77..1be09e0 100644 --- a/core/src/main/java/org/apache/struts2/components/OptGroup.java +++ b/core/src/main/java/org/apache/struts2/components/OptGroup.java @@ -39,21 +39,18 @@ import org.apache.logging.log4j.LogManager; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * Create a optgroup component which needs to resides within a select tag. - * + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> - * * <!-- START SNIPPET: notice --> - * + * <p> * This component is to be used within a Select component. + * </p> * * <!-- END SNIPPET: notice --> * - * <p/> - * * <pre> * <!-- START SNIPPET: example --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/OptionTransferSelect.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/OptionTransferSelect.java b/core/src/main/java/org/apache/struts2/components/OptionTransferSelect.java index c704817..091dd64 100644 --- a/core/src/main/java/org/apache/struts2/components/OptionTransferSelect.java +++ b/core/src/main/java/org/apache/struts2/components/OptionTransferSelect.java @@ -35,28 +35,24 @@ import java.util.Map; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * Create a option transfer select component which is basically two <select ...> * tag with buttons in the middle of them allowing options in each of the * <select ...> to be moved between themselves. Will auto-select all its * elements upon its containing form submision. - * + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> - * - * * <!-- START SNIPPET: notice --> - * + * <p> * NOTE: The id and doubleId need not be supplied as they will generated provided * that the optiontransferselect tag is being used in a form tag. The generated id * and doubleId will be <form_id>_<optiontransferselect_nameame> and * <form_id>_<optiontransferselect_doubleName> respectively. + * </p> * * <!-- END SNIPPET: notice --> * - * <p/> - * * <pre> * <!-- START SNIPPET: example --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Param.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Param.java b/core/src/main/java/org/apache/struts2/components/Param.java index 09178b4..a71cd64 100644 --- a/core/src/main/java/org/apache/struts2/components/Param.java +++ b/core/src/main/java/org/apache/struts2/components/Param.java @@ -31,16 +31,21 @@ import java.io.Writer; /** * <!-- START SNIPPET: javadoc --> - * <p>This tag can be used to parameterize other tags.</p> + * <p>This tag can be used to parameterize other tags.<br> * The include tag and bean tag are examples of such tags. - * <p/> + * </p> + * + * <p> * The parameters can be added with or without a name as key. * If the tag provides a name attribute the parameters are added using the * {@link Component#addParameter(String, Object) addParamter} method. * For unnamed parameters the Tag must implement the {@link UnnamedParametric} interface defined in * this class (e.g. The TextTag does this). - * <p/> + * </p> + * + * <p> * This tag has the following two paramters. + * </p> * <!-- START SNIPPET: params --> * <ul> * <li>name (String) - the name of the parameter</li> @@ -48,7 +53,7 @@ import java.io.Writer; * <li>suppressEmptyParameters (boolean) - whether to suppress empty parameters</li> * </ul> * <!-- END SNIPPET: params --> - * <p/> + * <p> * <b>Note:</b> * When you declare the param tag, the value can be defined in either a <tt>value</tt> attribute or * as text between the start and end tag. Struts behaves a bit different according to these two situations. @@ -58,9 +63,10 @@ import java.io.Writer; * <br/>In the first situation (A) the value would be evaluated to the stack as a <tt>java.lang.String</tt> object. * And in situation (B) the value would be evaluated to the stack as a <tt>java.lang.Object</tt> object. * <br/>For more information see <a href="https://issues.apache.org/jira/browse/WW-808";>WW-808</a>. + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * <!-- START SNIPPET: example --> * <pre> * <ui:component> @@ -69,8 +75,11 @@ import java.io.Writer; * <ui:param name="context" value="[2]"/> * </ui:component> * </pre> - * <p/> + * + * <p> * Whether to suppress empty parameters: + * </p> + * * <pre> * <s:a action="eventAdd" accesskey="a"> * <s:text name="title.heading.eventadd" /> @@ -81,13 +90,15 @@ import java.io.Writer; * </s:a> * </pre> * <!-- END SNIPPET: example --> - * <p/> + * <p> * <!-- START SNIPPET: exampledescription --> * where the key will be the identifier and the value the result of an OGNL expression run against the current * ValueStack. * <!-- END SNIPPET: exampledescription --> - * <p/> + * </p> + * <p> * This second example demonstrates how the text tag can use parameters from this param tag. + * </p> * <!-- START SNIPPET: example2 --> * <pre> * <s:text name="cart.total.cost"> @@ -95,7 +106,7 @@ import java.io.Writer; * </s:text> * </pre> * <!-- END SNIPPET: example2 --> - * <p/> + * * * @see Include * @see Bean @@ -165,10 +176,13 @@ public class Param extends Component { } /** + * <p> * Tags can implement this to support nested param tags without the <tt>name</tt> attribute. - * <p/> + * </p> + * <p> * The {@link Text TextTag} uses this approach. For unnamed parameters an example is given in the class * javadoc for {@link Param ParamTag}. + * </p> */ public interface UnnamedParametric { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Password.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Password.java b/core/src/main/java/org/apache/struts2/components/Password.java index 47dc3dd..3f54b29 100644 --- a/core/src/main/java/org/apache/struts2/components/Password.java +++ b/core/src/main/java/org/apache/struts2/components/Password.java @@ -31,14 +31,16 @@ import com.opensymphony.xwork2.util.ValueStack; /** * <!-- START SNIPPET: javadoc --> - * Render an HTML input tag of type password.</p> + * <p>Render an HTML input tag of type password.</p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> - * <p/> + * <p><b>Examples</b></p> + * * <!-- START SNIPPET: exdescription --> + * <p> * In this example, a password control is displayed. For the label, we are calling ActionSupport's getText() to - * retrieve password label from a resource bundle.<p/> + * retrieve password label from a resource bundle. + * </p> * <!-- END SNIPPET: exdescription --> * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Property.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Property.java b/core/src/main/java/org/apache/struts2/components/Property.java index e0961a9..3a34b5b 100644 --- a/core/src/main/java/org/apache/struts2/components/Property.java +++ b/core/src/main/java/org/apache/struts2/components/Property.java @@ -33,15 +33,12 @@ import java.io.Writer; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * Used to get the property of a <i>value</i>, which will default to the top of * the stack if none is specified. - * + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> - * - * * <!-- START SNIPPET: params --> * * <ul> @@ -69,10 +66,10 @@ import java.io.Writer; * * <pre> * <!-- START SNIPPET: exampledescription --> - * + * <p> * Example 1 prints the result of myBean's getMyBeanProperty() method. * Example 2 prints the result of myBean's getMyBeanProperty() method and if it is null, print 'a default value' instead. - * + * </p> * <!-- END SNIPPET: exampledescription --> * </pre> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Push.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Push.java b/core/src/main/java/org/apache/struts2/components/Push.java index d9ea583..f5f428b 100644 --- a/core/src/main/java/org/apache/struts2/components/Push.java +++ b/core/src/main/java/org/apache/struts2/components/Push.java @@ -40,7 +40,7 @@ import com.opensymphony.xwork2.util.ValueStack; * <!-- END SNIPPET: params --> * * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * <pre> * <!-- START SNIPPET: example1 --> * <s:push value="user"> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Radio.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Radio.java b/core/src/main/java/org/apache/struts2/components/Radio.java index 4d1a745..bc46882 100644 --- a/core/src/main/java/org/apache/struts2/components/Radio.java +++ b/core/src/main/java/org/apache/struts2/components/Radio.java @@ -30,18 +30,19 @@ import javax.servlet.http.HttpServletResponse; /** * <!-- START SNIPPET: javadoc --> - * Render a radio button input field.</p> + * <p>Render a radio button input field.</p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> - * <p/> + * <p><b>Examples</b></p> + * <p> * <!-- START SNIPPET: exdescription --> * In this example, a radio control is displayed with a list of genders. The gender list is built from attribute * id=genders. The framework calls getGenders() which will return a Map. For examples using listKey and listValue attributes, * see the section select tag. The default selected one will be determined (in this case) by the getMale() method - * in the action class which should retun a value similar to the key of the getGenters() map if that particular - * gender is to be selected.<p/> + * in the action class which should return a value similar to the key of the getGenders() map if that particular + * gender is to be selected. * <!-- END SNIPPET: exdescription --> + * </p> * <pre> * <!-- START SNIPPET: example --> * <s:action name="GenderMap" var="genders"/> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Reset.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Reset.java b/core/src/main/java/org/apache/struts2/components/Reset.java index 7b4dd21..e489de2 100644 --- a/core/src/main/java/org/apache/struts2/components/Reset.java +++ b/core/src/main/java/org/apache/struts2/components/Reset.java @@ -40,7 +40,7 @@ import javax.servlet.http.HttpServletResponse; * text shown on the button face, but has issues with Microsoft Internet Explorer at least up to 6.0 * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Select.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Select.java b/core/src/main/java/org/apache/struts2/components/Select.java index 5eb1f7d..a21aaa9 100644 --- a/core/src/main/java/org/apache/struts2/components/Select.java +++ b/core/src/main/java/org/apache/struts2/components/Select.java @@ -36,7 +36,7 @@ import com.opensymphony.xwork2.util.ValueStack; * * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * <pre> * <!-- START SNIPPET: example --> * @@ -65,8 +65,7 @@ import com.opensymphony.xwork2.util.ValueStack; * <!-- END SNIPPET: example --> * </pre> * - * <p/> - * + * <p> * <!-- START SNIPPET: exnote --> * * Note: For any of the tags that use lists (select probably being the most ubiquitous), which uses the OGNL list @@ -74,10 +73,10 @@ import com.opensymphony.xwork2.util.ValueStack; * the '01', '02', etc.) is typed. '1' is a char, '01' is a String, "1" is a String. This is important since if * the value returned by your "value" attribute is NOT the same type as the key in the "list" attribute, they * WILL NOT MATCH, even though their String values may be equivalent. If they don't match, nothing in your list - * will be auto-selected.<p/> + * will be auto-selected. * * <!-- END SNIPPET: exnote --> - * + * </p> */ @StrutsTag( name="select", http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Set.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Set.java b/core/src/main/java/org/apache/struts2/components/Set.java index c198a60..629563c 100644 --- a/core/src/main/java/org/apache/struts2/components/Set.java +++ b/core/src/main/java/org/apache/struts2/components/Set.java @@ -37,7 +37,7 @@ import com.opensymphony.xwork2.util.ValueStack; * <p>If the tag is used with body content, the evaluation of the value parameter is omitted. Instead, the String to * which the body evaluates is set as value for the scoped variable.</p> * - * The scopes available are as follows :- + * <p>The scopes available are as follows:</p> * <ul> * <li>application - the value will be set in application scope according to servlet spec. using the name as its key</li> * <li>session - the value will be set in session scope according to servlet spec. using the name as key </li> @@ -46,12 +46,13 @@ import com.opensymphony.xwork2.util.ValueStack; * <li>action - the value will be set in the request scope and Struts' action context using the name as key</li> * </ul> * - * NOTE:<p/> + * <p> + * NOTE:<br> * If no scope is specified, it will default to action scope. - * + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Parameters</b> + * <p><b>Parameters</b></p> * * <!-- START SNIPPET: params --> * @@ -68,7 +69,7 @@ import com.opensymphony.xwork2.util.ValueStack; * * <!-- END SNIPPET: params --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Text.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Text.java b/core/src/main/java/org/apache/struts2/components/Text.java index a26a2dd..513a2aa 100644 --- a/core/src/main/java/org/apache/struts2/components/Text.java +++ b/core/src/main/java/org/apache/struts2/components/Text.java @@ -37,27 +37,26 @@ import java.util.List; /** * <!-- START SNIPPET: javadoc --> + * <p> * Render a I18n text message. + * </p> * - * <p/> - * + * <p> * 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> * - * <p/> - * + * <p> * If the named message is not found in a property file, then the body of the * tag will be used as default message. If no body is used, then the stack will * be searched, and if a value is returned, it will written to the output. * If no value is found on the stack, the key of the message will be written out. - * + * </p> * <!-- END SNIPPET: javadoc --> * - * - * * <!-- START SNIPPET: params --> * * <ul> @@ -66,9 +65,10 @@ import java.util.List; * * <!-- END SNIPPET: params --> * - * <p/> - * + * <p> * Example: + * </p> + * * <pre> * <!-- START SNIPPET: exdescription --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/TextArea.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/TextArea.java b/core/src/main/java/org/apache/struts2/components/TextArea.java index 6e27687..968d42e 100644 --- a/core/src/main/java/org/apache/struts2/components/TextArea.java +++ b/core/src/main/java/org/apache/struts2/components/TextArea.java @@ -33,7 +33,7 @@ import javax.servlet.http.HttpServletResponse; * Render HTML textarea tag.</p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/TextField.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/TextField.java b/core/src/main/java/org/apache/struts2/components/TextField.java index cae5cda..a5b7365 100644 --- a/core/src/main/java/org/apache/struts2/components/TextField.java +++ b/core/src/main/java/org/apache/struts2/components/TextField.java @@ -30,14 +30,16 @@ import javax.servlet.http.HttpServletResponse; /** * <!-- START SNIPPET: javadoc --> - * Render an HTML input field of type text</p> + * <p>Render an HTML input field of type text</p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> - * <p/> + * <p><b>Examples</b></p> + * <p> * <!-- START SNIPPET: exdescription --> * In this example, a text control for the "user" property is rendered. The label is also retrieved from a ResourceBundle via the key attribute. * <!-- END SNIPPET: exdescription --> + * </p> + * * <pre> * <!-- START SNIPPET: example --> * <s:textfield key="user" /> @@ -49,7 +51,6 @@ import javax.servlet.http.HttpServletResponse; * <s:textfield name="user" label="User Name" /> * <!-- END SNIPPET: example --> * </pre> - */ @StrutsTag( name="textfield", http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/Token.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/Token.java b/core/src/main/java/org/apache/struts2/components/Token.java index dc9fa7b..65bedb0 100644 --- a/core/src/main/java/org/apache/struts2/components/Token.java +++ b/core/src/main/java/org/apache/struts2/components/Token.java @@ -40,7 +40,7 @@ import com.opensymphony.xwork2.util.ValueStack; * the unique token.</p> * <!-- END SNIPPET: javadoc --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/UIBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/UIBean.java b/core/src/main/java/org/apache/struts2/components/UIBean.java index d30322a..cbceefc 100644 --- a/core/src/main/java/org/apache/struts2/components/UIBean.java +++ b/core/src/main/java/org/apache/struts2/components/UIBean.java @@ -46,9 +46,10 @@ import java.util.List; import java.util.Map; /** + * <p> * UIBean is the standard superclass of all Struts UI components. * It defines common Struts and html properties all UI components should present for usage. - * + * </p> * <!-- START SNIPPET: templateRelatedAttributes --> * * <table border="1"> @@ -99,8 +100,6 @@ import java.util.Map; * * <!-- END SNIPPET: templateRelatedAttributes --> * - * <p/> - * * <!-- START SNIPPET: generalAttributes --> * * <table border="1"> @@ -202,8 +201,6 @@ import java.util.Map; * * <!-- END SNIPPET: generalAttributes --> * - * <p/> - * * <!-- START SNIPPET: javascriptRelatedAttributes --> * * <table border="1"> @@ -299,8 +296,6 @@ import java.util.Map; * * <!-- END SNIPPET: javascriptRelatedAttributes --> * - * <p/> - * * <!-- START SNIPPET: tooltipattributes --> * * <table border="1"> @@ -345,33 +340,37 @@ import java.util.Map; * * * <!-- START SNIPPET: tooltipdescription --> + * <p> * <b>tooltipConfig is deprecated, use individual tooltip configuration attributes instead </b> + * </p> * + * <p> * Every Form UI component (in xhtml / css_xhtml or any other that extends them) can * have tooltips assigned to them. The Form component's tooltip related attribute, once * defined, will be applied to all form UI components that are created under it unless - * explicitly overriden by having the Form UI component itself defined with their own tooltip attribute. + * explicitly overridden by having the Form UI component itself defined with their own tooltip attribute. + * </p> * - * <p/> - * - * In Example 1, the textfield will inherit the tooltipDelay and tooltipIconPath attribte from + * <p> + * In Example 1, the textfield will inherit the tooltipDelay and tooltipIconPath attribute from * its containing form. In other words, although it doesn't define a tooltipIconPath * attribute, it will have that attribute inherited from its containing form. + * </p> * - * <p/> - * - * In Example 2, the textfield will inherite both the tooltipDelay and + * <p> + * In Example 2, the textfield will inherit both the tooltipDelay and * tooltipIconPath attribute from its containing form, but the tooltipDelay - * attribute is overriden at the textfield itself. Hence, the textfield actually will + * attribute is overridden at the textfield itself. Hence, the textfield actually will * have its tooltipIcon defined as /myImages/myIcon.gif, inherited from its containing form, and * tooltipDelay defined as 5000. + * </p> * - * <p/> - * + * <p> * Example 3, 4 and 5 show different ways of setting the tooltip configuration attribute.<br/> * <b>Example 3:</b> Set tooltip config through the body of the param tag<br/> * <b>Example 4:</b> Set tooltip config through the value attribute of the param tag<br/> * <b>Example 5:</b> Set tooltip config through the tooltip attributes of the component tag<br/> + * </p> * * <!-- END SNIPPET: tooltipdescription --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/URL.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/URL.java b/core/src/main/java/org/apache/struts2/components/URL.java index a8eed35..4da6d64 100644 --- a/core/src/main/java/org/apache/struts2/components/URL.java +++ b/core/src/main/java/org/apache/struts2/components/URL.java @@ -81,7 +81,7 @@ import java.io.Writer; * * <!-- END SNIPPET: params --> * - * <p/> <b>Examples</b> + * <p><b>Examples</b></p> * <pre> * <!-- START SNIPPET: example --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/UpDownSelect.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/UpDownSelect.java b/core/src/main/java/org/apache/struts2/components/UpDownSelect.java index 150c5b5..210b419 100644 --- a/core/src/main/java/org/apache/struts2/components/UpDownSelect.java +++ b/core/src/main/java/org/apache/struts2/components/UpDownSelect.java @@ -35,15 +35,13 @@ import java.util.Map; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * Create a Select component with buttons to move the elements in the select component * up and down. When the containing form is submited, its elements will be submitted in * the order they are arranged (top to bottom). - * + * </p> * <!-- END SNIPPET: javadoc --> * - * <p/> - * * <pre> * <!-- START SNIPPET: example --> * @@ -72,8 +70,6 @@ import java.util.Map; * <!-- END SNIPPET: example --> * </pre> * - * @version $Date$ $Id$ - * * @s.tag name="updownselect" tld-body-content="JSP" tld-tag-class="org.apache.struts2.views.jsp.ui.UpDownSelectTag" * description="Render a up down select element" */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/template/Template.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/template/Template.java b/core/src/main/java/org/apache/struts2/components/template/Template.java index 361dcb6..40c30fc 100644 --- a/core/src/main/java/org/apache/struts2/components/template/Template.java +++ b/core/src/main/java/org/apache/struts2/components/template/Template.java @@ -25,10 +25,10 @@ import java.util.ArrayList; import java.util.List; /** - * A template. - * <p/> + * <p> * A template is used as a model for rendering output. * This object contains basic common template information + * </p> */ public class Template implements Cloneable { String dir; http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/components/template/TemplateEngineManager.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/components/template/TemplateEngineManager.java b/core/src/main/java/org/apache/struts2/components/template/TemplateEngineManager.java index bd8c3b4..a93d39e 100644 --- a/core/src/main/java/org/apache/struts2/components/template/TemplateEngineManager.java +++ b/core/src/main/java/org/apache/struts2/components/template/TemplateEngineManager.java @@ -64,9 +64,14 @@ public class TemplateEngineManager { } /** + * <p> * Registers the given template engine. - * <p/> + * </p> + * + * <p> * Will add the engine to the existing list of known engines. + * </p> + * * @param templateExtension filename extension (eg. .jsp, .ftl, .vm). * @param templateEngine the engine. */ @@ -79,11 +84,13 @@ public class TemplateEngineManager { } /** + * <p> * Gets the TemplateEngine for the template name. If the template name has an extension (for instance foo.jsp), then * this extension will be used to look up the appropriate TemplateEngine. If it does not have an extension, it will * look for a Configuration setting "struts.ui.templateSuffix" for the extension, and if that is not set, it * will fall back to "ftl" as the default. - * + * </p> + * * @param template Template used to determine which TemplateEngine to return * @param templateTypeOverride Overrides the default template type * @return the engine. http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/dispatcher/DefaultStaticContentLoader.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/dispatcher/DefaultStaticContentLoader.java b/core/src/main/java/org/apache/struts2/dispatcher/DefaultStaticContentLoader.java index ef8505b..d072834 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/DefaultStaticContentLoader.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/DefaultStaticContentLoader.java @@ -38,24 +38,31 @@ import java.net.URLDecoder; import java.util.*; /** + * <p> * <b>Default implementation to server static content</b> - * <p/> + * </p> + * + * <p> * This class is used to serve common static content needed when using various parts of Struts, such as JavaScript * files, CSS files, etc. It works by looking for requests to /struts/* (or /static/*), and then mapping the value after "/struts/" * to common packages in Struts and, optionally, in your class path. By default, the following packages are * automatically searched: + * </p> + * * <ul> * <li>org.apache.struts2.static</li> * <li>template</li> * <li>static</li> * </ul> - * <p/> This means that you can simply request /struts/xhtml/styles.css and the XHTML UI theme's default stylesheet + * + * <p> + * This means that you can simply request /struts/xhtml/styles.css and the XHTML UI theme's default stylesheet * will be returned. Likewise, many of the AJAX UI components require various JavaScript files, which are found in the * org.apache.struts2.static package. If you wish to add additional packages to be searched, you can add a comma * separated (space, tab and new line will do as well) list in the filter init parameter named "packages". <b>Be * careful</b>, however, to expose any packages that may have sensitive information, such as properties file with * database access credentials. - * <p/> + * </p> */ public class DefaultStaticContentLoader implements StaticContentLoader { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java b/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java index a63e503..b56db9c 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java @@ -127,11 +127,15 @@ public class Dispatcher { private static final String DEFAULT_CONFIGURATION_PATHS = "struts-default.xml,struts-plugin.xml,struts.xml"; /** + * <p> * Store state of STRUTS_DISPATCHER_PARAMETERSWORKAROUND. - * <p/> + * </p> + * + * <p> * The workaround is for WebLogic. - * We try to autodect WebLogic on Dispatcher init. + * We try to autodetect WebLogic on Dispatcher init. * The workaround can also be enabled manually. + * </p> */ private boolean paramsWorkaroundEnabled = false; @@ -490,14 +494,18 @@ public class Dispatcher { } /** + * <p> * Load Action class for mapping and invoke the appropriate Action method, or go directly to the Result. - * <p/> + * </p> + * + * <p> * This method first creates the action context from the given parameters, * and then loads an <tt>ActionProxy</tt> from the given action name and namespace. * After that, the Action method is executed and output channels through the response object. * Actions not found are sent back to the user via the {@link Dispatcher#sendError} method, * using the 404 return code. * All other errors are reported by throwing a ServletException. + * </p> * * @param request the HttpServletRequest object * @param response the HttpServletResponse object http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/dispatcher/mapper/ActionMapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/dispatcher/mapper/ActionMapper.java b/core/src/main/java/org/apache/struts2/dispatcher/mapper/ActionMapper.java index bb42556..bc17881 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/mapper/ActionMapper.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/mapper/ActionMapper.java @@ -27,21 +27,27 @@ import javax.servlet.http.HttpServletRequest; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * The ActionMapper interface provides a mapping between HTTP requests and action invocation requests and vice-versa. - * <p/> + * </p> + * + * <p> * When given an HttpServletRequest, the ActionMapper may return null if no action invocation request matches, * or it may return an {@link ActionMapping} that describes an action invocation for the framework to try. - * <p/> + * </p> + * + * <p> * The ActionMapper is not required to guarantee that the {@link ActionMapping} returned be a real action or otherwise * ensure a valid request. * Accordingly, most ActionMappers do not need to consult the Struts configuration * just to determine if a request should be mapped. - * <p/> + * </p> + * + * <p> * Just as requests can be mapped from HTTP to an action invocation, the opposite is true as well. * However, because HTTP requests (when shown in HTTP responses) must be in String form, * a String is returned rather than an actual request object. - * + * </p> * <!-- END SNIPPET: javadoc --> */ public interface ActionMapper { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java b/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java index d5b9e4e..4933765 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java @@ -42,39 +42,43 @@ import java.util.regex.Pattern; /** * <!-- START SNIPPET: javadoc --> - * <p/> + * <p> * Default action mapper implementation, using the standard *.[ext] (where ext * usually "action") pattern. The extension is looked up from the Struts * configuration key <b>struts.action.extension</b>. - * <p/> - * <p/> To help with dealing with buttons and other related requirements, this + * </p> + * + * <p> + * To help with dealing with buttons and other related requirements, this * mapper (and other {@link ActionMapper}s, we hope) has the ability to name a * button with some predefined prefix and have that button name alter the * execution behaviour. The four prefixes are: - * <p/> + * </p> + * * <ul> * <li>Method prefix - <i>method:default</i></li> * <li>Action prefix - <i>action:dashboard</i></li> * </ul> - * <p/> + * + * <p> * In addition to these four prefixes, this mapper also understands the * action naming pattern of <i>foo!bar</i> in either the extension form (eg: * foo!bar.action) or in the prefix form (eg: action:foo!bar). This syntax tells * this mapper to map to the action named <i>foo</i> and the method <i>bar</i>. - * <p/> + * </p> * <!-- END SNIPPET: javadoc --> * <b>Method Prefix</b> * <!-- START SNIPPET: method --> - * <p/> + * <p> * With method-prefix, instead of calling baz action's execute() method (by * default if it isn't overriden in struts.xml to be something else), the baz * action's anotherMethod() will be called. A very elegant way determine which * button is clicked. Alternatively, one would have submit button set a * particular value on the action when clicked, and the execute() method decides * on what to do with the setted value depending on which button is clicked. - * <p/> + * </p> * <!-- END SNIPPET: method --> - * <p/> + * * <pre> * <!-- START SNIPPET: method-example --> * <s:form action="baz"> @@ -86,14 +90,14 @@ import java.util.regex.Pattern; * </pre> * <b>Action prefix</b> * <!-- START SNIPPET: action --> - * <p/> + * <p> * With action-prefix, instead of executing baz action's execute() method (by - * default if it isn't overriden in struts.xml to be something else), the - * anotherAction action's execute() method (assuming again if it isn't overriden + * default if it isn't overridden in struts.xml to be something else), the + * anotherAction action's execute() method (assuming again if it isn't overridden * with something else in struts.xml) will be executed. - * <p/> + * </p> * <!-- END SNIPPET: action --> - * <p/> + * * <pre> * <!-- START SNIPPET: action-example --> * <s:form action="baz"> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/dispatcher/mapper/PrefixBasedActionMapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/dispatcher/mapper/PrefixBasedActionMapper.java b/core/src/main/java/org/apache/struts2/dispatcher/mapper/PrefixBasedActionMapper.java index 2ecccb5..457279a 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/mapper/PrefixBasedActionMapper.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/mapper/PrefixBasedActionMapper.java @@ -16,24 +16,24 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * - * A prefix based action mapper that is capable of delegating to other {@link ActionMapper}s based on the request's prefix - * - * It is configured through struts.xml - * + * <p> + * A prefix based action mapper that is capable of delegating to other {@link ActionMapper}s based on the request's prefix.<br> + * It is configured through struts.xml<br> * For example, with the following entries in struts.properties + * </p> * * <pre> * <constant name="struts.mapper.class" value="org.apache.struts2.dispatcher.mapper.PrefixBasedActionMapper"/> * <constant name="struts.mapper.prefixMapping" value="/communities:pseudoRestful,/communityTags:pseudoRestful,/events:pseudoRestful,/mediaList:pseudoRestful,/users:pseudoRestful,/community:struts,/communityTag:struts,/event:struts,/media:struts,/user:struts,:struts"/> * </pre> - * <p/> + * + * <p> * When {@link PrefixBasedActionMapper#getMapping(HttpServletRequest, ConfigurationManager)} or * {@link PrefixBasedActionMapper#getUriFromActionMapping(ActionMapping)} is invoked, * {@link PrefixBasedActionMapper} will check each possible prefix (url prefix terminating just before a /) to find the most specific ActionMapper that returns a mapping when asked to map the request. If none are found, null is returned for both * {@link PrefixBasedActionMapper#getMapping(HttpServletRequest, ConfigurationManager)} and * {@link PrefixBasedActionMapper#getUriFromActionMapping(ActionMapping)} methods. - * <p/> + * </p> * * <!-- END SNIPPET: description --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java b/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java index 3a3539e..c74bf63 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java @@ -34,20 +34,27 @@ import java.util.*; /** + * <p> * Parse a multipart request and provide a wrapper around the request. The parsing implementation used * depends on the <tt>struts.multipart.parser</tt> setting. It should be set to a class which - * extends {@link org.apache.struts2.dispatcher.multipart.MultiPartRequest}. - * <p/> + * extends {@link org.apache.struts2.dispatcher.multipart.MultiPartRequest}. + * </p> + * + * <p> * The <tt>struts.multipart.parser</tt> property should be set to <tt>jakarta</tt> for the * Jakarta implementation, <tt>pell</tt> for the Pell implementation and <tt>cos</tt> for the Jason Hunter * implementation. - * <p/> + * </p> + * + * <p> * The files are uploaded when the object is instantiated. If there are any errors they are logged using * {@link #addError(String)}. An action handling a multipart form should first check {@link #hasErrors()} * before doing any other processing. - * <p/> - * An alternate implementation, PellMultiPartRequest, is provided as a plugin. + * </p> * + * <p> + * An alternate implementation, PellMultiPartRequest, is provided as a plugin. + * </p> */ public class MultiPartRequestWrapper extends StrutsRequestWrapper { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/factory/PrefixBasedActionProxyFactory.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/factory/PrefixBasedActionProxyFactory.java b/core/src/main/java/org/apache/struts2/factory/PrefixBasedActionProxyFactory.java index 5aa1650..028a32a 100644 --- a/core/src/main/java/org/apache/struts2/factory/PrefixBasedActionProxyFactory.java +++ b/core/src/main/java/org/apache/struts2/factory/PrefixBasedActionProxyFactory.java @@ -14,18 +14,24 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> + * <p> * Prefix based factory should be used with {@link org.apache.struts2.dispatcher.mapper.PrefixBasedActionMapper} * to use appropriate {@link com.opensymphony.xwork2.ActionProxyFactory} connected with given * {@link org.apache.struts2.dispatcher.mapper.ActionMapper} + * </p> * + * <p> * Add below entry to struts.xml to enable the factory: - * <p/> + * </p> + * * <pre> * <constant name="struts.actionProxyFactory" value="prefix"/> * </pre> * + * <p> * The factory will use the same set of patterns as defined with: - * <p/> + * </p> + * * <pre> * <constant name="struts.mapper.prefixMapping" value="..."/> * </pre> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ActionMappingParametersInteceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ActionMappingParametersInteceptor.java b/core/src/main/java/org/apache/struts2/interceptor/ActionMappingParametersInteceptor.java index ba8389e..93f527b 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ActionMappingParametersInteceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ActionMappingParametersInteceptor.java @@ -32,35 +32,40 @@ import java.util.TreeMap; /** * <!-- START SNIPPET: description --> + * <p> * This interceptor sets all parameters from the action mapping, for this request, on the value stack. It operates * exactly like {@link ParametersInterceptor}, only the parameters come from the {@link ActionMapping}, not the * {@link ActionContext#getParameters()} method. + * </p> + * * <!-- END SNIPPET: description --> - * <p/> - * <p/> <u>Interceptor parameters:</u> - * <p/> + * + * <p><u>Interceptor parameters:</u></p> + * * <!-- START SNIPPET: parameters --> - * <p/> + * * <ul> - * <p/> + * * <li>ordered - set to true if you want the top-down property setter behaviour</li> - * <p/> + * * </ul> - * <p/> + * * <!-- END SNIPPET: parameters --> - * <p/> - * <p/> <u>Extending the interceptor:</u> - * <p/> + * + * <p><u>Extending the interceptor:</u></p> + * * <!-- START SNIPPET: extending --> - * <p/> - * <p/> The best way to add behavior to this interceptor is to utilize the {@link com.opensymphony.xwork2.interceptor.ParameterNameAware} interface in your + * + * <p> + * The best way to add behavior to this interceptor is to utilize the {@link com.opensymphony.xwork2.interceptor.ParameterNameAware} interface in your * actions. However, if you wish to apply a global rule that isn't implemented in your action, then you could extend * this interceptor and override the {@link #acceptableName(String)} method. - * <p/> + * </p> + * * <!-- END SNIPPET: extending --> - * <p/> - * <p/> <u>Example code:</u> - * <p/> + * + * <p><u>Example code:</u></p> + * * <pre> * <!-- START SNIPPET: example --> * <action name="someAction" class="com.examples.SomeAction"> @@ -91,9 +96,10 @@ public class ActionMappingParametersInteceptor extends ParametersInterceptor { * * @param ac The action context * @param newParams The parameter map to apply - * <p/> + * <p> * In this class this is a no-op, since the parameters were fetched from the same location. * In subclasses both retrieveParameters() and addParametersToContext() should be overridden. + * </p> */ @Override protected void addParametersToContext(ActionContext ac, Map newParams) { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ApplicationAware.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ApplicationAware.java b/core/src/main/java/org/apache/struts2/interceptor/ApplicationAware.java index 78ac18a..a686086 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ApplicationAware.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ApplicationAware.java @@ -25,12 +25,14 @@ import java.util.Map; /** + * <p> * Actions that want to be aware of the application Map object should implement this interface. * This will give them access to a Map where they can put objects that should be available - * to other parts of the application. <p> - * <p/> + * to other parts of the application. + * </p> + * <p> * Typical uses are configuration objects and caches. - * + * </p> */ public interface ApplicationAware {
