This is an automated email from the ASF dual-hosted git repository.
ggregory 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 0d5bd1a9 Javadoc
0d5bd1a9 is described below
commit 0d5bd1a9bb71e2d40a38d48a2cdf51e9480e4b3b
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jul 21 11:33:36 2024 -0400
Javadoc
Use HTML 'em' tag instead of 'i' tag
---
.../apache/commons/digester3/CallMethodRule.java | 6 +++---
.../apache/commons/digester3/CallParamRule.java | 2 +-
.../org/apache/commons/digester3/Digester.java | 4 ++--
.../digester3/binder/PluginCreateRuleBuilder.java | 4 ++--
.../apache/commons/digester3/plugins/LogUtils.java | 4 ++--
.../digester3/plugins/PluginAssertionFailure.java | 2 +-
.../commons/digester3/plugins/PluginContext.java | 8 ++++----
.../digester3/plugins/PluginCreateRule.java | 22 +++++++++++-----------
.../commons/digester3/plugins/PluginRules.java | 8 ++++----
.../plugins/strategies/FinderSetProperties.java | 6 +++---
.../OverlappingCallMethodRuleTestCase.java | 2 +-
.../examples/api/catalog/BookFactory.java | 2 +-
.../examples/api/dbinsert/RowInserterRule.java | 2 +-
.../examples/api/documentmarkup/Main.java | 2 +-
.../examples/xmlrules/addressbook/Main.java | 2 +-
15 files changed, 38 insertions(+), 38 deletions(-)
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 c906371b..f6bab413 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
@@ -49,8 +49,8 @@ import org.xml.sax.SAXException;
* Setting the {@code UseExactMatch} to true reverts to the use of this method.
* </p>
* <p>
- * Note that the target method is invoked when the <i>end</i> of the tag the
CallMethodRule fired on is encountered,
- * <i>not</i> when the last parameter becomes available. This implies that
rules which fire on tags nested within the
+ * Note that the target method is invoked when the <em>end</em> of the tag the
CallMethodRule fired on is encountered,
+ * <em>not</em> when the last parameter becomes available. This implies that
rules which fire on tags nested within the
* one associated with the CallMethodRule will fire before the CallMethodRule
invokes the target method. This behavior
* is not configurable.
* </p>
@@ -67,7 +67,7 @@ import org.xml.sax.SAXException;
* </p>
* <p>
* Note that when a constructor is used with paramCount=0, indicating that the
body of the element is to be passed to
- * the target method, an empty element will cause an <i>empty string</i> to be
passed to the target method, not null.
+ * the target method, an empty element will cause an <em>empty string</em> to
be passed to the target method, not null.
* And if automatic type conversion is being applied (ie if the target
function takes something other than a string as a
* parameter) then the conversion will fail if the converter class does not
accept an empty string as valid input.
* </p>
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 9c5e9909..b5bd64b1 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
@@ -70,7 +70,7 @@ public class CallParamRule
/**
* Constructs a "call parameter" rule that will save the body text of this
element as the parameter value.
* <p>
- * Note that if the element is empty the an <i>empty string</i> is passed
to the target method, not null. And if
+ * Note that if the element is empty the an <em>empty string</em> is
passed to the target method, not null. And if
* automatic type conversion is being applied (ie if the target function
takes something other than a string as a
* parameter) then the conversion will fail if the converter class does
not accept an empty string as valid input.
* </p>
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 208d14a9..60efb30e 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
@@ -1051,13 +1051,13 @@ public class Digester
* Clear the current contents of the default object stack, the param
stack, all named stacks, and other internal
* variables.
* <p>
- * Calling this method <i>might</i> allow another document of the same
type to be correctly parsed. However this
+ * Calling this method <em>might</em> allow another document of the same
type to be correctly parsed. However this
* method was not intended for this purpose (just to tidy up memory
usage). In general, a separate Digester object
* should be created for each document to be parsed.
* <p>
* Note that this method is called automatically after a document has been
successfully parsed by a Digester
* instance. However it is not invoked automatically when a parse fails,
so when reusing a Digester instance (which
- * is not recommended) this method <i>must</i> be called manually after a
parse failure.
+ * is not recommended) this method <em>must</em> be called manually after
a parse failure.
*/
public void clear()
{
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 5dc792d8..d99b8ab1 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,10 +107,10 @@ public final class PluginCreateRuleBuilder
}
/**
- * Sets the class which any specified plugin <i>must</i> be descended from.
+ * 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 <i>must</i> 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 )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/LogUtils.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/LogUtils.java
index 0029fd3b..c2a567fa 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/LogUtils.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/LogUtils.java
@@ -31,13 +31,13 @@ import org.apache.commons.logging.Log;
* the digester instance that the object *doing* the logging is associated
with.
* <p>
* This is done because apparently some "container"-type applications such as
Avalon and Tomcat need to be able to
- * configure different logging for different <i>instances</i> of the Digester
class which have been loaded from the same
+ * configure different logging for different <em>instances</em> of the
Digester class which have been loaded from the same
* ClassLoader [info from Craig McClanahan]. Not only the logging of the
Digester instance should be affected; all
* objects associated with that Digester instance should obey the
reconfiguration of their owning Digester instance's
* logging. The current solution is to force all objects to output logging
info via a single Log object stored on the
* Digester instance they are associated with.
* <p>
- * Of course this causes problems if logging is attempted before an object
<i>has</i> a valid reference to its owning
+ * Of course this causes problems if logging is attempted before an object
<em>has</em> a valid reference to its owning
* Digester. The getLogging method provided here resolves this issue by
returning a Log object which silently discards
* all logging output in this situation.
* <p>
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginAssertionFailure.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginAssertionFailure.java
index 5f1398d8..e0a00bd2 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginAssertionFailure.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginAssertionFailure.java
@@ -37,7 +37,7 @@ package org.apache.commons.digester3.plugins;
* }
* </pre>
* <p>
- * Note that PluginAssertionFailure should <i>not</i> be thrown when user
input is bad, or when code external to the
+ * Note that PluginAssertionFailure should <em>not</em> be thrown when user
input is bad, or when code external to the
* Digester module passes invalid parameters to a plugins method. It should be
used only in checks for problems which
* indicate internal bugs within the plugins module.
*
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 2598cbc6..523011ce 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
@@ -185,9 +185,9 @@ public class PluginContext
* Note that the xml attributes used by PluginDeclarationRules are not
affected by this method.
*
* @param namespaceUri is the namespace uri that the specified attribute
is in. If the attribute is in no namespace,
- * then this should be null. Note that if a namespace is used,
the attrName value should <i>not</i>
+ * then this should be null. Note that if a namespace is used,
the attrName value should <em>not</em>
* contain any kind of namespace-prefix. Note also that if you
are using a non-namespace-aware parser,
- * this parameter <i>must</i> be null.
+ * this parameter <em>must</em> be null.
* @param attrName is the attribute whose value contains the name of the
class to be instantiated.
*/
public void setPluginClassAttribute( final String namespaceUri, final
String attrName )
@@ -225,9 +225,9 @@ public class PluginContext
* Note that the xml attributes used by PluginDeclarationRules are not
affected by this method.
*
* @param namespaceUri is the namespace uri that the specified attribute
is in. If the attribute is in no namespace,
- * then this should be null. Note that if a namespace is used,
the attrName value should <i>not</i>
+ * then this should be null. Note that if a namespace is used,
the attrName value should <em>not</em>
* contain any kind of namespace-prefix. Note also that if you
are using a non-namespace-aware parser,
- * this parameter <i>must</i> be null.
+ * this parameter <em>must</em> be null.
* @param attrName is the attribute whose value contains the id of the
plugin declaration to be used when
* instantiating an object.
*/
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 132b279e..912a21b1 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
@@ -69,9 +69,9 @@ public class PluginCreateRule
private PluginConfigurationException initException;
/**
- * Create a plugin rule where the user <i>must</i> specify a plugin-class
or plugin-id.
+ * Create a plugin rule where the user <em>must</em> specify a
plugin-class or plugin-id.
*
- * @param baseClass is the class which any specified plugin <i>must</i> be
descended from.
+ * @param baseClass is the class which any specified plugin <em>must</em>
be descended from.
*/
public PluginCreateRule( final Class<?> baseClass )
{
@@ -79,10 +79,10 @@ public class PluginCreateRule
}
/**
- * Create a plugin rule where the user <i>may</i> specify a plugin. If the
user doesn't specify a plugin, then the
+ * Create a plugin rule where the user <em>may</em> specify a plugin. If
the user doesn't specify a plugin, then the
* default class specified in this constructor is used.
*
- * @param baseClass is the class which any specified plugin <i>must</i> be
descended from.
+ * @param baseClass is the class which any specified plugin <em>must</em>
be descended from.
* @param dfltPluginClass is the class which will be used if the user
doesn't specify any plugin-class or plugin-id.
* This class will have custom rules installed for it just like
a declared plugin.
*/
@@ -96,10 +96,10 @@ public class PluginCreateRule
}
/**
- * Create a plugin rule where the user <i>may</i> specify a plugin. If the
user doesn't specify a plugin, then the
+ * Create a plugin rule where the user <em>may</em> specify a plugin. If
the user doesn't specify a plugin, then the
* default class specified in this constructor is used.
*
- * @param baseClass is the class which any specified plugin <i>must</i> be
descended from.
+ * @param baseClass is the class which any specified plugin <em>must</em>
be descended from.
* @param dfltPluginClass is the class which will be used if the user
doesn't specify any plugin-class or plugin-id.
* This class will have custom rules installed for it just like
a declared plugin.
* @param dfltPluginRuleLoader is a RuleLoader instance which knows how to
load the custom rules associated with
@@ -437,7 +437,7 @@ public class PluginCreateRule
/**
* Gets the pattern that this Rule is associated with.
* <p>
- * In general, Rule instances <i>can</i> be associated with multiple
patterns. A PluginCreateRule, however, will
+ * In general, Rule instances <em>can</em> be associated with multiple
patterns. A PluginCreateRule, however, will
* only function correctly when associated with a single pattern. It is
possible to fix this, but I can't be
* bothered just now because this feature is unlikely to be used.
* </p>
@@ -586,9 +586,9 @@ public class PluginCreateRule
* See {@link PluginRules#setPluginClassAttribute} for more info.
*
* @param namespaceUri is the namespace uri that the specified attribute
is in. If the attribute is in no namespace,
- * then this should be null. Note that if a namespace is used,
the attrName value should <i>not</i>
+ * then this should be null. Note that if a namespace is used,
the attrName value should <em>not</em>
* contain any kind of namespace-prefix. Note also that if you
are using a non-namespace-aware parser,
- * this parameter <i>must</i> be null.
+ * this parameter <em>must</em> be null.
* @param attrName is the attribute whose value contains the name of the
class to be instantiated.
*/
public void setPluginClassAttribute( final String namespaceUri, final
String attrName )
@@ -604,9 +604,9 @@ public class PluginCreateRule
* See {@link PluginRules#setPluginIdAttribute} for more info.
*
* @param namespaceUri is the namespace uri that the specified attribute
is in. If the attribute is in no namespace,
- * then this should be null. Note that if a namespace is used,
the attrName value should <i>not</i>
+ * then this should be null. Note that if a namespace is used,
the attrName value should <em>not</em>
* contain any kind of namespace-prefix. Note also that if you
are using a non-namespace-aware parser,
- * this parameter <i>must</i> be null.
+ * this parameter <em>must</em> be null.
* @param attrName is the attribute whose value contains the id of the
plugin declaration to be used when
* instantiating an object.
*/
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 257e5314..1dae12fb 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
@@ -417,9 +417,9 @@ public class PluginRules
* See {@link PluginContext#setPluginClassAttribute}.
*
* @param namespaceUri is the namespace uri that the specified attribute
is in. If the attribute is in no namespace,
- * then this should be null. Note that if a namespace is used,
the attrName value should <i>not</i>
+ * then this should be null. Note that if a namespace is used,
the attrName value should <em>not</em>
* contain any kind of namespace-prefix. Note also that if you
are using a non-namespace-aware parser,
- * this parameter <i>must</i> be null.
+ * this parameter <em>must</em> be null.
* @param attrName is the attribute whose value contains the name of the
class to be instantiated.
* */
public void setPluginClassAttribute( final String namespaceUri, final
String attrName )
@@ -431,9 +431,9 @@ public class PluginRules
* See {@link PluginContext#setPluginIdAttribute}.
*
* @param namespaceUri is the namespace uri that the specified attribute
is in. If the attribute is in no namespace,
- * then this should be null. Note that if a namespace is used,
the attrName value should <i>not</i>
+ * then this should be null. Note that if a namespace is used,
the attrName value should <em>not</em>
* contain any kind of namespace-prefix. Note also that if you
are using a non-namespace-aware parser,
- * this parameter <i>must</i> be null.
+ * this parameter <em>must</em> be null.
* @param attrName is the attribute whose value contains the id of the
plugin declaration to be used when
* instantiating an object.
**/
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 e66b330a..b30c05e1 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
@@ -34,7 +34,7 @@ import org.apache.commons.digester3.plugins.RuleLoader;
* This allows ordinary JavaBean classes to be used as plugins, and have xml
attributes be mapped to bean properties of
* the same name, without any custom plugin rules being created for them.
* <p>
- * This RuleFinder is typically used as the <i>last</i> RuleFinder, so that
automatic property setting only occurs if
+ * This RuleFinder is typically used as the <em>last</em> RuleFinder, so that
automatic property setting only occurs if
* there is no other source of custom rules available.
*
* @since 1.6
@@ -73,12 +73,12 @@ public class FinderSetProperties
}
/**
- * Returns a RuleLoader <i>unless</i> the properties contain an entry with
the name matching constructor param
+ * Returns a RuleLoader <em>unless</em> the properties contain an entry
with the name matching constructor param
* propsAttr, and the value matching what is in falseval.
* <p>
* If no custom source of rules for a plugin is found, then the user
almost always wants xml attributes to map to
* Java bean properties, so this is the default behavior unless the user
explicitly indicates that they do
- * <i>not</i> want a SetPropertiesRule to be provided for the plugged-in
class.
+ * <em>not</em> want a SetPropertiesRule to be provided for the plugged-in
class.
* <p>
* The returned object (when non-null) will add a SetPropertiesRule to the
digester whenever its addRules method is
* invoked.
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/OverlappingCallMethodRuleTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/OverlappingCallMethodRuleTestCase.java
index 783c7a20..c8e5ae6c 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/OverlappingCallMethodRuleTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/OverlappingCallMethodRuleTestCase.java
@@ -162,7 +162,7 @@ public class OverlappingCallMethodRuleTestCase
}
/**
- * This is an "anti-test" that demonstrates how digester can <i>fails</i>
to produce the correct results, due to a
+ * This is an "anti-test" that demonstrates how digester can
<em>fails</em> to produce the correct results, due to a
* design flaw (or at least limitation) in the way that CallMethodRule and
CallParamRule work.
* <p>
* The following sequence always fails:
diff --git
a/commons-digester3-examples/api/catalog/src/main/java/org/apache/commons/digester3/examples/api/catalog/BookFactory.java
b/commons-digester3-examples/api/catalog/src/main/java/org/apache/commons/digester3/examples/api/catalog/BookFactory.java
index 0c2727c3..fd6c5ba9 100644
---
a/commons-digester3-examples/api/catalog/src/main/java/org/apache/commons/digester3/examples/api/catalog/BookFactory.java
+++
b/commons-digester3-examples/api/catalog/src/main/java/org/apache/commons/digester3/examples/api/catalog/BookFactory.java
@@ -35,7 +35,7 @@ import org.xml.sax.Attributes;
* JNDI references, database connections, etc) that it may in the
* process of generating an appropriate object.
* <p>
- * Note that it is <i>not</i> possible for any data to be extracted
+ * Note that it is <em>not</em> possible for any data to be extracted
* from the body or subelements of the xml element that caused the
* createObject method on this factory to be invoked. For example:
* <pre>
diff --git
a/commons-digester3-examples/api/dbinsert/src/main/java/org/apache/commons/digester3/examples/api/dbinsert/RowInserterRule.java
b/commons-digester3-examples/api/dbinsert/src/main/java/org/apache/commons/digester3/examples/api/dbinsert/RowInserterRule.java
index b0c698cd..73fd7965 100644
---
a/commons-digester3-examples/api/dbinsert/src/main/java/org/apache/commons/digester3/examples/api/dbinsert/RowInserterRule.java
+++
b/commons-digester3-examples/api/dbinsert/src/main/java/org/apache/commons/digester3/examples/api/dbinsert/RowInserterRule.java
@@ -57,7 +57,7 @@ public class RowInserterRule
* real implementation should be fairly simple.
* <p>
* Note that after this rule completes, the row/column information is
- * <i>discarded</i>, ie this rule performs actions <i>as the input is
+ * <em>discarded</em>, ie this rule performs actions <i>as the input is
* parsed</i>. This contrasts with the more usual way digester is used,
* which is to build trees of objects for later use. But it's a perfectly
* valid use of Digester.
diff --git
a/commons-digester3-examples/api/document-markup/src/main/java/org/apache/commons/digester3/examples/api/documentmarkup/Main.java
b/commons-digester3-examples/api/document-markup/src/main/java/org/apache/commons/digester3/examples/api/documentmarkup/Main.java
index d0748a15..95659a41 100644
---
a/commons-digester3-examples/api/document-markup/src/main/java/org/apache/commons/digester3/examples/api/documentmarkup/Main.java
+++
b/commons-digester3-examples/api/document-markup/src/main/java/org/apache/commons/digester3/examples/api/documentmarkup/Main.java
@@ -37,7 +37,7 @@ public class Main
}
/** The input xml to be parsed by this example. */
- String in = "<p>Hi, this is an <i>example</i> of some <b>bold</b>
text.</p>";
+ String in = "<p>Hi, this is an <em>example</em> of some <b>bold</b>
text.</p>";
/**
* Invoked via a standard Digester CallMethodRule, passing the
diff --git
a/commons-digester3-examples/xmlrules/addressbook/src/main/java/org/apache/commons/digester3/examples/xmlrules/addressbook/Main.java
b/commons-digester3-examples/xmlrules/addressbook/src/main/java/org/apache/commons/digester3/examples/xmlrules/addressbook/Main.java
index 2f5a5fff..9b42e255 100644
---
a/commons-digester3-examples/xmlrules/addressbook/src/main/java/org/apache/commons/digester3/examples/xmlrules/addressbook/Main.java
+++
b/commons-digester3-examples/xmlrules/addressbook/src/main/java/org/apache/commons/digester3/examples/xmlrules/addressbook/Main.java
@@ -41,7 +41,7 @@ import org.xml.sax.SAXException;
* potentially makes it somewhat easier to review the parsing rules.
* <p>
* Note, however, that there is tyically quite a tight coupling between
- * the parsing rules and the <i>purpose</i> of the application which means
+ * the parsing rules and the <em>purpose</em> of the application which means
* that it may not be all that common for parsing rules to be altered
* without the application code also being altered, so only in some cases
* will this prove of benefit. As with all software, it must be determined
