[java-metadata-aggregator] branch main updated: Javadoc fixes

[Ian Young]

This is an automated email from the git hooks/post-receive script.

iay pushed a commit to branch main
in repository java-metadata-aggregator.

View the commit online:
http://git.shibboleth.net/view/?p=java-metadata-aggregator.git;a=commit;h=cf5beb5bdc4c92e74d8bb23ad1ab4f2ca3bc501e

The following commit(s) were added to refs/heads/main by this push:
     new cf5beb5  Javadoc fixes
cf5beb5 is described below

commit cf5beb5bdc4c92e74d8bb23ad1ab4f2ca3bc501e
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Mon Apr 15 10:23:41 2024 +0100

    Javadoc fixes
---
 .../shibboleth/metadata/dom/ElementsStrippingStage.java   | 15 +++++++++++++++
 .../net/shibboleth/metadata/validate/BaseValidator.java   |  4 ++--
 .../java/net/shibboleth/metadata/validate/Validator.java  |  2 +-
 3 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java
index 1bfcd7b..eab5fbd 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/ElementsStrippingStage.java
@@ -106,14 +106,29 @@ public class ElementsStrippingStage extends AbstractDOMTraversalStage<ElementsSt
             whitelisting = wl;
         }
 
+        /**
+         * Get the namespace of the elements to strip.
+         * 
+         * @return namespace of the elements to strip
+         */
         protected final @Nonnull String getElementNamespace() {
             return elementNamespace;
         }
 
+        /**
+         * Get the names of the elements to strip.
+         * 
+         * @return the names of the elements to strip
+         */
         protected final Collection<String> getElementNames() {
             return elementNames;
         }
         
+        /**
+         * Indicates whether the {@link #elementNames} are being used as a whitelist.
+         *
+         * @return <code>true</code> if the names are being used as a whitelist
+         */
         protected final boolean isWhitelisting() {
             return whitelisting;
         }
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/validate/BaseValidator.java b/mda-framework/src/main/java/net/shibboleth/metadata/validate/BaseValidator.java
index 7021028..db063b3 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/validate/BaseValidator.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/validate/BaseValidator.java
@@ -44,7 +44,7 @@ public abstract class BaseValidator extends AbstractIdentifiableInitializableCom
      * <p>
      * The generated message is formatted using this with the value being validated passed
      * as an argument.
-     * <p>
+     * </p>
      * 
      * <p>
      * Defaults to <code>"value rejected: '%s'"</code>. May be overwritten by a subclass via
@@ -56,7 +56,7 @@ public abstract class BaseValidator extends AbstractIdentifiableInitializableCom
     @Nonnull @GuardedBy("this")
     private String message;
 
-    /*
+    /**
      * Constructor.
      *
      * @since 0.10.0
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/validate/Validator.java b/mda-framework/src/main/java/net/shibboleth/metadata/validate/Validator.java
index cc7a332..d357158 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/validate/Validator.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/validate/Validator.java
@@ -93,7 +93,7 @@ public interface Validator<V> extends DestructableComponent, IdentifiableCompone
      * validation of a complex structured value such as a URI might be broken down into
      * multiple sub-validations of its components: scheme, for example. When relevant, the
      * <code>valueContext</code> provides a representation of the original complex value
-     * while </code>value</code> is the component currently being validated.
+     * while <code>value</code> is the component currently being validated.
      * </p>
      *
      * @param value the value to be validated

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.