You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by jo...@apache.org on 2015/07/24 20:27:57 UTC
[12/15] struts git commit: WW-4531- Improve javadoc to be compatible
with more strict JDK8 javadoc standard
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/DoubleRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/DoubleRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/DoubleRangeFieldValidator.java
index 1a5fb3b..614931c 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/DoubleRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/DoubleRangeFieldValidator.java
@@ -36,7 +36,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -149,63 +149,71 @@ import java.lang.annotation.Target;
public @interface DoubleRangeFieldValidator {
/**
- * Double property. The inclusive minimum the number must be.
+ * Double property.
+ *
+ * @return The inclusive minimum the number must be.
*/
String minInclusive() default "";
/**
- * The inclusive minimum the number must be defined as an expression
+ * @return The inclusive minimum the number must be defined as an expression
*/
String minInclusiveExpression() default "";
/**
- * Double property. The inclusive minimum the number must be.
+ * Double property.
+ *
+ * @return The inclusive minimum the number must be.
*/
String maxInclusive() default "";
/**
- * The inclusive minimum the number must be defined as an expression
+ * @return The inclusive minimum the number must be defined as an expression
*/
String maxInclusiveExpression() default "";
/**
- * Double property. The exclusive maximum number can be.
+ * Double property.
+ *
+ * @return The exclusive maximum number can be.
*/
String minExclusive() default "";
/**
- * The exclusive maximum number can be defined as an expression
+ * @return The exclusive maximum number can be defined as an expression
*/
String minExclusiveExpression() default "";
/**
- * Double property. The exclusive maximum number can be.
+ * Double property.
+ *
+ * @return The exclusive maximum number can be.
*/
String maxExclusive() default "";
/**
- * The exclusive maximum number can be defined as an expression
+ * @return The exclusive maximum number can be defined as an expression
*/
String maxExclusiveExpression() default "";
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -214,11 +222,12 @@ public @interface DoubleRangeFieldValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/EmailValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/EmailValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/EmailValidator.java
index ec54c05..a96ad6d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/EmailValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/EmailValidator.java
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -96,23 +96,23 @@ import java.lang.annotation.Target;
public @interface EmailValidator {
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -121,11 +121,12 @@ public @interface EmailValidator {
*
* Adds the short-circuit='true' attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ExpressionValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ExpressionValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ExpressionValidator.java
index 7943750..d5db360 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ExpressionValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ExpressionValidator.java
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -90,24 +90,24 @@ import java.lang.annotation.Target;
public @interface ExpressionValidator {
/**
- * The expressions to validate.
+ * @return The expressions to validate.
* An OGNL expression that returns a boolean value.
*/
String expression();
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
@@ -116,6 +116,7 @@ public @interface ExpressionValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/FieldExpressionValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/FieldExpressionValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/FieldExpressionValidator.java
index 83859d4..559c53d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/FieldExpressionValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/FieldExpressionValidator.java
@@ -37,7 +37,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -98,28 +98,28 @@ import java.lang.annotation.Target;
public @interface FieldExpressionValidator {
/**
- * An OGNL expression that returns a boolean value.
+ * @return An OGNL expression that returns a boolean value.
*/
String expression();
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -128,6 +128,7 @@ public @interface FieldExpressionValidator {
*
* Adds the short-circuit='true' attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/IntRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/IntRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/IntRangeFieldValidator.java
index daa29c5..b3ccaff 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/IntRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/IntRangeFieldValidator.java
@@ -36,7 +36,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -134,43 +134,47 @@ import java.lang.annotation.Target;
public @interface IntRangeFieldValidator {
/**
- * Integer property. The minimum the number must be.
+ * Integer property.
+ *
+ * @return The minimum the number must be.
*/
String min() default "";
/**
- * The minimum number can be defined as an expression
+ * @return The minimum number can be defined as an expression
*/
String minExpression() default "";
/**
- * Integer property. The maximum number can be.
+ * Integer property.
+ *
+ * @return The maximum number can be.
*/
String max() default "";
/**
- * The maximum number can be defined as an expression
+ * @return The maximum number can be defined as an expression
*/
String maxExpression() default "";
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -179,11 +183,12 @@ public @interface IntRangeFieldValidator {
*
* Adds the short-circuit='true' attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RegexFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RegexFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RegexFieldValidator.java
index 0ef3b18..94eea0b 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RegexFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RegexFieldValidator.java
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -102,23 +102,23 @@ import java.lang.annotation.Target;
public @interface RegexFieldValidator {
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -170,11 +170,12 @@ public @interface RegexFieldValidator {
*
* Adds the short-circuit='true' attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredFieldValidator.java
index c2456e7..900d516 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredFieldValidator.java
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -97,23 +97,23 @@ import java.lang.annotation.Target;
public @interface RequiredFieldValidator {
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -122,11 +122,12 @@ public @interface RequiredFieldValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredStringValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredStringValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredStringValidator.java
index 0620ba9..b44ef0f 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredStringValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/RequiredStringValidator.java
@@ -23,7 +23,7 @@ import java.lang.annotation.Target;
/**
* <!-- START SNIPPET: description -->
- * This validator checks that a String field is not empty (i.e. non-null with a length > 0).
+ * This validator checks that a String field is not empty (i.e. non-null with a length > 0).
* <!-- END SNIPPET: description -->
*
* <p><u>Annotation usage:</u></p>
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -104,28 +104,30 @@ import java.lang.annotation.Target;
public @interface RequiredStringValidator {
/**
- * Boolean property. Determines whether the String is trimmed before performing the length check.
+ * Boolean property.
+ *
+ * @return Determines whether the String is trimmed before performing the length check.
*/
boolean trim() default true;
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -134,11 +136,12 @@ public @interface RequiredStringValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ShortRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ShortRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ShortRangeFieldValidator.java
index 8f93196..6f77971 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ShortRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ShortRangeFieldValidator.java
@@ -36,7 +36,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -132,43 +132,47 @@ import java.lang.annotation.Target;
public @interface ShortRangeFieldValidator {
/**
- * Short property. The minimum the number must be.
+ * Short property.
+ *
+ * @return The minimum the number must be.
*/
String min() default "";
/**
- * The minimum the number must be defined as an expression.
+ * @return The minimum the number must be defined as an expression.
*/
String minExpression() default "";
/**
- * Short property. The maximum number can be.
+ * Short property.
+ *
+ * @return The maximum number can be.
*/
String max() default "";
/**
- * The maximum number can be defined as an expression
+ * @return The maximum number can be defined as an expression
*/
String maxExpression() default "";
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -177,11 +181,12 @@ public @interface ShortRangeFieldValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/StringLengthFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/StringLengthFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/StringLengthFieldValidator.java
index 87d4b31..7d7d1ea 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/StringLengthFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/StringLengthFieldValidator.java
@@ -36,7 +36,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -130,53 +130,59 @@ import java.lang.annotation.Target;
public @interface StringLengthFieldValidator {
/**
- * Boolean property. Determines whether the String is trimmed before performing the length check.
+ * Boolean property.
+ *
+ * @return Determines whether the String is trimmed before performing the length check.
*/
boolean trim() default true;
/**
- * Determines whether the String is trimmed before performing the length check but defined as an expression
+ * @return Determines whether the String is trimmed before performing the length check but defined as an expression
*/
String trimExpression() default "";
/**
- * Integer property. The minimum length the String must be.
+ * Integer property.
+ *
+ * @return The minimum length the String must be.
*/
String minLength() default "";
/**
- * The minimum length the String must be defined as an expression
+ * @return The minimum length the String must be defined as an expression
*/
String minLengthExpression() default "";
/**
- * Integer property. The maximum length the String can be.
+ * Integer property.
+ *
+ * @return The maximum length the String can be.
*/
String maxLength() default "";
/**
- * The maximum length the String can be defined as an expression
+ * @return The maximum length the String can be defined as an expression
*/
String maxLengthExpression() default "";
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -185,11 +191,12 @@ public @interface StringLengthFieldValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType[] type() default {ValidatorType.FIELD};
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/UrlValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/UrlValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/UrlValidator.java
index 9ad9223..924770a 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/UrlValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/UrlValidator.java
@@ -32,23 +32,23 @@ import java.lang.annotation.Target;
public @interface UrlValidator {
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
@@ -56,21 +56,23 @@ public @interface UrlValidator {
* If this is activated, the validator will be used as short-circuit.
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
+ *
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
/**
- * The validation type for this field/method.
+ * @return The validation type for this field/method.
*/
ValidatorType type() default ValidatorType.FIELD;
/**
- * Defines regex to use to validate url
+ * @return Defines regex to use to validate url
*/
String urlRegex() default "";
/**
- * Defines regex as an expression which will be evaluated to string and used to validate url
+ * @return Defines regex as an expression which will be evaluated to string and used to validate url
*/
String urlRegexExpression() default "";
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validation.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validation.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validation.java
index 5688e1f..dd4ee6d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validation.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validation.java
@@ -36,7 +36,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -131,6 +131,8 @@ public @interface Validation {
/**
* Used for class or interface validation rules.
+ *
+ * @return array of validations
*/
Validations[] validations() default {};
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ValidationParameter.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ValidationParameter.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ValidationParameter.java
index 81390cc..edfc24d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ValidationParameter.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/ValidationParameter.java
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validations.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validations.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validations.java
index ee587ad..b4b640b 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validations.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/Validations.java
@@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
*
* <tr>
* <th class='confluenceTh'> Parameter </th>
@@ -156,6 +156,8 @@ public @interface Validations {
/**
* Custom Validation rules.
+ *
+ * @return custom validators
*/
CustomValidator[] customValidators() default {};
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/annotations/VisitorFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/VisitorFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/VisitorFieldValidator.java
index 6501748..5a63234 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/annotations/VisitorFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/annotations/VisitorFieldValidator.java
@@ -42,7 +42,7 @@ import java.lang.annotation.Target;
* <p><u>Annotation parameters:</u></p>
*
* <!-- START SNIPPET: parameters -->
- * <table class='confluenceTable'>
+ * <table class='confluenceTable' summary=''>
* <tr>
* <th class='confluenceTh'> Parameter </th>
* <th class='confluenceTh'> Required </th>
@@ -89,7 +89,7 @@ import java.lang.annotation.Target;
* <td class='confluenceTd'> appendPrefix </td>
* <td class='confluenceTd'> no </td>
* <td class='confluenceTd'> true </td>
- * <td class='confluenceTd'> Determines whether the field name of this field validator should be prepended to the field name of the visited field to determine the full field name when an error occurs. For example, suppose that the bean being validated has a "name" property. If <em>appendPrefix</em> is true, then the field error will be stored under the field "bean.name". If <em>appendPrefix</em> is false, then the field error will be stored under the field "name". <br clear="all" /> <img class="emoticon" src="/images/icons/emoticons/warning.gif" height="16" width="16" align="absmiddle" alt="" border="0"/> If you are using the VisitorFieldValidator to validate the model from a ModelDriven Action, you should set <em>appendPrefix</em> to false unless you are using "model.name" to reference the properties on your model. </td>
+ * <td class='confluenceTd'> Determines whether the field name of this field validator should be prepended to the field name of the visited field to determine the full field name when an error occurs. For example, suppose that the bean being validated has a "name" property. If <em>appendPrefix</em> is true, then the field error will be stored under the field "bean.name". If <em>appendPrefix</em> is false, then the field error will be stored under the field "name". <br> <img class="emoticon" src="/images/icons/emoticons/warning.gif" height="16" width="16" alt="" style="border: 0px; align: middle;"> If you are using the VisitorFieldValidator to validate the model from a ModelDriven Action, you should set <em>appendPrefix</em> to false unless you are using "model.name" to reference the properties on your model. </td>
* </tr>
* </table>
* <!-- END SNIPPET: parameters -->
@@ -112,6 +112,8 @@ public @interface VisitorFieldValidator {
* Determines the context to use for validating the Object property.
* If not defined, the context of the Action validator is propagated to the Object property validator.
* In the case of Action validator, this context is the Action alias.
+ *
+ * @return context
*/
String context() default "";
@@ -126,27 +128,29 @@ public @interface VisitorFieldValidator {
* If you are using the VisitorFieldValidator to validate the model from a ModelDriven Action,
* you should set appendPrefix to false unless you are using "model.name" to reference the properties
* on your model.
+ *
+ * @return true if append prefix
*/
boolean appendPrefix() default true;
/**
- * The default error message for this validator.
+ * @return The default error message for this validator.
* NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
*/
String message() default "";
/**
- * The message key to lookup for i18n.
+ * @return The message key to lookup for i18n.
*/
String key() default "";
/**
- * The optional fieldName for SIMPLE validator types.
+ * @return The optional fieldName for SIMPLE validator types.
*/
String fieldName() default "";
/**
- * Additional params to be used to customize message - will be evaluated against the Value Stack
+ * @return Additional params to be used to customize message - will be evaluated against the Value Stack
*/
String[] messageParams() default {};
@@ -155,6 +159,7 @@ public @interface VisitorFieldValidator {
*
* Adds the short-circuit="true" attribute value if <tt>true</tt>.
*
+ * @return true if validator will be used as short-circuit. Default is false.
*/
boolean shortCircuit() default false;
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConditionalVisitorFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConditionalVisitorFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConditionalVisitorFieldValidator.java
index 4c83bb6..7e92f3f 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConditionalVisitorFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConditionalVisitorFieldValidator.java
@@ -43,7 +43,7 @@ public class ConditionalVisitorFieldValidator extends VisitorFieldValidator {
* If expression evaluates to true, invoke visitor validation.
*
* @param object the object being validated
- * @throws ValidationException
+ * @throws ValidationException in case of validation problems
*/
@Override
public void validate(Object object) throws ValidationException {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConversionErrorFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConversionErrorFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConversionErrorFieldValidator.java
index 4bfb171..6c49380 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConversionErrorFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ConversionErrorFieldValidator.java
@@ -60,8 +60,8 @@ public class ConversionErrorFieldValidator extends RepopulateConversionErrorFiel
* The validation implementation must guarantee that setValidatorContext will
* be called with a non-null ValidatorContext before validate is called.
*
- * @param object
- * @throws ValidationException
+ * @param object the object to be validated
+ * @throws ValidationException in case of validation problems
*/
@Override
public void doValidate(Object object) throws ValidationException {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/DateRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/DateRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/DateRangeFieldValidator.java
index cae4a6c..0adbc5c 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/DateRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/DateRangeFieldValidator.java
@@ -50,7 +50,7 @@ import java.util.Date;
*
* <pre>
* <!-- START SNIPPET: examples -->
- * <validators>
+ * <validators>
* <!-- Plain Validator syntax -->
* <validator type="date">
* <param name="fieldName">birthday</param>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/DoubleRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/DoubleRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/DoubleRangeFieldValidator.java
index f0dfd80..8ed4e4c 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/DoubleRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/DoubleRangeFieldValidator.java
@@ -52,9 +52,9 @@ import org.apache.commons.lang3.StringUtils;
*
* <pre>
* <!-- START SNIPPET: examples -->
- * <validators>
+ * <validators>
* <!-- Plain Validator Syntax -->
- * <validator type="double">
+ * <validator type="double">
* <param name="fieldName">percentage</param>
* <param name="minInclusive">20.1</param>
* <param name="maxInclusive">50.1</param>
@@ -84,8 +84,6 @@ import org.apache.commons.lang3.StringUtils;
*
* @author Rainer Hermanns
* @author Rene Gielen
- *
- * @version $Id$
*/
public class DoubleRangeFieldValidator extends FieldValidatorSupport {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/IntRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/IntRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/IntRangeFieldValidator.java
index bcc95d4..0f1c82f 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/IntRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/IntRangeFieldValidator.java
@@ -41,9 +41,9 @@ package com.opensymphony.xwork2.validator.validators;
*
* <pre>
* <!-- START SNIPPET: examples -->
- * <validators>
+ * <validators>
* <!-- Plain Validator Syntax -->
- * <validator type="int">
+ * <validator type="int">
* <param name="fieldName">age</param>
* <param name="min">20</param>
* <param name="max">50</param>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/LongRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/LongRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/LongRangeFieldValidator.java
index d5503c3..7c2999a 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/LongRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/LongRangeFieldValidator.java
@@ -41,9 +41,9 @@ package com.opensymphony.xwork2.validator.validators;
*
* <pre>
* <!-- START SNIPPET: examples -->
- * <validators>
+ * <validators>
* <!-- Plain Validator Syntax -->
- * <validator type="long">
+ * <validator type="long">
* <param name="fieldName">age</param>
* <param name="min">20</param>
* <param name="max">50</param>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/RegexFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/RegexFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/RegexFieldValidator.java
index a107387..b931482 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/RegexFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/RegexFieldValidator.java
@@ -40,11 +40,16 @@ import java.util.regex.Pattern;
* <li>caseSensitiveExpression - String (Optional). Defines caseSensitive param as an OGNL expression - will be evaluated to Boolean.</li>
* <li>trimExpression - String (Optional). Defines trim param as an OGNL expression - will be evaluated to Boolean</li>
* </ul>
+ *
+ * <p>
* You can mix normal params with expression aware params but thus was not tested
+ * </p>
* <!-- END SNIPPET: parameters -->
*
* <!-- START SNIPPET: parameters-warning -->
+ * <p>
* Do not use ${regexExpression}, ${caseSensitiveExpression} and ${trimExpression} as an expression as this will turn into infinitive loop!
+ * </p>
* <!-- END SNIPPET: parameters-warning -->
*
* <pre>
@@ -76,7 +81,6 @@ import java.util.regex.Pattern;
* </pre>
*
* @author Quake Wang
- * @version $Date$ $Revision$
*/
public class RegexFieldValidator extends FieldValidatorSupport {
@@ -145,14 +149,14 @@ public class RegexFieldValidator extends FieldValidatorSupport {
}
/**
- * Sets the regular expression to be matched
+ * @param regex the regular expression to be matched
*/
public void setRegex(String regex) {
this.regex = regex;
}
/**
- * Sets the regular expression as an OGNL expression to be matched
+ * @param regexExpression the regular expression as an OGNL expression to be matched
*/
public void setRegexExpression(String regexExpression) {
this.regexExpression = regexExpression;
@@ -170,7 +174,7 @@ public class RegexFieldValidator extends FieldValidatorSupport {
}
/**
- * Sets whether the expression should be matched against in
+ * @param caseSensitive whether the expression should be matched against in
* a case-sensitive way. Default is <code>true</code>.
*/
public void setCaseSensitive(Boolean caseSensitive) {
@@ -178,7 +182,7 @@ public class RegexFieldValidator extends FieldValidatorSupport {
}
/**
- * Allows specify caseSensitive param as an OGNL expression
+ * @param caseSensitiveExpression Allows specify caseSensitive param as an OGNL expression
*/
public void setCaseSensitiveExpression(String caseSensitiveExpression) {
this.caseSensitiveExpression = caseSensitiveExpression;
@@ -196,7 +200,7 @@ public class RegexFieldValidator extends FieldValidatorSupport {
}
/**
- * Sets whether the expression should be trimed before matching.
+ * @param trim whether the expression should be trimed before matching.
* Default is <code>true</code>.
*/
public void setTrim(Boolean trim) {
@@ -205,6 +209,8 @@ public class RegexFieldValidator extends FieldValidatorSupport {
/**
* Allows specify trim param as an OGNL expression
+ *
+ * @param trimExpression trim param as an OGNL expression
*/
public void setTrimExpression(String trimExpression) {
this.trimExpression = trimExpression;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/RequiredStringValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/RequiredStringValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/RequiredStringValidator.java
index 1044aed..af2d807 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/RequiredStringValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/RequiredStringValidator.java
@@ -20,8 +20,8 @@ import com.opensymphony.xwork2.validator.ValidationException;
/**
* <!-- START SNIPPET: javadoc -->
- * RequiredStringValidator checks that a String field is non-null and has a length > 0.
- * (i.e. it isn't ""). The "trim" parameter determines whether it will {@link String#trim() trim}
+ * RequiredStringValidator checks that a String field is non-null and has a length > 0.
+ * (i.e. it isn't ""). 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 -->
*
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/ShortRangeFieldValidator.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ShortRangeFieldValidator.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ShortRangeFieldValidator.java
index 24a20e2..8e5a9e6 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ShortRangeFieldValidator.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ShortRangeFieldValidator.java
@@ -41,9 +41,9 @@ package com.opensymphony.xwork2.validator.validators;
*
* <pre>
* <!-- START SNIPPET: examples -->
- * <validators>
+ * <validators>
* <!-- Plain Validator Syntax -->
- * <validator type="short">
+ * <validator type="short">
* <param name="fieldName">age</param>
* <param name="min">20</param>
* <param name="max">50</param>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/com/opensymphony/xwork2/validator/validators/ValidatorSupport.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ValidatorSupport.java b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ValidatorSupport.java
index 1ca43b0..1df9450 100644
--- a/core/src/main/java/com/opensymphony/xwork2/validator/validators/ValidatorSupport.java
+++ b/core/src/main/java/com/opensymphony/xwork2/validator/validators/ValidatorSupport.java
@@ -174,7 +174,7 @@ public abstract class ValidatorSupport implements Validator, ShortCircuitableVal
* @param name name of the field
* @param object to search field name on
* @return Object as field value
- * @throws ValidationException
+ * @throws ValidationException in case of validation problems
*/
protected Object getFieldValue(String name, Object object) throws ValidationException {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 1a99e4f..9f8e67d 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
@@ -70,7 +70,7 @@ import java.util.Collection;
* </pre>
*
* <!-- START SNIPPET: explanation -->
- * <p>In the example above, if the acion's getUser() method return User object, XWork
+ * <p>In the example above, if the action's getUser() method return User object, XWork
* will look for User-myContext-validation.xml for the validators. Since appednPrefix is true,
* every field name will be prefixed with 'user' such that if the actual field name for 'name' is
* 'user.name' </p>
@@ -92,7 +92,7 @@ public class VisitorFieldValidator extends FieldValidatorSupport {
}
/**
- * Sets whether the field name of this field validator should be prepended to the field name of
+ * @param appendPrefix whether the field name of this field validator should be prepended to the field name of
* the visited field to determine the full field name when an error occurs. The default is
* true.
*/
@@ -101,7 +101,7 @@ public class VisitorFieldValidator extends FieldValidatorSupport {
}
/**
- * Flags whether the field name of this field validator should be prepended to the field name of
+ * @return whether the field name of this field validator should be prepended to the field name of
* the visited field to determine the full field name when an error occurs. The default is
* true.
*/
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/components/ActionComponent.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/struts2/components/ActionComponent.java b/core/src/main/java/org/apache/struts2/components/ActionComponent.java
index 5b1196b..3e98f6c 100644
--- a/core/src/main/java/org/apache/struts2/components/ActionComponent.java
+++ b/core/src/main/java/org/apache/struts2/components/ActionComponent.java
@@ -84,33 +84,33 @@ import java.util.Map;
*
* <pre>
* <!-- START SNIPPET: strutsxml -->
- * <xwork>
+ * <xwork>
* ....
- * <action name="actionTagAction1" class="tmjee.testing.ActionTagAction">
- * <result name="done">success.jsp</result>
- * </action>
- * <action name="actionTagAction2" class="tmjee.testing.ActionTagAction" method="default">
- * <result name="done">success.jsp</result>
- * </action>
+ * <action name="actionTagAction1" class="tmjee.testing.ActionTagAction">
+ * <result name="done">success.jsp</result>
+ * </action>
+ * <action name="actionTagAction2" class="tmjee.testing.ActionTagAction" method="default">
+ * <result name="done">success.jsp</result>
+ * </action>
* ....
- * </xwork>
+ * </xwork>
* <!-- END SNIPPET: strutsxml -->
* </pre>
*
* <pre>
* <!-- START SNIPPET: example -->
- * <div>The following action tag will execute result and include it in this page</div>
- * <br />
- * <s:action name="actionTagAction" executeResult="true" />
- * <br />
- * <div>The following action tag will do the same as above, but invokes method specialMethod in action</div>
- * <br />
- * <s:action name="actionTagAction!specialMethod" executeResult="true" />
- * <br />
- * <div>The following action tag will not execute result, but put a String in request scope
- * under an id "stringByAction" which will be retrieved using property tag</div>
- * <s:action name="actionTagAction!default" executeResult="false" />
- * <s:property value="#attr.stringByAction" />
+ * <span>The following action tag will execute result and include it in this page</span>
+ * <br>
+ * <s:action name="actionTagAction" executeResult="true" />
+ * <br>
+ * <span>The following action tag will do the same as above, but invokes method specialMethod in action</span>
+ * <br>
+ * <s:action name="actionTagAction!specialMethod" executeResult="true" />
+ * <br>
+ * <span>The following action tag will not execute result, but put a String in request scope
+ * under an id "stringByAction" which will be retrieved using property tag</span>
+ * <s:action name="actionTagAction!default" executeResult="false" />
+ * <s:property value="#attr.stringByAction" />
* <!-- END SNIPPET: example -->
* </pre>
*
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 bb0b913..d01e63b 100644
--- a/core/src/main/java/org/apache/struts2/components/Bean.java
+++ b/core/src/main/java/org/apache/struts2/components/Bean.java
@@ -58,7 +58,7 @@ import java.io.Writer;
* <-- in freemarker form -->
* [@s.bean name="org.apache.struts2.example.counter.SimpleCounter" var="counter"]
* [s:param name="foo" value="BAR"/]
- * The value of foo is : [s:property value="foo"/], when inside the bean tag.<br />
+ * The value of foo is : [s:property value="foo"/], when inside the bean tag.
* [/s:bean]
*
* <-- in jsp form -->
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 99ae38d..e2f98b6 100644
--- a/core/src/main/java/org/apache/struts2/components/ComboBox.java
+++ b/core/src/main/java/org/apache/struts2/components/ComboBox.java
@@ -68,24 +68,24 @@ import java.util.Map;
* </s:bean>
*
* <-- Example Two -->
- * <s:combobox
+ * <s:combobox
* label="My Favourite Fruit"
* name="myFavouriteFruit"
* list="{'apple','banana','grape','pear'}"
* headerKey="-1"
* headerValue="--- Please Select ---"
* emptyOption="true"
- * value="banana" />
+ * value="banana" />
*
* <-- Example Two -->
- * <s:combobox
+ * <s:combobox
* label="My Favourite Color"
* name="myFavouriteColor"
* list="#{'red':'red','green':'green','blue':'blue'}"
* headerKey="-1"
* headerValue="--- Please Select ---"
* emptyOption="true"
- * value="green" />
+ * value="green" />
*
* Velocity:
* #tag( ComboBox "label=Birth year" "size=6" "maxlength=4" "name=birthYear" "list=#year" )
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 2fd8c14..f6ab54c 100644
--- a/core/src/main/java/org/apache/struts2/components/Component.java
+++ b/core/src/main/java/org/apache/struts2/components/Component.java
@@ -226,14 +226,14 @@ public class Component {
/**
* Evaluates the OGNL stack to find a String value.
* <br>
- * If the given expression is <tt>null</tt/> a error is logged and a <code>RuntimeException</code> is thrown
+ * 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.
*
* @param expr OGNL expression.
* @param field field name used when throwing <code>RuntimeException</code>.
* @param errorMsg error message used when throwing <code>RuntimeException</code>.
* @return the String value found.
- * @throws StrutsException is thrown in case of expression is <tt>null</tt>.
+ * @throws StrutsException is thrown in case of expression is null.
*/
protected String findString(String expr, String field, String errorMsg) {
if (expr == null) {
@@ -289,16 +289,15 @@ public class Component {
}
/**
- * Is the altSyntax enabled? [TRUE]
- * <br>
* See <code>struts.properties</code> where the altSyntax flag is defined.
+ * @return if the altSyntax enabled? [TRUE]
*/
public boolean altSyntax() {
return ComponentUtils.altSyntax(stack);
}
/**
- * Adds the sorrounding %{ } to the expression for proper processing.
+ * Adds the surrounding %{ } to the expression for proper processing.
* @param expr the expression.
* @return the modified expression if altSyntax is enabled, or the parameter
* expression otherwise.
@@ -330,7 +329,7 @@ public class Component {
*
* <p>
* Function just like <code>findValue(String)</code> except that if the
- * given expression is <tt>null</tt/> a error is logged and
+ * 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.
* </p>
@@ -394,7 +393,7 @@ public class Component {
* @param includeContext should the context path be included or not
* @param encodeResult should the url be encoded
* @param forceAddSchemeHostAndPort should the scheme host and port be forced
- * @param escapeAmp should ampersand (&) be escaped to &
+ * @param escapeAmp should ampersand (&) be escaped to &amp;
* @return the action url.
*/
protected String determineActionURL(String action, String namespace, String method,
@@ -533,6 +532,8 @@ public class Component {
/**
* If needed caches all methods annotated by given annotation to avoid further scans
+ *
+ * @return list of attributes
*/
protected Collection<String> getStandardAttributes() {
Class clz = getClass();
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/components/ComponentUrlProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/struts2/components/ComponentUrlProvider.java b/core/src/main/java/org/apache/struts2/components/ComponentUrlProvider.java
index 4a5c88c..d8e32c9 100644
--- a/core/src/main/java/org/apache/struts2/components/ComponentUrlProvider.java
+++ b/core/src/main/java/org/apache/struts2/components/ComponentUrlProvider.java
@@ -57,7 +57,7 @@ public class ComponentUrlProvider implements UrlProvider {
/**
*
* @param component The component used to delegate some calls to
- * @param parameters parameters passed from <param...>
+ * @param parameters parameters passed from <param...>
*/
public ComponentUrlProvider(Component component, Map parameters) {
this.component = component;
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/core/src/main/java/org/apache/struts2/components/ContextBean.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/struts2/components/ContextBean.java b/core/src/main/java/org/apache/struts2/components/ContextBean.java
index 6ef8b74..fb3f463 100644
--- a/core/src/main/java/org/apache/struts2/components/ContextBean.java
+++ b/core/src/main/java/org/apache/struts2/components/ContextBean.java
@@ -51,6 +51,8 @@ public abstract class ContextBean extends Component {
/**
* To keep backward compatibility
* TODO remove after 2.1
+ *
+ * @param id the given id
*/
@StrutsTagAttribute(description="Deprecated. Use 'var' instead")
public void setId(String id) {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 befc1eb..6500ef5 100644
--- a/core/src/main/java/org/apache/struts2/components/Date.java
+++ b/core/src/main/java/org/apache/struts2/components/Date.java
@@ -47,29 +47,36 @@ import java.util.TimeZone;
* You can specify a <b>custom format</b> (eg. "dd/MM/yyyy hh:mm"), you can generate
* <b>easy readable notations</b> (like "in 2 hours, 14 minutes"), or you can just fall back
* on a <b>predefined format</b> with key 'struts.date.format' in your properties file.
+ * </p>
*
+ * <p>
* If that key is not defined, it will finally fall back to the default DateFormat.MEDIUM
* formatting.
+ * </p>
*
+ * <p>
* <b>Note</b>: If the requested Date object isn't found on the stack, a blank will be returned.
* </p>
*
- * Configurable attributes are :-
+ * <p>
+ * Configurable attributes are:
+ * </p>
+ *
* <ul>
* <li>name</li>
* <li>nice</li>
* <li>format</li>
* </ul>
*
- * <br>
- *
+ * <p>
* 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>
- *
+ * <p>
* <b><u>Condition 1: With nice attribute as true</u></b>
- * <table border="1">
+ * </p>
+ * <table border="1" summary="">
* <tr>
* <td>i18n key</td>
* <td>default</td>
@@ -88,31 +95,32 @@ import java.util.TimeZone;
* </tr>
* <tr>
* <td>struts.date.format.minutes</td>
- * <td>{0,choice,1#one minute|1<{0} minutes}</td>
+ * <td>{0,choice,1#one minute|1<{0} minutes}</td>
* </tr>
* <tr>
* <td>struts.date.format.hours</td>
- * <td>{0,choice,1#one hour|1<{0} hours}{1,choice,0#|1#, one minute|1<, {1} minutes}</td>
+ * <td>{0,choice,1#one hour|1<{0} hours}{1,choice,0#|1#, one minute|1<, {1} minutes}</td>
* </tr>
* <tr>
* <td>struts.date.format.days</td>
- * <td>{0,choice,1#one day|1<{0} days}{1,choice,0#|1#, one hour|1<, {1} hours}</td>
+ * <td>{0,choice,1#one day|1<{0} days}{1,choice,0#|1#, one hour|1<, {1} hours}</td>
* </tr>
* <tr>
* <td>struts.date.format.years</td>
- * <td>{0,choice,1#one year|1<{0} years}{1,choice,0#|1#, one day|1<, {1} days}</td>
+ * <td>{0,choice,1#one year|1<{0} years}{1,choice,0#|1#, one day|1<, {1} days}</td>
* </tr>
* </table>
*
- * <br>
- *
+ * <p>
* <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>
+ * <p>In this case the format attribute will be used.</p>
*
+ * <p>
* <b><u>Condition 3: With nice attribute as false and no format attribute is specified </u></b>
- * <table border="1">
+ * </p>
+ * <table border="1" summary="">
* <tr>
* <td>i18n key</td>
* <td>default</td>
@@ -163,25 +171,25 @@ public class Date extends ContextBean {
public static final String DATETAG_PROPERTY_SECONDS = "struts.date.format.seconds";
private static final String DATETAG_DEFAULT_SECONDS = "an instant";
/**
- * Property name that defines the minutes notation (default: {0,choice,1#one minute|1<{0} minutes})
+ * Property name that defines the minutes notation (default: {0,choice,1#one minute|1<{0} minutes})
*/
public static final String DATETAG_PROPERTY_MINUTES = "struts.date.format.minutes";
private static final String DATETAG_DEFAULT_MINUTES = "{0,choice,1#one minute|1<{0} minutes}";
/**
- * Property name that defines the hours notation (default: {0,choice,1#one hour|1<{0} hours}{1,choice,0#|1#, one
- * minute|1<, {1} minutes})
+ * Property name that defines the hours notation (default: {0,choice,1#one hour|1<{0} hours}{1,choice,0#|1#, one
+ * minute|1>, {1} minutes})
*/
public static final String DATETAG_PROPERTY_HOURS = "struts.date.format.hours";
private static final String DATETAG_DEFAULT_HOURS = "{0,choice,1#one hour|1<{0} hours}{1,choice,0#|1#, one minute|1<, {1} minutes}";
/**
- * Property name that defines the days notation (default: {0,choice,1#one day|1<{0} days}{1,choice,0#|1#, one hour|1<,
+ * Property name that defines the days notation (default: {0,choice,1#one day|1<{0} days}{1,choice,0#|1#, one hour|1<,
* {1} hours})
*/
public static final String DATETAG_PROPERTY_DAYS = "struts.date.format.days";
private static final String DATETAG_DEFAULT_DAYS = "{0,choice,1#one day|1<{0} days}{1,choice,0#|1#, one hour|1<, {1} hours}";
/**
- * Property name that defines the years notation (default: {0,choice,1#one year|1<{0} years}{1,choice,0#|1#, one
- * day|1<, {1} days})
+ * Property name that defines the years notation (default: {0,choice,1#one year|1<{0} years}{1,choice,0#|1#, one
+ * day|1>, {1} days})
*/
public static final String DATETAG_PROPERTY_YEARS = "struts.date.format.years";
private static final String DATETAG_DEFAULT_YEARS = "{0,choice,1#one year|1<{0} years}{1,choice,0#|1#, one day|1<, {1} days}";
@@ -275,7 +283,7 @@ public class Date extends ContextBean {
java.util.Date date = null;
// find the name on the valueStack
try {
- //suport Calendar also
+ //support Calendar also
Object dateObject = findValue(name);
if (dateObject instanceof java.util.Date) {
date = (java.util.Date) dateObject;
@@ -374,8 +382,13 @@ public class Date extends ContextBean {
this.nice = nice;
}
+ @StrutsTagAttribute(description = "The specific timezone in which to format the date", required = false)
+ public void setTimezone(String timezone) {
+ this.timezone = timezone;
+ }
+
/**
- * @return Returns the name.
+ * @return the name.
*/
public String getName() {
return name;
@@ -387,29 +400,24 @@ public class Date extends ContextBean {
}
/**
- * @return Returns the format.
+ * @return the format.
*/
public String getFormat() {
return format;
}
/**
- * @return Returns the nice.
+ * @return the nice.
*/
public boolean isNice() {
return nice;
}
/**
- * @return Returns the name.
+ * @return the timezone.
*/
public String getTimezone() {
return timezone;
}
- @StrutsTagAttribute(description = "The specific timezone in which to format the date", required = false)
- public void setTimezone(String timezone) {
- this.timezone = timezone;
- }
-
}
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 69ad61e..52aaa7c 100644
--- a/core/src/main/java/org/apache/struts2/components/Form.java
+++ b/core/src/main/java/org/apache/struts2/components/Form.java
@@ -391,9 +391,10 @@ public class Form extends ClosingUIBean {
/**
* Return type of visited object.
- * @param actionClass
- * @param visitorFieldName
- * @return
+ *
+ * @param actionClass action class
+ * @param visitorFieldName field name
+ * @return type of visited object
*/
@SuppressWarnings("unchecked")
protected Class getVisitorReturnType(Class actionClass, String visitorFieldName) {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 53cbef0..0ba693e 100644
--- a/core/src/main/java/org/apache/struts2/components/GenericUIBean.java
+++ b/core/src/main/java/org/apache/struts2/components/GenericUIBean.java
@@ -103,7 +103,7 @@ import com.opensymphony.xwork2.util.ValueStack;
* Freemarker
* </p>
* <pre>
- * <@s..component template="/my/custom/component.ftl" />
+ * <@s..component template="/my/custom/component.ftl" />
*
* or
*
@@ -111,7 +111,7 @@ import com.opensymphony.xwork2.util.ValueStack;
* <@s..param name="key1" value="%{'value1'}" />
* <@s..param name="key2" value="%{'value2'}" />
* </@s..component>
- *
+ * </pre>
* <!-- END SNIPPET: example -->
*
* <p>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 37e9c43..36f0a87 100644
--- a/core/src/main/java/org/apache/struts2/components/Include.java
+++ b/core/src/main/java/org/apache/struts2/components/Include.java
@@ -238,8 +238,8 @@ public class Include extends Component {
* @param encoding the file encoding to use for including the resource; if <tt>null</tt>, it will default to the
* platform encoding
*
- * @throws ServletException
- * @throws IOException
+ * @throws ServletException in case of servlet processing errors
+ * @throws IOException in case of IO errors
*/
public static void include( String relativePath, Writer writer, ServletRequest request,
HttpServletResponse response, String encoding ) throws ServletException, IOException {
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 d0e9f39..644b389 100644
--- a/core/src/main/java/org/apache/struts2/components/Label.java
+++ b/core/src/main/java/org/apache/struts2/components/Label.java
@@ -32,7 +32,7 @@ import com.opensymphony.xwork2.util.ValueStack;
/**
* <!-- START SNIPPET: javadoc -->
- * Renders an HTML LABEL that will allow you to output label:name combination that has the same format treatment as
+ * <p>Renders an HTML LABEL that will allow you to output label:name combination that has the same format treatment as
* the rest of your UI controls.</p>
* <!-- END SNIPPET: javadoc -->
*
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 a71cd64..2f7e6bd 100644
--- a/core/src/main/java/org/apache/struts2/components/Param.java
+++ b/core/src/main/java/org/apache/struts2/components/Param.java
@@ -58,11 +58,11 @@ import java.io.Writer;
* 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.
* This is best illustrated using an example:
- * <br/><param name="color">blue</param> <-- (A) -->
- * <br/><param name="color" value="blue"/> <-- (B) -->
- * <br/>In the first situation (A) the value would be evaluated to the stack as a <tt>java.lang.String</tt> object.
+ * <br><param name="color">blue</param> <-- (A) -->
+ * <br><param name="color" value="blue"/> <-- (B) -->
+ * <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>.
+ * <br>For more information see <a href="https://issues.apache.org/jira/browse/WW-808">WW-808</a>.
* </p>
* <!-- END SNIPPET: javadoc -->
*
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 3a34b5b..6baba58 100644
--- a/core/src/main/java/org/apache/struts2/components/Property.java
+++ b/core/src/main/java/org/apache/struts2/components/Property.java
@@ -53,23 +53,21 @@ import java.io.Writer;
* <pre>
* <!-- START SNIPPET: example -->
*
- * <s:push value="myBean">
+ * <s:push value="myBean">
* <!-- Example 1: -->
- * <s:property value="myBeanProperty" />
+ * <s:property value="myBeanProperty" />
*
* <!-- Example 2: -->TextUtils
- * <s:property value="myBeanProperty" default="a default value" />
- * </s:push>
+ * <s:property value="myBeanProperty" default="a default value" />
+ * </s:push>
*
* <!-- END SNIPPET: example -->
* </pre>
*
* <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/775c82a7/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 bc46882..00c6616 100644
--- a/core/src/main/java/org/apache/struts2/components/Radio.java
+++ b/core/src/main/java/org/apache/struts2/components/Radio.java
@@ -52,7 +52,7 @@ import javax.servlet.http.HttpServletResponse;
* <!-- START SNIPPET: example_fmt -->
* <@s.radio name="car" list={"ford": "Ford Motor Co", "toyota": "Toyota"} listKey="key" listValue="value" />
* <!-- END SNIPPET: example_fmt -->
- *
+ * </pre>
*/
@StrutsTag(name="radio",
tldTagClass="org.apache.struts2.views.jsp.ui.RadioTag",
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 513a2aa..69c0344 100644
--- a/core/src/main/java/org/apache/struts2/components/Text.java
+++ b/core/src/main/java/org/apache/struts2/components/Text.java
@@ -69,13 +69,9 @@ import java.util.List;
* Example:
* </p>
*
- * <pre>
* <!-- START SNIPPET: exdescription -->
- *
- * Accessing messages from a given bundle (the i18n Shop example bundle in the first example) and using bundle defined through the framework in the second example.</p>
- *
+ * <p>Accessing messages from a given bundle (the i18n Shop example bundle in the first example) and using bundle defined through the framework in the second example.</p>
* <!-- END SNIPPET: exdescription -->
- * </pre>
*
* <pre>
* <!-- START SNIPPET: example -->
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 968d42e..234810d 100644
--- a/core/src/main/java/org/apache/struts2/components/TextArea.java
+++ b/core/src/main/java/org/apache/struts2/components/TextArea.java
@@ -30,7 +30,7 @@ import javax.servlet.http.HttpServletResponse;
/**
* <!-- START SNIPPET: javadoc -->
- * Render HTML textarea tag.</p>
+ * <p>Render HTML textarea tag.</p>
* <!-- END SNIPPET: javadoc -->
*
* <p><b>Examples</b></p>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 65bedb0..cac7679 100644
--- a/core/src/main/java/org/apache/struts2/components/Token.java
+++ b/core/src/main/java/org/apache/struts2/components/Token.java
@@ -33,8 +33,9 @@ import com.opensymphony.xwork2.util.ValueStack;
/**
* <!-- START SNIPPET: javadoc -->
- * Stop double-submission of forms.</p>
+ * <p>Stop double-submission of forms.</p>
*
+ * <p>
* The token tag is used to help with the "double click" submission problem. It is needed if you are using the
* TokenInterceptor or the TokenSessionInterceptor. The s:token tag merely places a hidden element that contains
* the unique token.</p>
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 cbceefc..aa6a5f2 100644
--- a/core/src/main/java/org/apache/struts2/components/UIBean.java
+++ b/core/src/main/java/org/apache/struts2/components/UIBean.java
@@ -52,7 +52,7 @@ import java.util.Map;
* </p>
* <!-- START SNIPPET: templateRelatedAttributes -->
*
- * <table border="1">
+ * <table border="1" summary="">
* <thead>
* <tr>
* <td>Attribute</td>
@@ -67,26 +67,26 @@ import java.util.Map;
* <td>n/a</td>
* <td>String</td>
* <td>define the template directory</td>
- * </td>
+ * </tr>
* <tr>
* <td>theme</td>
* <td>n/a</td>
* <td>String</td>
* <td>define the theme name</td>
- * </td>
+ * </tr>
* <tr>
* <td>template</td>
* <td>n/a</td>
* <td>String</td>
* <td>define the template name</td>
- * </td>
+ * </tr>
* <tr>
* <td>themeExpansionToken</td>
* <td>n/a</td>
* <td>String</td>
* <td>special token (defined with struts.ui.theme.expansion.token) used to search for template in parent theme
* (don't use it separately!)</td>
- * </td>
+ * </tr>
* <tr>
* <td>expandTheme</td>
* <td>n/a</td>
@@ -94,7 +94,7 @@ import java.util.Map;
* <td>concatenation of themeExpansionToken and theme which tells internal template loader mechanism
* to try load template from current theme and then from parent theme (and parent theme, and so on)
* when used with <#include/> directive</td>
- * </td>
+ * </tr>
* </tbody>
* </table>
*
@@ -102,7 +102,7 @@ import java.util.Map;
*
* <!-- START SNIPPET: generalAttributes -->
*
- * <table border="1">
+ * <table border="1" summary="">
* <thead>
* <tr>
* <td>Attribute</td>
@@ -203,7 +203,7 @@ import java.util.Map;
*
* <!-- START SNIPPET: javascriptRelatedAttributes -->
*
- * <table border="1">
+ * <table border="1" summary="">
* <thead>
* <tr>
* <td>Attribute</td>
@@ -298,7 +298,7 @@ import java.util.Map;
*
* <!-- START SNIPPET: tooltipattributes -->
*
- * <table border="1">
+ * <table border="1" summary="">
* <tr>
* <td>Attribute</td>
* <td>Data Type</td>
@@ -366,10 +366,10 @@ import java.util.Map;
* </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/>
+ * 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/775c82a7/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 4da6d64..6269271 100644
--- a/core/src/main/java/org/apache/struts2/components/URL.java
+++ b/core/src/main/java/org/apache/struts2/components/URL.java
@@ -50,8 +50,8 @@ import java.io.Writer;
* <p>When includeParams is 'all' or 'get', the parameter defined in a <param>
* tag will take precedence over any params included due to the includeParams attribute. For
* example, in Example 3 below, if there is a id parameter in the url where the page this
- * tag is included like http://<host>:<port>/<context>/editUser.action?id=3333&name=John
- * the generated url will be http://<host>:<port>/<context>/editUser.action?id=22&name=John
+ * tag is included like http://<host>:<port>/<context>/editUser.action?id=3333&name=John
+ * the generated url will be http://<host>:<port>/<context>/editUser.action?id=22&name=John
* because the parameter defined in the param tag will take precedence.</p>
*
* <!-- END SNIPPET: javadoc -->
http://git-wip-us.apache.org/repos/asf/struts/blob/775c82a7/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 210b419..1529cfd 100644
--- a/core/src/main/java/org/apache/struts2/components/UpDownSelect.java
+++ b/core/src/main/java/org/apache/struts2/components/UpDownSelect.java
@@ -70,7 +70,7 @@ import java.util.Map;
* <!-- END SNIPPET: example -->
* </pre>
*
- * @s.tag name="updownselect" tld-body-content="JSP" tld-tag-class="org.apache.struts2.views.jsp.ui.UpDownSelectTag"
+ * {@literal @}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"
*/
@StrutsTag(name="updownselect", tldTagClass="org.apache.struts2.views.jsp.ui.UpDownSelectTag",