This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-digester.git
The following commit(s) were added to refs/heads/master by this push:
new af6f50b1 Javadoc
af6f50b1 is described below
commit af6f50b10165eec656eb84d65b70530e4b427d05
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:05 2026 -0400
Javadoc
---
.../digester3/AbstractObjectCreationFactory.java | 2 +-
.../commons/digester3/BeanPropertySetterRule.java | 2 +-
.../apache/commons/digester3/CallMethodRule.java | 2 +-
.../apache/commons/digester3/CallParamRule.java | 2 +-
.../org/apache/commons/digester3/Digester.java | 40 +++++++++++-----------
.../apache/commons/digester3/NodeCreateRule.java | 40 +++++++++++-----------
.../apache/commons/digester3/ObjectCreateRule.java | 4 +--
.../commons/digester3/ObjectCreationFactory.java | 2 +-
.../apache/commons/digester3/ObjectParamRule.java | 4 +--
.../commons/digester3/RecordedInvocation.java | 4 +--
.../org/apache/commons/digester3/RegexMatcher.java | 4 +--
.../org/apache/commons/digester3/RegexRules.java | 2 +-
.../java/org/apache/commons/digester3/Rule.java | 14 ++++----
.../org/apache/commons/digester3/RuleMatcher.java | 4 +--
.../java/org/apache/commons/digester3/Rules.java | 2 +-
.../commons/digester3/SetNestedPropertiesRule.java | 4 +--
.../commons/digester3/SetPropertiesRule.java | 4 +--
.../commons/digester3/SimpleRegexMatcher.java | 6 ++--
.../org/apache/commons/digester3/Substitutor.java | 4 +--
.../digester3/WithDefaultsRulesWrapper.java | 4 +--
.../digester3/annotations/AnnotationHandler.java | 6 ++--
.../annotations/AnnotationHandlerFactory.java | 2 +-
.../annotations/FromAnnotationsRuleModule.java | 6 ++--
.../annotations/reflect/MethodArgument.java | 6 ++--
.../annotations/utils/AnnotationUtils.java | 10 +++---
.../commons/digester3/binder/CallParamBuilder.java | 2 +-
.../commons/digester3/binder/DigesterLoader.java | 16 ++++-----
.../digester3/binder/DigesterLoadingException.java | 8 ++---
.../digester3/binder/FromBinderRuleSet.java | 6 ++--
.../digester3/binder/LinkedRuleBuilder.java | 2 +-
.../digester3/binder/NodeCreateRuleProvider.java | 4 +--
.../digester3/binder/ObjectCreateBuilder.java | 6 ++--
.../digester3/binder/PluginCreateRuleBuilder.java | 8 ++---
.../commons/digester3/binder/RulesBinder.java | 2 +-
.../commons/digester3/plugins/PluginContext.java | 2 +-
.../digester3/plugins/PluginCreateRule.java | 16 ++++-----
.../digester3/plugins/PluginDeclarationRule.java | 2 +-
.../commons/digester3/plugins/PluginManager.java | 2 +-
.../commons/digester3/plugins/PluginRules.java | 4 +--
.../plugins/strategies/FinderFromFile.java | 2 +-
.../plugins/strategies/LoaderFromStream.java | 2 +-
.../digester3/substitution/VariableExpander.java | 2 +-
.../annotations/AbstractAnnotatedPojoTestCase.java | 2 +-
43 files changed, 134 insertions(+), 134 deletions(-)
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
index a29e9a6d..281da51b 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
@@ -38,7 +38,7 @@ public abstract class AbstractObjectCreationFactory<T>
/**
* Factory method called by {@link FactoryCreateRule} to supply an object
based on the element's attributes.
*
- * @param attributes the element's attributes
+ * @param attributes The element's attributes
* @return creates a new T instance
* @throws Exception any exception thrown will be propagated upwards
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
index 3cfd3914..b69bf406 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
@@ -195,7 +195,7 @@ public class BeanPropertySetterRule
/**
* Sets the attribute name from which the property name has to be
extracted.
*
- * @param propertyNameFromAttribute the attribute name from which the
property name has to be extracted.
+ * @param propertyNameFromAttribute The attribute name from which the
property name has to be extracted.
* @since 3.0
*/
public void setPropertyNameFromAttribute( final String
propertyNameFromAttribute )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
index 05282106..5768f807 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
@@ -454,7 +454,7 @@ public class CallMethodRule
/**
* Subclasses may override this method to perform additional processing of
the invoked method's result.
*
- * @param result the Object returned by the method invoked, possibly null
+ * @param result The Object returned by the method invoked, possibly null
*/
protected void processMethodCallResult( final Object result )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
index 4e137d50..0f7b8603 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
@@ -99,7 +99,7 @@ public class CallParamRule
* then the parameter will be set to null.
*
* @param paramIndex The zero-relative parameter number
- * @param stackIndex the index of the object which will be passed as a
parameter. The zeroth object is the top of
+ * @param stackIndex The index of the object which will be passed as a
parameter. The zeroth object is the top of
* the stack, 1 is the next object down and so on.
*/
public CallParamRule( final int paramIndex, final int stackIndex )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
index 05c22004..7c3e5cf8 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
@@ -458,7 +458,7 @@ public class Digester
* Add a "call parameter" rule that sets a parameter from the current
{@code Digester} matching path. This is
* sometimes useful when using rules that support wildcards.
*
- * @param pattern the pattern that this rule should match
+ * @param pattern The pattern that this rule should match
* @param paramIndex The zero-relative parameter number
* @see CallMethodRule
*/
@@ -1157,7 +1157,7 @@ public class Digester
/**
* Create a SAX exception which also understands about the location in the
digester file where the exception occurs
*
- * @param e the exception cause
+ * @param e The exception cause
* @return The new SAX exception
*/
public SAXException createSAXException( Exception e )
@@ -1176,7 +1176,7 @@ public class Digester
/**
* Create a SAX exception which also understands about the location in the
digester file where the exception occurs
*
- * @param message the custom SAX exception message
+ * @param message The custom SAX exception message
* @return The new SAX exception
*/
public SAXException createSAXException( final String message )
@@ -1187,8 +1187,8 @@ public class Digester
/**
* Create a SAX exception which also understands about the location in the
digester file where the exception occurs
*
- * @param message the custom SAX exception message
- * @param e the exception cause
+ * @param message The custom SAX exception message
+ * @param e The exception cause
* @return The new SAX exception
*/
public SAXException createSAXException( final String message, Exception e )
@@ -1947,7 +1947,7 @@ public class Digester
* <strong>Note:</strong> a stack is considered empty if no objects have
been pushed onto it yet.
* </p>
*
- * @param stackName the name of the stack whose emptiness should be
evaluated
+ * @param stackName The name of the stack whose emptiness should be
evaluated
* @return true if the given stack if empty
* @since 1.6
*/
@@ -1975,7 +1975,7 @@ public class Digester
* Helps casting the input object to given type, avoiding NPEs.
*
* @param <T> The type the input object has to be cast.
- * @param obj the object has to be cast.
+ * @param obj The object has to be cast.
* @return The casted object, if input object is not null, null otherwise.
* @since 3.0
*/
@@ -2198,7 +2198,7 @@ public class Digester
* </p>
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
- * @param stackName the name of the stack to be peeked
+ * @param stackName The name of the stack to be peeked
* @return The top {@code Object} on the stack or null if the stack is
either empty or has not been created yet
* @since 1.6
*/
@@ -2216,7 +2216,7 @@ public class Digester
* </p>
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
- * @param stackName the name of the stack to be peeked
+ * @param stackName The name of the stack to be peeked
* @param n Index of the desired element, where 0 is the top of the stack,
1 is the next element down, and so on.
* @return The specified {@code Object} on the stack.
* @since 1.6
@@ -2333,7 +2333,7 @@ public class Digester
* </p>
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
- * @param stackName the name of the stack from which the top value is to
be popped.
+ * @param stackName The name of the stack from which the top value is to
be popped.
* @return The top {@code Object} on the stack or throws {@code
EmptyStackException}
* if the stack is either empty or has not been created yet
* @since 1.6
@@ -2412,8 +2412,8 @@ public class Digester
* one will be created.
*
* @param <T> any type of the pushed object
- * @param stackName the name of the stack onto which the object should be
pushed
- * @param value the Object to be pushed onto the named stack.
+ * @param stackName The name of the stack onto which the object should be
pushed
+ * @param value The Object to be pushed onto the named stack.
* @since 1.6
*/
public <T> void push( final String stackName, T value )
@@ -2654,7 +2654,7 @@ public class Digester
* at the digester level.</li>
* </ul>
*
- * @param handler the custom SAX ContentHandler where events are
redirected.
+ * @param handler The custom SAX ContentHandler where events are
redirected.
* @since 1.7
*/
public void setCustomContentHandler( final ContentHandler handler )
@@ -2677,7 +2677,7 @@ public class Digester
* Sets the {@code EntityResolver} used by SAX when resolving public id
and system id. This must be called
* before the first call to {@code parse()}.
*
- * @param entityResolver a class that implement the {@code EntityResolver}
interface.
+ * @param entityResolver A class that implement the {@code EntityResolver}
interface.
*/
public void setEntityResolver( final EntityResolver entityResolver )
{
@@ -2697,7 +2697,7 @@ public class Digester
/**
* Sets the executor service to run asynchronous parse method.
*
- * @param executorService the executor service to run asynchronous parse
method
+ * @param executorService The executor service to run asynchronous parse
method
* @since 3.1
*/
public void setExecutorService( final ExecutorService executorService )
@@ -2727,7 +2727,7 @@ public class Digester
/**
* Sets the current logger for this Digester.
*
- * @param log the current logger for this Digester.
+ * @param log The current logger for this Digester.
*/
public void setLogger( final Log log )
{
@@ -2762,7 +2762,7 @@ public class Digester
/**
* Sets the public id of the current file being parse.
*
- * @param publicId the DTD/Schema public's id.
+ * @param publicId The DTD/Schema public's id.
*/
public void setPublicId( final String publicId )
{
@@ -2794,7 +2794,7 @@ public class Digester
/**
* Sets the logger used for logging SAX-related information.
<strong>Note</strong> the output is finely grained.
*
- * @param saxLog the logger used for logging SAX-related information, not
null
+ * @param saxLog The logger used for logging SAX-related information, not
null
* @since 1.6
*/
public void setSAXLogger( final Log saxLog )
@@ -2806,7 +2806,7 @@ public class Digester
* Define a callback object which is invoked whenever an object is pushed
onto a digester object stack,
* or popped off one.
*
- * @param stackAction the callback object which is invoked whenever an
object is pushed onto a digester
+ * @param stackAction The callback object which is invoked whenever an
object is pushed onto a digester
* object stack, or popped off one.
* @since 1.8
*/
@@ -2818,7 +2818,7 @@ public class Digester
/**
* Sets the {@code Substitutor} to be used to convert attributes and body
text.
*
- * @param substitutor the Substitutor to be used to convert attributes and
body text or null if not substitution of
+ * @param substitutor The Substitutor to be used to convert attributes and
body text or null if not substitution of
* these values is to be performed.
*/
public void setSubstitutor( final Substitutor substitutor )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
index 5327b22f..cfe046db 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
@@ -109,8 +109,8 @@ public class NodeCreateRule
* objects needed to build the node.
* </p>
*
- * @param doc the document to use to create nodes
- * @param root the root node
+ * @param doc The document to use to create nodes
+ * @param root The root node
* @throws ParserConfigurationException if the DocumentBuilderFactory
could not be instantiated
* @throws SAXException if the XMLReader could not be instantiated by
Digester (should not happen)
*/
@@ -168,9 +168,9 @@ public class NodeCreateRule
* is found, or a child element is found then we can check whether we
have all-whitespace. See method
* addTextIfPresent.
*
- * @param ch the characters from the XML document
- * @param start the start position in the array
- * @param length the number of characters to read from the array
+ * @param ch The characters from the XML document
+ * @param start The start position in the array
+ * @param length The number of characters to read from the array
* @throws SAXException if the DOM implementation throws an exception
*/
@Override
@@ -183,9 +183,9 @@ public class NodeCreateRule
/**
* Checks whether control needs to be returned to Digester.
*
- * @param namespaceURI the namespace URI
- * @param localName the local name
- * @param qName the qualified (prefixed) name
+ * @param namespaceURI The namespace URI
+ * @param localName The local name
+ * @param qName The qualified (prefixed) name
* @throws SAXException if the DOM implementation throws an exception
*/
@Override
@@ -215,8 +215,8 @@ public class NodeCreateRule
/**
* Adds a new {@link org.w3c.dom.ProcessingInstruction
ProcessingInstruction} to the current node.
*
- * @param target the processing instruction target
- * @param data the processing instruction data, or null if none was
supplied
+ * @param target The processing instruction target
+ * @param data The processing instruction data, or null if none was
supplied
* @throws SAXException if the DOM implementation throws an exception
*/
@Override
@@ -236,10 +236,10 @@ public class NodeCreateRule
/**
* Adds a new child {@link org.w3c.dom.Element Element} to the current
node.
*
- * @param namespaceURI the namespace URI
- * @param localName the local name
- * @param qName the qualified (prefixed) name
- * @param atts the list of attributes
+ * @param namespaceURI The namespace URI
+ * @param localName The local name
+ * @param qName The qualified (prefixed) name
+ * @param atts The list of attributes
* @throws SAXException if the DOM implementation throws an exception
*/
@Override
@@ -314,7 +314,7 @@ public class NodeCreateRule
* Constructs a new instance. Creates an instance of this rule that will
create a DOM {@link org.w3c.dom.Element Element}, but
* lets you specify the JAXP {@code DocumentBuilder} that should be used
when constructing the node tree.
*
- * @param documentBuilder the JAXP {@code DocumentBuilder} to use
+ * @param documentBuilder The JAXP {@code DocumentBuilder} to use
*/
public NodeCreateRule( final DocumentBuilder documentBuilder )
{
@@ -326,7 +326,7 @@ public class NodeCreateRule
* or a DOM {@link org.w3c.dom.DocumentFragment DocumentFragment},
depending on the value of the
* {@code nodeType} parameter.
*
- * @param nodeType the type of node to create, which can be either {@link
org.w3c.dom.Node#ELEMENT_NODE
+ * @param nodeType The type of node to create, which can be either {@link
org.w3c.dom.Node#ELEMENT_NODE
* Node.ELEMENT_NODE} or {@link
org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE}
* @throws ParserConfigurationException if a DocumentBuilder cannot be
created which satisfies the
* configuration requested.
@@ -344,9 +344,9 @@ public class NodeCreateRule
* {@code nodeType} parameter. This constructor lets you specify the JAXP
{@code DocumentBuilder} that
* should be used when constructing the node tree.
*
- * @param nodeType the type of node to create, which can be either {@link
org.w3c.dom.Node#ELEMENT_NODE
+ * @param nodeType The type of node to create, which can be either {@link
org.w3c.dom.Node#ELEMENT_NODE
* Node.ELEMENT_NODE} or {@link
org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE}
- * @param documentBuilder the JAXP {@code DocumentBuilder} to use
+ * @param documentBuilder The JAXP {@code DocumentBuilder} to use
*/
public NodeCreateRule( final int nodeType, final DocumentBuilder
documentBuilder )
{
@@ -364,9 +364,9 @@ public class NodeCreateRule
* XML element is encountered, the original content handler is restored
(expected to be NULL, allowing normal
* Digester operations to continue).
*
- * @param namespaceURI the namespace URI of the matching element, or an
empty string if the parser is not namespace
+ * @param namespaceURI The namespace URI of the matching element, or an
empty string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param attributes The attribute list of this element
* @throws Exception indicates a JAXP configuration problem
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreateRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreateRule.java
index 12e7e1d5..f7ea5599 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreateRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreateRule.java
@@ -371,7 +371,7 @@ public class ObjectCreateRule
/**
* Allows users to specify constructor argument types.
*
- * @param constructorArgumentTypes the constructor argument types
+ * @param constructorArgumentTypes The constructor argument types
* @since 3.2
*/
public void setConstructorArgumentTypes( final Class<?>...
constructorArgumentTypes )
@@ -390,7 +390,7 @@ public class ObjectCreateRule
* not supplied by a {@link CallParamRule}, the corresponding item from
this array will be used
* to construct the final object as well.
*
- * @param constructorArguments the default constructor arguments.
+ * @param constructorArguments The default constructor arguments.
* @since 3.2
*/
public void setDefaultConstructorArguments( final Object...
constructorArguments )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
index 8c4d8fa6..b748850f 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
@@ -39,7 +39,7 @@ public interface ObjectCreationFactory<T>
/**
* Factory method called by {@link FactoryCreateRule} to supply an object
based on the element's attributes.
*
- * @param attributes the element's attributes
+ * @param attributes The element's attributes
* @return The object to be pushed onto the {@code Digester} stack
* @throws Exception any exception thrown will be propagated upwards
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
index d1d33957..7300bca3 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
@@ -62,7 +62,7 @@ public class ObjectParamRule
* Constructs a "call parameter" rule that will save the given Object as
the parameter value.
*
* @param paramIndex The zero-relative parameter number
- * @param param the parameter to pass along
+ * @param param The parameter to pass along
*/
public ObjectParamRule( final int paramIndex, final Object param )
{
@@ -75,7 +75,7 @@ public class ObjectParamRule
*
* @param paramIndex The zero-relative parameter number
* @param attributeName The name of the attribute to match
- * @param param the parameter to pass along
+ * @param param The parameter to pass along
*/
public ObjectParamRule( final int paramIndex, final String attributeName,
final Object param )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
index 1620dfcd..7eba5162 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
@@ -49,8 +49,8 @@ final class RecordedInvocation
/**
* Add a string representation of {@code input} to {@code buffer}.
*
- * @param buffer the buffer to append the string representation of the
input object.
- * @param input the input object has to be serialized to string.
+ * @param buffer The buffer to append the string representation of the
input object.
+ * @param input The input object has to be serialized to string.
*/
void convert( final StringBuilder buffer, final Object input )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexMatcher.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexMatcher.java
index 186d3ff3..52011634 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexMatcher.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexMatcher.java
@@ -31,8 +31,8 @@ public abstract class RegexMatcher
* Returns true if the given pattern matches the given path according to
the regex algorithm that this strategy
* applies.
*
- * @param pathPattern the standard digester path representing the element
- * @param rulePattern the regex pattern the path will be tested against
+ * @param pathPattern The standard digester path representing the element
+ * @param rulePattern The regex pattern the path will be tested against
* @return true if the given pattern matches the given path
*/
public abstract boolean match( String pathPattern, String rulePattern );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
index cdba9df2..56e02be0 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
@@ -63,7 +63,7 @@ public class RegexRules
/**
* Constructs sets the Regex matching strategy.
*
- * @param matcher the regex strategy to be used, not null
+ * @param matcher The regex strategy to be used, not null
*/
public RegexRules( final RegexMatcher matcher )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
index 0b4fb723..329e3cbb 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
@@ -65,9 +65,9 @@ import org.xml.sax.Attributes;
/**
* This method is called when the beginning of a matching XML element is
encountered.
*
- * @param namespace the namespace URI of the matching element, or an empty
string if the parser is not namespace
+ * @param namespace The namespace URI of the matching element, or an empty
string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param attributes The attribute list of this element
* @throws Exception if any error occurs
* @since 1.4
@@ -82,9 +82,9 @@ import org.xml.sax.Attributes;
* This method is called when the body of a matching XML element is
encountered. If the element has no body, this
* method is called with an empty string as the body text.
*
- * @param namespace the namespace URI of the matching element, or an empty
string if the parser is not namespace
+ * @param namespace The namespace URI of the matching element, or an empty
string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param text The text of the body of this element
* @throws Exception if any error occurs
* @since 1.4
@@ -98,9 +98,9 @@ import org.xml.sax.Attributes;
/**
* This method is called when the end of a matching XML element is
encountered.
*
- * @param namespace the namespace URI of the matching element, or an empty
string if the parser is not namespace
+ * @param namespace The namespace URI of the matching element, or an empty
string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @throws Exception if any error occurs
* @since 1.4
*/
@@ -144,7 +144,7 @@ import org.xml.sax.Attributes;
/**
* Sets the {@code Digester} with which this {@code Rule} is associated.
*
- * @param digester the {@code Digester} with which this {@code Rule} is
associated
+ * @param digester The {@code Digester} with which this {@code Rule} is
associated
*/
public void setDigester( final Digester digester )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleMatcher.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleMatcher.java
index 92eef115..89c212e7 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleMatcher.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleMatcher.java
@@ -32,10 +32,10 @@ public interface RuleMatcher
/**
* Use the specified parameter to perform a test.
*
- * @param namespace the namespace URI of the matching element, or an empty
string if the parser is not namespace
+ * @param namespace The namespace URI of the matching element, or an empty
string if the parser is not namespace
* aware or the element has no namespace
* @param pattern Nesting pattern to be matched for this Rule
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param attributes The attribute list of this element
* @return true, if the test succeeds, false otherwise
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
index fb5b8e04..06bde5c5 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
@@ -66,7 +66,7 @@ public interface Rules
* @param namespaceURI Namespace URI for which to select matching rules,
or {@code null} to match regardless of
* namespace URI
* @param pattern Nesting pattern to be matched
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param attributes The attribute list of the current matching element
* @return A List of all registered Rule instances that match the
specified nesting pattern
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
index 0dbf26b8..acf7fa7e 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
@@ -431,8 +431,8 @@ public class SetNestedPropertiesRule
* desired.
* </p>
*
- * @param elementName the XML element has to be mapped
- * @param propertyName the property name target
+ * @param elementName The XML element has to be mapped
+ * @param propertyName The property name target
*/
public void addAlias( final String elementName, final String propertyName )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
index 4e909202..0daf01e1 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
@@ -145,8 +145,8 @@ public class SetPropertiesRule
/**
* Add an additional attribute name to property name mapping. This is
intended to be used from the XML rules.
*
- * @param attributeName the attribute name has to be mapped
- * @param propertyName the target property name
+ * @param attributeName The attribute name has to be mapped
+ * @param propertyName The target property name
*/
public void addAlias( final String attributeName, final String
propertyName )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
index fef8c376..ed656dd4 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
@@ -73,8 +73,8 @@ public class SimpleRegexMatcher
/**
* Implements a regex matching algorithm. This calls itself recursively.
*
- * @param basePattern the standard digester path representing the element
- * @param regexPattern the regex pattern the path will be tested against
+ * @param basePattern The standard digester path representing the element
+ * @param regexPattern The regex pattern the path will be tested against
* @param baseAt FIXME
* @param regexAt FIXME
*/
@@ -163,7 +163,7 @@ public class SimpleRegexMatcher
/**
* Sets the current {@code Log} implementation used by this class.
*
- * @param log the current {@code Log} implementation used by this class.
+ * @param log The current {@code Log} implementation used by this class.
*/
public void setLog( final Log log )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
index f6fd98f2..d16f07f1 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
@@ -50,7 +50,7 @@ public abstract class Substitutor
* all calls.
* </p>
*
- * @param attributes the {@code Attributes} passed into {@code Digester}
by the SAX parser, not null (but
+ * @param attributes The {@code Attributes} passed into {@code Digester}
by the SAX parser, not null (but
* may be empty)
* @return {@code Attributes} to be passed to the {@code Rule}
implementations. This method may pass back
* the Attributes passed in. Not null but possibly empty.
@@ -61,7 +61,7 @@ public abstract class Substitutor
* Substitutes for the body text. This method may substitute values into
the body text of the elements that Digester
* parses.
*
- * @param bodyText the body text (as passed to {@code Digester})
+ * @param bodyText The body text (as passed to {@code Digester})
* @return The body text to be passed to the {@code Rule} implementations
*/
public abstract String substitute( String bodyText );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
index 989ff215..7150c885 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
@@ -71,7 +71,7 @@ public class WithDefaultsRulesWrapper
/**
* Base constructor.
*
- * @param wrappedRules the wrapped {@code Rules} implementation, not null
+ * @param wrappedRules The wrapped {@code Rules} implementation, not null
*/
public WithDefaultsRulesWrapper( final Rules wrappedRules )
{
@@ -92,7 +92,7 @@ public class WithDefaultsRulesWrapper
/**
* Adds a rule to be fired when wrapped implementation returns no matches
*
- * @param rule a Rule to be fired when wrapped implementation returns no
matches
+ * @param rule A Rule to be fired when wrapped implementation returns no
matches
**/
public void addDefault( final Rule rule )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandler.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandler.java
index e4bafd38..424da9c9 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandler.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandler.java
@@ -38,9 +38,9 @@ public interface AnnotationHandler<A extends Annotation, E
extends AnnotatedElem
/**
* Handles the current visited element with the related current annotation.
*
- * @param annotation the current visited annotation.
- * @param element the current visited annotated element.
- * @param rulesBinder the annotations {@code RulesBinder} where rules have
to be bound.
+ * @param annotation The current visited annotation.
+ * @param element The current visited annotated element.
+ * @param rulesBinder The annotations {@code RulesBinder} where rules have
to be bound.
*/
void handle( A annotation, E element, RulesBinder rulesBinder );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandlerFactory.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandlerFactory.java
index 4bf4df81..a1739b44 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandlerFactory.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/AnnotationHandlerFactory.java
@@ -34,7 +34,7 @@ public interface AnnotationHandlerFactory
* Return an instance of the specified type.
*
* @param <H> The {@link AnnotationHandler} type has to be created
- * @param type the class of the object to be returned.
+ * @param type The class of the object to be returned.
* @return An instance of the specified class.
* @throws Exception if any error occurs while creating the {@link
AnnotationHandler} instance.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/FromAnnotationsRuleModule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/FromAnnotationsRuleModule.java
index 80c0f5e0..136b3307 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/FromAnnotationsRuleModule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/FromAnnotationsRuleModule.java
@@ -53,7 +53,7 @@ public abstract class FromAnnotationsRuleModule
/**
* Scan the input Class, looking for Digester rules expressed via
annotations, and binds them.
*
- * @param type the type has to be analyzed
+ * @param type The type has to be analyzed
* @see DigesterRule
*/
protected final void bindRulesFrom( final Class<?> type )
@@ -110,8 +110,8 @@ public abstract class FromAnnotationsRuleModule
* Handles the current visited element and related annotation, invoking the
* right handler putting the rule provider in the rule set.
*
- * @param annotation the current visited annotation.
- * @param element the current visited element.
+ * @param annotation The current visited annotation.
+ * @param element The current visited element.
*/
@SuppressWarnings( "unchecked" )
private <A extends Annotation, E extends AnnotatedElement, R extends Rule>
void handle( final A annotation, final E element )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
index cbfc0898..f859cb85 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
@@ -49,9 +49,9 @@ public final class MethodArgument
/**
* Creates a new method argument as {@code AnnotatedElement}.
*
- * @param index the method argument index.
- * @param parameterType the method argument type.
- * @param annotations the method argument annotations.
+ * @param index The method argument index.
+ * @param parameterType The method argument type.
+ * @param annotations The method argument annotations.
*/
public MethodArgument( final int index, final Class<?> parameterType,
final Annotation[] annotations )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
index b2c16fc1..9c75e994 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
@@ -70,7 +70,7 @@ public class AnnotationUtils
/**
* Extract the {@code pattern()} from annotation.
*
- * @param annotation the annotation has to be introspected.
+ * @param annotation The annotation has to be introspected.
* @return The annotation {@code pattern()}.
*/
public static String getAnnotationPattern( final Annotation annotation )
@@ -86,7 +86,7 @@ public class AnnotationUtils
/**
* Extract the Annotations array {@code value()} from annotation if
present, nul otherwise.
*
- * @param annotation the annotation has to be introspected.
+ * @param annotation The annotation has to be introspected.
* @return The annotation {@code value()} as Annotations array.
*/
public static Annotation[] getAnnotationsArrayValue( final Annotation
annotation )
@@ -103,7 +103,7 @@ public class AnnotationUtils
/**
* Extract the {@code value()} from annotation.
*
- * @param annotation the annotation has to be introspected.
+ * @param annotation The annotation has to be introspected.
* @return The annotation {@code value()}.
*/
public static Object getAnnotationValue( final Annotation annotation )
@@ -130,8 +130,8 @@ public class AnnotationUtils
/**
* Invokes an annotation method.
*
- * @param annotation the annotation has to be introspected.
- * @param method the method name to execute.
+ * @param annotation The annotation has to be introspected.
+ * @param method The method name to execute.
* @return The annotation method value, null if any error occurs.
*/
private static Object invokeAnnotationMethod( final Annotation annotation,
final String method )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/CallParamBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/CallParamBuilder.java
index 213acceb..46d4f161 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/CallParamBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/CallParamBuilder.java
@@ -77,7 +77,7 @@ public final class CallParamBuilder
/**
* Flags the parameter to be set from the stack.
*
- * @param fromStack the parameter flag to be set from the stack
+ * @param fromStack The parameter flag to be set from the stack
* @return this builder instance
*/
public CallParamBuilder fromStack( final boolean fromStack )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
index 1dc1d3d4..0fa0c206 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
@@ -167,7 +167,7 @@ public final class DigesterLoader
/**
* Add rules to an already created Digester instance, analyzing the
digester annotations in the target class.
*
- * @param digester the Digester instance reference.
+ * @param digester The Digester instance reference.
*/
public void addRules( final Digester digester )
{
@@ -327,7 +327,7 @@ public final class DigesterLoader
* Creates a new {@link Digester} instance that relies on the given {@code
SAXParser}
* and the default {@link Rules} implementation.
*
- * @param parser the user-defined {@code SAXParser}
+ * @param parser The user-defined {@code SAXParser}
* @return A new {@link Digester} instance
*/
public Digester newDigester( final SAXParser parser )
@@ -466,7 +466,7 @@ public final class DigesterLoader
/**
* Sets the class loader to be used for instantiating application objects
when required.
*
- * @param classLoader the class loader to be used for instantiating
application objects when required.
+ * @param classLoader The class loader to be used for instantiating
application objects when required.
* @return This loader instance, useful to chain methods.
*/
public DigesterLoader setClassLoader( final ClassLoader classLoader )
@@ -490,7 +490,7 @@ public final class DigesterLoader
/**
* Sets the document locator associated with our parser.
*
- * @param locator the document locator associated with our parser.
+ * @param locator The document locator associated with our parser.
* @return This loader instance, useful to chain methods.
* @since 3.2
*/
@@ -504,7 +504,7 @@ public final class DigesterLoader
* Sets the {@code EntityResolver} used by SAX when resolving public id
and system id. This must be called
* before the first call to {@code parse()}.
*
- * @param entityResolver a class that implement the {@code EntityResolver}
interface.
+ * @param entityResolver A class that implement the {@code EntityResolver}
interface.
* @return This loader instance, useful to chain methods.
*/
public DigesterLoader setEntityResolver( final EntityResolver
entityResolver )
@@ -529,7 +529,7 @@ public final class DigesterLoader
/**
* Sets the executor service to run asynchronous parse method.
*
- * @param executorService the executor service to run asynchronous parse
method
+ * @param executorService The executor service to run asynchronous parse
method
* @return This loader instance, useful to chain methods.
* @since 3.1
*/
@@ -586,7 +586,7 @@ public final class DigesterLoader
/**
* Sets the Object which will receive callbacks for every pop/push action
on the default stack or named stacks.
*
- * @param stackAction the Object which will receive callbacks for every
pop/push action on the default stack
+ * @param stackAction The Object which will receive callbacks for every
pop/push action on the default stack
* or named stacks.
* @return This loader instance, useful to chain methods.
*/
@@ -599,7 +599,7 @@ public final class DigesterLoader
/**
* Sets the {@code Substitutor} to be used to convert attributes and body
text.
*
- * @param substitutor the Substitutor to be used to convert attributes and
body text
+ * @param substitutor The Substitutor to be used to convert attributes and
body text
* or null if not substitution of these values is to be performed.
* @return This loader instance, useful to chain methods.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoadingException.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoadingException.java
index cad0fa25..56d59b65 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoadingException.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoadingException.java
@@ -36,7 +36,7 @@ public final class DigesterLoadingException
/**
* Constructs a new Digester exception with the specified detail message.
*
- * @param message the detail message.
+ * @param message The detail message.
*/
public DigesterLoadingException( final String message )
{
@@ -46,8 +46,8 @@ public final class DigesterLoadingException
/**
* Constructs a new exception with the specified detail message and cause.
*
- * @param message the detail message.
- * @param cause the cause.
+ * @param message The detail message.
+ * @param cause The cause.
*/
public DigesterLoadingException( final String message, final Throwable
cause )
{
@@ -57,7 +57,7 @@ public final class DigesterLoadingException
/**
* Constructs a new exception with the specified cause.
*
- * @param cause the cause.
+ * @param cause The cause.
*/
public DigesterLoadingException( final Throwable cause )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
index a920ba12..198c6c1d 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
@@ -157,9 +157,9 @@ final class FromBinderRuleSet
*
* @param <R> The Digester rule type
* @param <RB> The Digester rule builder type
- * @param keyPattern the rule pattern
- * @param namespaceURI the namespace URI (can be null)
- * @param type the rule builder type the client is looking for
+ * @param keyPattern The rule pattern
+ * @param namespaceURI The namespace URI (can be null)
+ * @param type The rule builder type the client is looking for
* @return The rule builder of input type, if any
*/
public <R extends Rule, RB extends AbstractBackToLinkedRuleBuilder<R>> RB
getProvider( final String keyPattern,
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/LinkedRuleBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/LinkedRuleBuilder.java
index 04e58daf..1f169c81 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/LinkedRuleBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/LinkedRuleBuilder.java
@@ -338,7 +338,7 @@ public final class LinkedRuleBuilder
/**
* Sets the namespace URI for the current rule pattern.
*
- * @param namespaceURI the namespace URI associated to the rule pattern.
+ * @param namespaceURI The namespace URI associated to the rule pattern.
* @return this {@link LinkedRuleBuilder} instance
*/
public LinkedRuleBuilder withNamespaceURI( /* @Nullable */final String
namespaceURI )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
index a9e2b584..2a75202c 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
@@ -159,7 +159,7 @@ public final class NodeCreateRuleProvider
* or a DOM {@link org.w3c.dom.DocumentFragment DocumentFragment},
depending on the value of the
* {@code nodeType} parameter.
*
- * @param nodeType the type of node to create, which can be either
+ * @param nodeType The type of node to create, which can be either
* {@link org.w3c.dom.Node#ELEMENT_NODE Node.ELEMENT_NODE}
or
* {@link org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE
Node.DOCUMENT_FRAGMENT_NODE}
* @return this builder instance
@@ -179,7 +179,7 @@ public final class NodeCreateRuleProvider
* {@link NodeCreateRule} instance will be created a DOM {@link
org.w3c.dom.Element Element}, but
* lets users specify the JAXP {@code DocumentBuilder} that should be used
when constructing the node tree.
*
- * @param documentBuilder the JAXP {@code DocumentBuilder} to use
+ * @param documentBuilder The JAXP {@code DocumentBuilder} to use
* @return this builder instance
*/
public NodeCreateRuleProvider usingDocumentBuilder( final DocumentBuilder
documentBuilder )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/ObjectCreateBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/ObjectCreateBuilder.java
index 89268a2a..24cd49a0 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/ObjectCreateBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/ObjectCreateBuilder.java
@@ -138,7 +138,7 @@ public final class ObjectCreateBuilder
/**
* Allows users to specify constructor argument types.
*
- * @param constructorArgumentTypes the constructor argument types
+ * @param constructorArgumentTypes The constructor argument types
* @return this builder instance
* @since 3.2
*/
@@ -159,7 +159,7 @@ public final class ObjectCreateBuilder
/**
* Allows users to specify constructor argument type names.
*
- * @param paramTypeNames the constructor argument type names
+ * @param paramTypeNames The constructor argument type names
* @return this builder instance
* @since 3.2
*/
@@ -192,7 +192,7 @@ public final class ObjectCreateBuilder
/**
* Allows users to specify default constructor arguments.
*
- * @param defaultConstructorArguments the default constructor arguments.
+ * @param defaultConstructorArguments The default constructor arguments.
* @return this builder instance
* @since 3.2
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
index d359c1ac..c09abda5 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
@@ -107,7 +107,7 @@ public final class PluginCreateRuleBuilder
* Sets the class which any specified plugin <em>must</em> be descended
from.
*
* @param <T> Any Java type
- * @param type the class which any specified plugin <em>must</em> be
descended from
+ * @param type The class which any specified plugin <em>must</em> be
descended from
* @return this builder instance
*/
public <T> PluginCreateRuleBuilder ofType( final Class<T> type )
@@ -127,7 +127,7 @@ public final class PluginCreateRuleBuilder
* Sets the XML attribute which the input XML uses to indicate to a
* PluginCreateRule which class should be instantiated.
*
- * @param attrName the XML attribute which the input XML uses to indicate
to a
+ * @param attrName The XML attribute which the input XML uses to indicate
to a
* PluginCreateRule which class should be instantiated.
* @return this builder instance
*/
@@ -203,7 +203,7 @@ public final class PluginCreateRuleBuilder
* Sets the class which will be used if the user doesn't specify any
plugin-class or plugin-id.
*
* @param <T> Any Java type
- * @param type the class which will be used if the user doesn't specify
any plugin-class or plugin-id.
+ * @param type The class which will be used if the user doesn't specify
any plugin-class or plugin-id.
* @return this builder instance
*/
public <T> PluginCreateRuleBuilder usingDefaultPluginClass( /* @Nullable
*/final Class<T> type )
@@ -216,7 +216,7 @@ public final class PluginCreateRuleBuilder
* Sets RuleLoader instance which knows how to load the custom rules
associated with the default plugin.
*
* @param <RL> Any {@link RuleLoader} extension.
- * @param ruleLoader the RuleLoader instance which knows how to load the
custom rules associated with
+ * @param ruleLoader The RuleLoader instance which knows how to load the
custom rules associated with
* the default plugin.
* @return this builder instance
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RulesBinder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RulesBinder.java
index f3790920..7085f288 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RulesBinder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RulesBinder.java
@@ -64,7 +64,7 @@ public interface RulesBinder
/**
* Allows sub-modules inclusion while binding rules.
*
- * @param rulesModule the sub-module has to be included.
+ * @param rulesModule The sub-module has to be included.
*/
void install( RulesModule rulesModule );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
index 5a652938..2c09c3ec 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
@@ -245,7 +245,7 @@ public class PluginContext
* If the intent is just to add an additional rule-finding algorithm, then
it may be better to call #getRuleFinders,
* and insert a new object into the start of the list.
*
- * @param ruleFinders the list of RuleFinder objects
+ * @param ruleFinders The list of RuleFinder objects
*/
public void setRuleFinders( final List<RuleFinder> ruleFinders )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginCreateRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginCreateRule.java
index 1294f905..6cb7bdba 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginCreateRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginCreateRule.java
@@ -122,9 +122,9 @@ public class PluginCreateRule
* are then loaded into that new Rules object. Finally, any custom rules
that are associated with the current
* pattern (such as SetPropertiesRules) have their begin methods executed.
*
- * @param namespace the namespace URI of the matching element, or an empty
string if the parser is not namespace
+ * @param namespace The namespace URI of the matching element, or an empty
string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param attributes The attribute list of this element
* @throws Exception if any error occurs
*/
@@ -306,9 +306,9 @@ public class PluginCreateRule
* if the Digester class provided a way for this functionality to just be
invoked directly.
*
* @param rules The rules which {@link Rule#begin(String, String,
Attributes)} method has to be fired
- * @param namespace the namespace URI of the matching element, or an empty
string if the parser is not namespace
+ * @param namespace The namespace URI of the matching element, or an empty
string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param list The attribute list of this element
* @throws Exception if any error occurs
*/
@@ -345,9 +345,9 @@ public class PluginCreateRule
* It would be really nice if the Digester class provided a way for this
functionality to just be invoked directly.
*
* @param rules The rules which {@link Rule#body(String, String, String)}
method has to be fired
- * @param namespaceURI the namespace URI of the matching element, or an
empty string if the parser is not namespace
+ * @param namespaceURI The namespace URI of the matching element, or an
empty string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @param text The text of the body of this element
* @throws Exception if any error occurs
*/
@@ -382,9 +382,9 @@ public class PluginCreateRule
* It would be really nice if the Digester class provided a way for this
functionality to just be invoked directly.
*
* @param rules The rules which {@link Rule#end(String, String)} method
has to be fired
- * @param namespaceURI the namespace URI of the matching element, or an
empty string if the parser is not namespace
+ * @param namespaceURI The namespace URI of the matching element, or an
empty string if the parser is not namespace
* aware or the element has no namespace
- * @param name the local name if the parser is namespace aware, or just
the element name otherwise
+ * @param name The local name if the parser is namespace aware, or just
the element name otherwise
* @throws Exception if any error occurs
*/
public void fireEndMethods( final List<Rule> rules, final String
namespaceURI, final String name )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java
index 0038c8f5..eef0ba25 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginDeclarationRule.java
@@ -42,7 +42,7 @@ public class PluginDeclarationRule
* Helper method to declare a plugin inside the given Digester.
*
* @param digester The Digester instance to declare plugin
- * @param props the properties where extracting plugin attributes
+ * @param props The properties where extracting plugin attributes
* @throws PluginException if any error occurs while declaring the plugin
*/
public static void declarePlugin( final Digester digester, final
Properties props )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
index 3188a501..9ec262a4 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
@@ -83,7 +83,7 @@ public class PluginManager
* TODO: somehow get a reference to a Digester object so that we can
really log here. Currently, all logging is
* disabled from this method.
*
- * @param decl an object representing a plugin class.
+ * @param decl An object representing a plugin class.
*/
public void addDeclaration( final Declaration decl )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
index ac5af452..001e6b58 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
@@ -442,7 +442,7 @@ public class PluginRules
/**
* See {@link PluginContext#setRuleFinders}.
*
- * @param ruleFinders the list of RuleFinder objects
+ * @param ruleFinders The list of RuleFinder objects
*/
public void setRuleFinders( final List<RuleFinder> ruleFinders )
{
@@ -453,7 +453,7 @@ public class PluginRules
* Sets the object which is used to generate the new Rules instances
created to hold and process the rules associated
* with each plugged-in class.
*
- * @param factory the rules factory object
+ * @param factory The rules factory object
*/
public void setRulesFactory( final RulesFactory factory )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java
index 75ab4ff0..fe928853 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java
@@ -58,7 +58,7 @@ public class FinderFromFile
/**
* See {@link #findLoader}.
*
- * @param fileNameAttr the XML attribute that needs to be present on a
plugin declaration in order to specify the
+ * @param fileNameAttr The XML attribute that needs to be present on a
plugin declaration in order to specify the
* file to load rules from.
*/
public FinderFromFile( final String fileNameAttr )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromStream.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromStream.java
index 82b80f53..59136052 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromStream.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromStream.java
@@ -51,7 +51,7 @@ public class LoaderFromStream
* <p>
* The caller is responsible for closing the input stream after this
method has returned.
*
- * @param s the input stream has to be loaded into memory
+ * @param s The input stream has to be loaded into memory
* @throws Exception if any error occurs while reading the input stream
*/
public LoaderFromStream( final InputStream s )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
index 6d53b879..1281876a 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
@@ -35,7 +35,7 @@ public interface VariableExpander
* Return the input string with any variables replaced by their
corresponding value. If there are no variables in
* the string, then the input parameter is returned unaltered.
*
- * @param param the string containing variables to be replaced.
+ * @param param The string containing variables to be replaced.
* @return The input string with any variables replaced by their
corresponding value.
*/
String expand( String param );
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/annotations/AbstractAnnotatedPojoTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/annotations/AbstractAnnotatedPojoTestCase.java
index f41d5120..93a30947 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/annotations/AbstractAnnotatedPojoTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/annotations/AbstractAnnotatedPojoTestCase.java
@@ -41,7 +41,7 @@ public abstract class AbstractAnnotatedPojoTestCase
* Loads the digester rules parsing the expected object class, parses the
* XML and verify the digester produces the same result.
*
- * @param expected the expected object
+ * @param expected The expected object
* @throws Exception if any error occurs
*/
public final void verifyExpectedEqualsToParsed(final Object expected)
throws Exception {