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 5dd45674 Javadoc
5dd45674 is described below
commit 5dd45674449d1a395fd08990aa77e8c86eb0202b
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:32 2026 -0400
Javadoc
---
.../org/apache/commons/digester3/Digester.java | 16 +++++-----
.../java/org/apache/commons/digester3/Rules.java | 4 +--
.../org/apache/commons/digester3/RulesBase.java | 2 +-
.../annotations/AnnotationHandlerFactory.java | 2 +-
.../annotations/reflect/MethodArgument.java | 2 +-
.../binder/AbstractBackToLinkedRuleBuilder.java | 2 +-
.../commons/digester3/binder/DigesterLoader.java | 12 ++++----
.../digester3/binder/LinkedRuleBuilder.java | 36 +++++++++++-----------
.../commons/digester3/binder/RuleProvider.java | 2 +-
.../commons/digester3/plugins/RuleFinder.java | 2 +-
.../commons/digester3/plugins/RulesFactory.java | 2 +-
.../plugins/strategies/FinderFromClass.java | 2 +-
.../plugins/strategies/FinderFromDfltClass.java | 2 +-
.../plugins/strategies/FinderFromDfltMethod.java | 2 +-
.../plugins/strategies/FinderFromDfltResource.java | 2 +-
.../plugins/strategies/FinderFromFile.java | 2 +-
.../plugins/strategies/FinderFromMethod.java | 2 +-
.../plugins/strategies/FinderFromResource.java | 4 +--
.../plugins/strategies/FinderSetProperties.java | 2 +-
.../substitution/VariableExpansionTestCase.java | 2 +-
20 files changed, 51 insertions(+), 51 deletions(-)
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 d54c89d7..05c22004 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
@@ -895,7 +895,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param callable
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @since 3.1
*/
private <T> Future<T> asyncParse( final Callable<T> callable )
@@ -913,7 +913,7 @@ public class Digester
*
* @param <T> The result type returned by the returned Future's {@code
get} method
* @param file File containing the XML data to be parsed
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @see Digester#parse(File)
* @since 3.1
*/
@@ -927,7 +927,7 @@ public class Digester
*
* @param <T> The result type returned by the returned Future's {@code
get} method
* @param input Input source containing the XML data to be parsed
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @see Digester#parse(InputSource)
* @since 3.1
*/
@@ -941,7 +941,7 @@ public class Digester
*
* @param <T> The result type returned by the returned Future's {@code
get} method
* @param input Input stream containing the XML data to be parsed
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @see Digester#parse(InputStream)
* @since 3.1
*/
@@ -955,7 +955,7 @@ public class Digester
*
* @param <T> The result type returned by the returned Future's {@code
get} method
* @param reader Reader containing the XML data to be parsed
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @see Digester#parse(Reader)
* @since 3.1
*/
@@ -969,7 +969,7 @@ public class Digester
*
* @param <T> The result type returned by the returned Future's {@code
get} method
* @param uri URI containing the XML data to be parsed
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @see Digester#parse(String)
* @since 3.1
*/
@@ -983,7 +983,7 @@ public class Digester
*
* @param <T> The result type returned by the returned Future's {@code
get} method
* @param url URL containing the XML data to be parsed
- * @return a Future that can be used to track when the parse has been
fully processed.
+ * @return A Future that can be used to track when the parse has been
fully processed.
* @see Digester#parse(URL)
* @since 3.1
*/
@@ -1640,7 +1640,7 @@ public class Digester
* Gets a Stack whose elements are List objects, each containing a list of
* Rule objects as returned from Rules.getMatch().
*
- * @return a Stack whose elements are List objects, each containing a list
of
+ * @return A Stack whose elements are List objects, each containing a list
of
* Rule objects as returned from Rules.getMatch().
* @since 3.0
*/
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 af362f36..fb5b8e04 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
@@ -68,7 +68,7 @@ public interface Rules
* @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 attributes The attribute list of the current matching element
- * @return a List of all registered Rule instances that match the
specified nesting pattern
+ * @return A List of all registered Rule instances that match the
specified nesting pattern
*/
List<Rule> match( String namespaceURI, String pattern, String name,
Attributes attributes );
@@ -77,7 +77,7 @@ public interface Rules
* If more than one Rule instance has been registered, they
<strong>must</strong> be returned in the order
* originally registered through the {@code add()} method.
*
- * @return a List of all registered Rule instances
+ * @return A List of all registered Rule instances
*/
List<Rule> rules();
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RulesBase.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RulesBase.java
index 96c2e100..59c403cf 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RulesBase.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RulesBase.java
@@ -84,7 +84,7 @@ public class RulesBase
* @param namespaceURI Namespace URI to match, or {@code null} to select
matching rules regardless of namespace
* URI
* @param pattern Pattern to be matched
- * @return a List of Rule instances for the specified pattern that also
match the specified namespace URI (if any)
+ * @return A List of Rule instances for the specified pattern that also
match the specified namespace URI (if any)
*/
protected List<Rule> lookup( final String namespaceURI, final String
pattern )
{
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 07cc6a45..4bf4df81 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
@@ -35,7 +35,7 @@ public interface AnnotationHandlerFactory
*
* @param <H> The {@link AnnotationHandler} type has to be created
* @param type the class of the object to be returned.
- * @return an instance of the specified class.
+ * @return An instance of the specified class.
* @throws Exception if any error occurs while creating the {@link
AnnotationHandler} instance.
*/
<H extends AnnotationHandler<? extends Annotation, ? extends
AnnotatedElement>> H newInstance( Class<H> type )
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 8507cc00..cbfc0898 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
@@ -91,7 +91,7 @@ public final class MethodArgument
/**
* Returns an annotations array, copy of the declared annotations in this
method argument.
*
- * @return an annotations array, copy of the declared annotations in this
method argument.
+ * @return An annotations array, copy of the declared annotations in this
method argument.
*/
private Annotation[] getAnnotationsArrayCopy()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
index af0382a8..41e2822b 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
@@ -50,7 +50,7 @@ abstract class AbstractBackToLinkedRuleBuilder<R extends Rule>
/**
* Provides an instance of {@link Rule}. Must never return null.
*
- * @return an instance of {@link Rule}.
+ * @return An instance of {@link Rule}.
* @see #get()
*/
protected abstract R createRule();
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 862f2f61..1dc1d3d4 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
@@ -294,7 +294,7 @@ public final class DigesterLoader
/**
* Creates a new {@link Digester} instance that relies on the default
{@link Rules} implementation.
*
- * @return a new {@link Digester} instance
+ * @return A new {@link Digester} instance
*/
public Digester newDigester()
{
@@ -305,7 +305,7 @@ public final class DigesterLoader
* Creates a new {@link Digester} instance that relies on the custom user
define {@link Rules} implementation
*
* @param rules The custom user define {@link Rules} implementation
- * @return a new {@link Digester} instance
+ * @return A new {@link Digester} instance
*/
public Digester newDigester( final Rules rules )
{
@@ -328,7 +328,7 @@ public final class DigesterLoader
* and the default {@link Rules} implementation.
*
* @param parser the user-defined {@code SAXParser}
- * @return a new {@link Digester} instance
+ * @return A new {@link Digester} instance
*/
public Digester newDigester( final SAXParser parser )
{
@@ -341,7 +341,7 @@ public final class DigesterLoader
*
* @param parser The user-defined {@code SAXParser}
* @param rules The custom user define {@link Rules} implementation
- * @return a new {@link Digester} instance
+ * @return A new {@link Digester} instance
*/
public Digester newDigester( final SAXParser parser, final Rules rules )
{
@@ -368,7 +368,7 @@ public final class DigesterLoader
* to <strong>NOT</strong> share same {@link XMLReader} instance to
produce the Digester.
*
* @param reader The user-defined {@code XMLReader}
- * @return a new {@link Digester} instance
+ * @return A new {@link Digester} instance
*/
public Digester newDigester( final XMLReader reader )
{
@@ -384,7 +384,7 @@ public final class DigesterLoader
*
* @param reader The user-defined {@code XMLReader}
* @param rules The custom user define {@link Rules} implementation
- * @return a new {@link Digester} instance
+ * @return A new {@link Digester} instance
*/
public Digester newDigester( final XMLReader reader, final Rules rules )
{
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 f88558c5..04e58daf 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
@@ -72,7 +72,7 @@ public final class LinkedRuleBuilder
* @see Rule#setDigester(org.apache.commons.digester3.Digester)
* @param <R> The rule type
* @param rule The custom user rule
- * @return a new {@link ByRuleBuilder} instance.
+ * @return A new {@link ByRuleBuilder} instance.
*/
public <R extends Rule> ByRuleBuilder<R> addRule( final R rule )
{
@@ -89,7 +89,7 @@ public final class LinkedRuleBuilder
*
* @param <R> The rule type
* @param provider The rule provider
- * @return a new {@link ByRuleProviderBuilder} instance.
+ * @return A new {@link ByRuleProviderBuilder} instance.
*/
public <R extends Rule> ByRuleProviderBuilder<R> addRuleCreatedBy( final
RuleProvider<R> provider )
{
@@ -107,7 +107,7 @@ public final class LinkedRuleBuilder
* subsequent {@link #callParam()} rule or from the body of this element.
*
* @param methodName Method name of the parent object to call
- * @return a new {@link CallMethodBuilder} instance.
+ * @return A new {@link CallMethodBuilder} instance.
*/
public CallMethodBuilder callMethod( final String methodName )
{
@@ -124,7 +124,7 @@ public final class LinkedRuleBuilder
/**
* Saves a parameter for use by a surrounding {@link #callMethod(String)}.
*
- * @return a new {@link CallParamBuilder} instance.
+ * @return A new {@link CallParamBuilder} instance.
*/
public CallParamBuilder callParam()
{
@@ -134,7 +134,7 @@ public final class LinkedRuleBuilder
/**
* Constructs a "call parameter" rule that will save the body text of this
element as the parameter value.
*
- * @return a new {@link PathCallParamBuilder} instance.
+ * @return A new {@link PathCallParamBuilder} instance.
*/
public PathCallParamBuilder callParamPath()
{
@@ -144,7 +144,7 @@ public final class LinkedRuleBuilder
/**
* A rule implementation that creates a DOM Node containing the XML at the
element that matched the rule.
*
- * @return a new {@link NodeCreateRuleProvider} instance.
+ * @return A new {@link NodeCreateRuleProvider} instance.
*/
public NodeCreateRuleProvider createNode()
{
@@ -154,7 +154,7 @@ public final class LinkedRuleBuilder
/**
* Constructs an object.
*
- * @return a new {@link ObjectCreateBuilder} instance.
+ * @return A new {@link ObjectCreateBuilder} instance.
*/
public ObjectCreateBuilder createObject()
{
@@ -167,7 +167,7 @@ public final class LinkedRuleBuilder
* NOTE: when using this rule, make sure {@link
org.apache.commons.digester3.Digester} instances
* will be created using {@link
org.apache.commons.digester3.plugins.PluginRules} rules strategy.
*
- * @return a new {@link PluginDeclarationRuleBuilder} instance.
+ * @return A new {@link PluginDeclarationRuleBuilder} instance.
*/
public PluginCreateRuleBuilder createPlugin()
{
@@ -181,7 +181,7 @@ public final class LinkedRuleBuilder
* NOTE: when using this rule, make sure {@link
org.apache.commons.digester3.Digester} instances
* will be created using {@link
org.apache.commons.digester3.plugins.PluginRules} rules strategy.
*
- * @return a new {@link PluginDeclarationRuleBuilder} instance.
+ * @return A new {@link PluginDeclarationRuleBuilder} instance.
*/
public PluginDeclarationRuleBuilder declarePlugin()
{
@@ -194,7 +194,7 @@ public final class LinkedRuleBuilder
*
* When the element is complete, the object will be popped.
*
- * @return a new {@link FactoryCreateBuilder} instance.
+ * @return A new {@link FactoryCreateBuilder} instance.
*/
public FactoryCreateBuilder factoryCreate()
{
@@ -206,7 +206,7 @@ public final class LinkedRuleBuilder
*
* @param <T> The parameter type to pass along
* @param paramObj The parameter to pass along
- * @return a new {@link ObjectParamBuilder} instance.
+ * @return A new {@link ObjectParamBuilder} instance.
*/
public <T> ObjectParamBuilder<T> objectParam( /* @Nullable */final T
paramObj )
{
@@ -217,7 +217,7 @@ public final class LinkedRuleBuilder
* Constructs rule that automatically sets a property from the body text,
taking the property
* name the same as the current element.
*
- * @return a new {@link BeanPropertySetterBuilder} instance.
+ * @return A new {@link BeanPropertySetterBuilder} instance.
*/
public BeanPropertySetterBuilder setBeanProperty()
{
@@ -228,7 +228,7 @@ public final class LinkedRuleBuilder
* Sets properties on the object at the top of the stack,
* based on child elements with names matching properties on that object.
*
- * @return a new {@link NestedPropertiesBuilder} instance.
+ * @return A new {@link NestedPropertiesBuilder} instance.
*/
public NestedPropertiesBuilder setNestedProperties()
{
@@ -248,7 +248,7 @@ public final class LinkedRuleBuilder
* commonly used to establish parent-child relationships.
*
* @param methodName Method name of the parent method to call
- * @return a new {@link SetNextBuilder} instance.
+ * @return A new {@link SetNextBuilder} instance.
*/
public SetNextBuilder setNext( final String methodName )
{
@@ -264,7 +264,7 @@ public final class LinkedRuleBuilder
/**
* Sets properties on the object at the top of the stack, based on
attributes with corresponding names.
*
- * @return a new {@link SetPropertiesBuilder} instance.
+ * @return A new {@link SetPropertiesBuilder} instance.
*/
public SetPropertiesBuilder setProperties()
{
@@ -283,7 +283,7 @@ public final class LinkedRuleBuilder
* Sets an individual property on the object at the top of the stack,
based on attributes with specified names.
*
* @param attributePropertyName Name of the attribute that will contain
the name of the property to be set
- * @return a new {@link SetPropertyBuilder} instance.
+ * @return A new {@link SetPropertyBuilder} instance.
*/
public SetPropertyBuilder setProperty( final String attributePropertyName )
{
@@ -305,7 +305,7 @@ public final class LinkedRuleBuilder
* Calls a method on the root object on the stack, passing the top object
(child) as an argument.
*
* @param methodName Method name of the parent method to call
- * @return a new {@link SetRootBuilder} instance.
+ * @return A new {@link SetRootBuilder} instance.
*/
public SetRootBuilder setRoot( final String methodName )
{
@@ -322,7 +322,7 @@ public final class LinkedRuleBuilder
* Calls a "set top" method on the top (child) object, passing the (top-1)
(parent) object as an argument.
*
* @param methodName Method name of the "set parent" method to call
- * @return a new {@link SetTopBuilder} instance.
+ * @return A new {@link SetTopBuilder} instance.
*/
public SetTopBuilder setTop( final String methodName )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RuleProvider.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RuleProvider.java
index d0806599..26f75d1e 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RuleProvider.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/RuleProvider.java
@@ -33,7 +33,7 @@ public interface RuleProvider<R extends Rule>
/**
* Provides an instance of {@link Rule}. Must never return null.
*
- * @return an instance of {@link Rule}.
+ * @return An instance of {@link Rule}.
*/
R get();
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RuleFinder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RuleFinder.java
index 894a40ed..abc44e10 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RuleFinder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RuleFinder.java
@@ -64,7 +64,7 @@ public abstract class RuleFinder
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RulesFactory.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RulesFactory.java
index ef993620..3997c30b 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RulesFactory.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/RulesFactory.java
@@ -41,7 +41,7 @@ public abstract class RulesFactory
*
* @param d is the digester that the returned rules object will be
associated with.
* @param pluginClass is the class that is to be configured using rules
added to the returned object.
- * @return an instance of some Rules implementation that the plugged-in
class shall use to match its private parsing
+ * @return An instance of some Rules implementation that the plugged-in
class shall use to match its private parsing
* rules.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid about that
* source.
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
index 1d021452..18a79158 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
@@ -93,7 +93,7 @@ public class FinderFromClass
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
index f131a821..17bb2bf1 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
@@ -77,7 +77,7 @@ public class FinderFromDfltClass
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
index 8257a9fc..a1ae24ee 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
@@ -70,7 +70,7 @@ public class FinderFromDfltMethod
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltResource.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltResource.java
index 5be65cae..a3dbb07d 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltResource.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltResource.java
@@ -74,7 +74,7 @@ public class FinderFromDfltResource
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
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 28466c3f..75ab4ff0 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
@@ -79,7 +79,7 @@ public class FinderFromFile
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
index 6483b1f2..04c8b82b 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
@@ -76,7 +76,7 @@ public class FinderFromMethod
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
index d95f9b26..dafda233 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
@@ -52,7 +52,7 @@ public class FinderFromResource
* @param pluginClass is the class whose XML params the rules are parsing.
* @param is is where the xmlrules will be read from, and must be non-null.
* @param resourceName is a string describing the source of the xmlrules,
for use in generating error messages.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if any error occurs
*/
public static RuleLoader loadRules( final Digester d, final Class<?>
pluginClass, final InputStream is, final String resourceName )
@@ -112,7 +112,7 @@ public class FinderFromResource
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java
index 02da0e1e..03e15167 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java
@@ -87,7 +87,7 @@ public class FinderSetProperties
* @param pluginClass The plugin Java class
* @param p The properties object that holds any XML attributes the user
may have specified on the plugin
* declaration in order to indicate how to locate the plugin
rules.
- * @return a source of digester rules for the specified plugin class.
+ * @return A source of digester rules for the specified plugin class.
* @throws PluginException if the algorithm finds a source of rules, but
there is something invalid
* about that source.
*/
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/substitution/VariableExpansionTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/substitution/VariableExpansionTestCase.java
index d99de3d8..a0ffb661 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/substitution/VariableExpansionTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/substitution/VariableExpansionTestCase.java
@@ -62,7 +62,7 @@ public class VariableExpansionTestCase
/**
* Creates a Digester configured to show Ant-like capability.
*
- * @return a Digester with rules and variable substitutor
+ * @return A Digester with rules and variable substitutor
*/
private Digester createDigesterThatCanDoAnt()
{
