[java-shib-shared] branch main updated: Fix javadoc warnings.

[Scott Cantor]

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

scantor pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-shared.git;a=commit;h=37f6e355e2430bf9deb68e6af800b3e6342b66c8

The following commit(s) were added to refs/heads/main by this push:
     new 37f6e355 Fix javadoc warnings.
37f6e355 is described below

commit 37f6e355e2430bf9deb68e6af800b3e6342b66c8
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Wed Oct 18 10:30:49 2023 -0400

    Fix javadoc warnings.
---
 .../java/net/shibboleth/shared/cli/AbstractCommandLine.java |  2 +-
 .../shibboleth/shared/security/DataSealerKeyStrategy.java   |  3 +++
 .../spring/custom/AbstractCustomBeanDefinitionParser.java   |  1 +
 .../net/shibboleth/shared/testing/InMemoryDirectory.java    | 13 +++++++++++++
 4 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/shib-cli/src/main/java/net/shibboleth/shared/cli/AbstractCommandLine.java b/shib-cli/src/main/java/net/shibboleth/shared/cli/AbstractCommandLine.java
index ff41396b..164b4a7e 100644
--- a/shib-cli/src/main/java/net/shibboleth/shared/cli/AbstractCommandLine.java
+++ b/shib-cli/src/main/java/net/shibboleth/shared/cli/AbstractCommandLine.java
@@ -139,7 +139,7 @@ public abstract class AbstractCommandLine<T extends CommandLineArguments> {
      * 
      * <p>Default is true.</p>
      * 
-     * @param flag
+     * @param flag flag to set
      * 
      * @since 9.0.0
      */
diff --git a/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java b/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java
index a3e66546..a7fb2588 100644
--- a/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java
+++ b/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java
@@ -79,6 +79,9 @@ public interface DataSealerKeyStrategy {
 
         /**
          * Constructor.
+         * 
+         * @param name key name
+         * @param key key value
          */
         public NamedKey {
             Constraint.isTrue(name != null && name.length() > 0, "Name cannot be empty or null");
diff --git a/shib-spring/src/main/java/net/shibboleth/shared/spring/custom/AbstractCustomBeanDefinitionParser.java b/shib-spring/src/main/java/net/shibboleth/shared/spring/custom/AbstractCustomBeanDefinitionParser.java
index be12028b..e1461387 100644
--- a/shib-spring/src/main/java/net/shibboleth/shared/spring/custom/AbstractCustomBeanDefinitionParser.java
+++ b/shib-spring/src/main/java/net/shibboleth/shared/spring/custom/AbstractCustomBeanDefinitionParser.java
@@ -44,6 +44,7 @@ public class AbstractCustomBeanDefinitionParser extends AbstractSingleBeanDefini
     @Nonnull @NotEmpty
     public static final String CUSTOM_PARSER_PROPERTIES_LOCATION = "META-INF/net/shibboleth/spring/parser.properties";
 
+    /** Property bad for custom parser properties to expose to subclasses. */
     @Nullable private static Properties customProperties;
     
     /** Logger. */
diff --git a/shib-testing/src/main/java/net/shibboleth/shared/testing/InMemoryDirectory.java b/shib-testing/src/main/java/net/shibboleth/shared/testing/InMemoryDirectory.java
index c0024499..4f3abaa6 100644
--- a/shib-testing/src/main/java/net/shibboleth/shared/testing/InMemoryDirectory.java
+++ b/shib-testing/src/main/java/net/shibboleth/shared/testing/InMemoryDirectory.java
@@ -271,16 +271,19 @@ public class InMemoryDirectory {
         /** The socket list. */
         @Nonnull private List<Socket> sockets = new ArrayList<>();
 
+        /** {@inheritDoc} */
         @Override
         public ServerSocket createServerSocket(final int port) throws IOException {
             return new CustomServerSocket(port, 50 ,null);
         }
 
+        /** {@inheritDoc} */
         @Override
         public ServerSocket createServerSocket(final int port, final int backlog) throws IOException {
             return new CustomServerSocket(port, backlog ,null);
         }
 
+        /** {@inheritDoc} */
         @Override
         public ServerSocket createServerSocket(final int port, final int backlog, final InetAddress ifAddress)
             throws IOException {
@@ -290,11 +293,21 @@ public class InMemoryDirectory {
         /** ServerSocket wrapper class to track created sockets. */
         private class CustomServerSocket extends ServerSocket {
 
+            /**
+             * Constructor.
+             *
+             * @param port socket port
+             * @param backlog listen backlog size
+             * @param bindAddr socket address
+             * 
+             * @throws IOException on error
+             */
             public CustomServerSocket(final int port, final int backlog, final InetAddress bindAddr)
                 throws IOException {
                 super(port, backlog, bindAddr);
             }
 
+            /** {@inheritDoc} */
             @Override
             public Socket accept() throws IOException {
                 final Socket socket = super.accept();

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