Normalize Javadoc @param.

Author: garydgregory

src/main/java/org/apache/commons/xml/secure/FallbackIgnoreURIResolver.java

@@ -61,7 +61,7 @@ final class FallbackIgnoreURIResolver implements URIResolver {
      * received cannot surface in another resolution.
      * </p>
      *
-     * @param factory the factory to create the document builder with.
+     * @param factory The factory to create the document builder with.
      * @return a new empty document.
      * @throws IllegalStateException Thrown if the factory cannot supply a {@link javax.xml.parsers.DocumentBuilder} satisfying its configuration.
      */
@@ -89,8 +89,8 @@ private static Document newEmptyDocument(final DocumentBuilderFactory factory) {
     /**
      * Constructs a new resolver.
      *
-     * @param delegate         the resolver to delegate resolution to; may be {@code null}.
-     * @param emptySource      the empty-{@link Source} supplier for the ignore outcome, or {@code null} for the default empty DOM document.
+     * @param delegate         The resolver to delegate resolution to; may be {@code null}.
+     * @param emptySource      The empty-{@link Source} supplier for the ignore outcome, or {@code null} for the default empty DOM document.
      * @param overrideDefaultParser whether the opted-in rewrite should use the pluggable parser lookup instead of the platform's built-in parser, read at each resolution.
      */
     FallbackIgnoreURIResolver(final URIResolver delegate, final Supplier<Source> emptySource, final BooleanSupplier overrideDefaultParser) {

src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java

@@ -46,7 +46,7 @@ final class SecureDocumentBuilder extends DocumentBuilder {
     /**
      * Constructs a new instance.
      *
-     * @param delegate the delegate to wrap; must not be {@code null}.
+     * @param delegate The delegate to wrap; must not be {@code null}.
      * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
      */
     SecureDocumentBuilder(final DocumentBuilder delegate) {

src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java

@@ -61,7 +61,7 @@ private static final class Wrapper extends DocumentBuilderFactory {
         /**
          * Constructs a new instance.
          *
-         * @param delegate the delegate to wrap; must not be {@code null}.
+         * @param delegate The delegate to wrap; must not be {@code null}.
          * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
          */
         private Wrapper(final DocumentBuilderFactory delegate) {
@@ -186,7 +186,7 @@ public void setXIncludeAware(final boolean state) {
     /**
      * Enables namespace awareness on the given factory; the {@code NSInstance} counterpart of each factory method routes its result through here.
      *
-     * @param factory the factory to configure; never {@code null}.
+     * @param factory The factory to configure; never {@code null}.
      * @return The given factory, namespace-aware.
      */
     private static DocumentBuilderFactory makeNSAware(final DocumentBuilderFactory factory) {

src/main/java/org/apache/commons/xml/secure/SecureException.java

@@ -47,9 +47,9 @@ final class SecureException extends IllegalStateException {
 
     /**
      * Builds the standard exception for a rejected secure setting.
-     * @param name   the name of the feature, attribute or property that could not be set.
-     * @param target the factory, parser, validator or reader that rejected the setting; its concrete class names the offending implementation.
-     * @param cause  the original checked or unchecked exception from the JAXP implementation.
+     * @param name   The name of the feature, attribute or property that could not be set.
+     * @param target The factory, parser, validator or reader that rejected the setting; its concrete class names the offending implementation.
+     * @param cause  The original checked or unchecked exception from the JAXP implementation.
      *
      * @return the exception to throw.
      */
@@ -60,11 +60,11 @@ static SecureException featureFailed(final String name, final Object target, fin
     /**
      * Builds the standard "forbidden" message shared by every resolver floor when {@link #throwOnUnresolved()} rejects an unresolved reference.
      *
-     * @param type      the resource kind, or {@code null} if not applicable.
-     * @param namespace the namespace (or, for Woodstox, the entity name), or {@code null}.
-     * @param publicId  the public identifier, or {@code null} if none.
-     * @param systemId  the system identifier of the denied resource.
-     * @param baseURI   the base URI for relative resolution, or {@code null}.
+     * @param type      The resource kind, or {@code null} if not applicable.
+     * @param namespace The namespace (or, for Woodstox, the entity name), or {@code null}.
+     * @param publicId  The public identifier, or {@code null} if none.
+     * @param systemId  The system identifier of the denied resource.
+     * @param baseURI   The base URI for relative resolution, or {@code null}.
      * @return the message naming the denied lookup and the enabling property.
      */
     static String forbidden(final String type, final String namespace, final String publicId, final String systemId, final String baseURI) {
@@ -78,7 +78,7 @@ static String forbidden(final String type, final String namespace, final String
      * <p>Every supported implementation provides a reader as a routine capability, so the wrapped {@code ParserConfigurationException} or
      * {@code SAXException} signals a broken environment, not a per-parse condition — hence unchecked.</p>
      *
-     * @param cause the original checked exception from the JAXP implementation.
+     * @param cause The original checked exception from the JAXP implementation.
      * @return the exception to throw.
      */
     static SecureException readerFailed(final Throwable cause) {

src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java

@@ -50,7 +50,7 @@ final class SecureSAXParser extends SAXParser {
     /**
      * Constructs a new instance.
      *
-     * @param delegate the delegate to wrap; must not be {@code null}.
+     * @param delegate The delegate to wrap; must not be {@code null}.
      * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
      */
     SecureSAXParser(final SAXParser delegate) {

src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java

@@ -94,7 +94,7 @@ private static final class Wrapper extends SAXParserFactory {
         /**
          * Constructs a new instance.
          *
-         * @param delegate the delegate to wrap; must not be {@code null}.
+         * @param delegate The delegate to wrap; must not be {@code null}.
          * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
          */
         private Wrapper(final SAXParserFactory delegate) {
@@ -179,7 +179,7 @@ public void setXIncludeAware(final boolean state) {
     /**
      * Enables namespace awareness on the given factory; the {@code NSInstance} counterpart of each factory method routes its result through here.
      *
-     * @param factory the factory to configure; never {@code null}.
+     * @param factory The factory to configure; never {@code null}.
      * @return The given factory, namespace-aware.
      */
     private static SAXParserFactory makeNSAware(final SAXParserFactory factory) {
@@ -336,7 +336,7 @@ static XMLReader newXMLReader(final boolean overrideDefaultParser) {
      *         chain its own resolver onto the floor to allow-list resources, but cannot remove it.</li>
      * </ul>
      *
-     * @param factory the factory to secure; never {@code null}.
+     * @param factory The factory to secure; never {@code null}.
      * @return a secure factory.
      */
     static SAXParserFactory secure(final SAXParserFactory factory) {
@@ -355,7 +355,7 @@ static SAXParserFactory secure(final SAXParserFactory factory) {
      * as-is. Used by the TrAX and schema wrappers to route every source they parse through the secure SAX path.
      * </p>
      *
-     * @param source           the source to secure; never {@code null}.
+     * @param source           The source to secure; never {@code null}.
      * @param overrideDefaultParser whether {@value #OVERRIDE_DEFAULT_PARSER} on the originating factory asks to override the JDK's default parser.
      * @return a secure source.
      * @throws IllegalStateException     Thrown if the underlying implementation cannot provide a secure reader.

src/main/java/org/apache/commons/xml/secure/SecureSchema.java

@@ -41,7 +41,7 @@ final class SecureSchema extends Schema {
     /**
      * Constructs a new instance.
      *
-     * @param delegate         the delegate to wrap; must not be {@code null}.
+     * @param delegate         The delegate to wrap; must not be {@code null}.
      * @param overrideDefaultParser whether the produced Validators' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
      * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
      */

src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java

@@ -96,7 +96,7 @@ private static final class Wrapper extends SchemaFactory {
         /**
          * Constructs a new instance.
          *
-         * @param delegate the delegate to wrap; must not be {@code null}.
+         * @param delegate The delegate to wrap; must not be {@code null}.
          * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
          */
         private Wrapper(final SchemaFactory delegate) {
@@ -167,7 +167,7 @@ private boolean overrideDefaultParser() {
         /**
          * Secures every schema source through {@link SecureSAXParserFactory#secure(Source, boolean)}.
          *
-         * @param schemas the schema sources to secure; must not be {@code null}.
+         * @param schemas The schema sources to secure; must not be {@code null}.
          * @return a new array of secure sources.
          * @throws IllegalStateException     Thrown if the underlying implementation cannot provide a secure reader.
          * @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service
@@ -272,7 +272,7 @@ public static SchemaFactory newInstance(final String schemaLanguage, final Strin
      * and instance documents is secured separately, through {@link SecureSAXParserFactory#secure(javax.xml.transform.Source, boolean)}; the factory carries
      * {@code FEATURE_SECURE_PROCESSING} for the one limit that reader cannot supply, the loader's content-model expansion.</p>
      *
-     * @param factory the factory to secure; never {@code null}.
+     * @param factory The factory to secure; never {@code null}.
      * @return a secure factory.
      */
     static SchemaFactory secure(final SchemaFactory factory) {
@@ -282,9 +282,9 @@ static SchemaFactory secure(final SchemaFactory factory) {
     /**
      * Sets a feature on the delegate, failing closed: an implementation that cannot accept it yields no factory rather than an unsecured one.
      *
-     * @param factory the factory to configure; never {@code null}.
-     * @param feature the feature name.
-     * @param value   the value to set.
+     * @param factory The factory to configure; never {@code null}.
+     * @param feature The feature name.
+     * @param value   The value to set.
      * @throws SecureException Thrown if the implementation rejects the feature.
      */
     private static void setFeature(final SchemaFactory factory, final String feature, final boolean value) {

src/main/java/org/apache/commons/xml/secure/SecureTemplates.java

@@ -60,9 +60,9 @@ final class SecureTemplates implements Templates {
     /**
      * Constructs a new instance.
      *
-     * @param delegate         the delegate to wrap; must not be {@code null}.
-     * @param uriResolver      the compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
-     * @param emptySource      the empty-{@link Source} supplier for the produced Transformers.
+     * @param delegate         The delegate to wrap; must not be {@code null}.
+     * @param uriResolver      The compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
+     * @param emptySource      The empty-{@link Source} supplier for the produced Transformers.
      * @param overrideDefaultParser whether the produced Transformers' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
      * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
      */

src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java

@@ -59,9 +59,9 @@ final class SecureTemplatesHandler implements TemplatesHandler {
     /**
      * Constructs a new instance.
      *
-     * @param delegate the delegate to wrap; must not be {@code null}.
-     * @param uriResolver the compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
-     * @param emptySource the empty-{@link Source} supplier for the produced Templates; may be {@code null} for the default empty DOM document.
+     * @param delegate The delegate to wrap; must not be {@code null}.
+     * @param uriResolver The compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
+     * @param emptySource The empty-{@link Source} supplier for the produced Templates; may be {@code null} for the default empty DOM document.
      * @param overrideDefaultParser whether the produced Templates' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
      * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
      */