[java-identity-provider] 02/02: Add some extra javadoc.

[Rod Widdowson]

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

rdw pushed a commit to branch main
in repository java-identity-provider.

View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=a0b5b8db31b7a131b0c1949cd8953d1ee3f1cb53

commit a0b5b8db31b7a131b0c1949cd8953d1ee3f1cb53
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Wed Nov 17 17:34:33 2021 +0000

    Add some extra javadoc.
    
    The javadoc plugin whines if a @param doesn't have a description.
    
    Add them, even if meaningless.
---
 .../main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java    | 2 +-
 .../src/main/java/net/shibboleth/idp/admin/impl/JarCheckCLI.java        | 2 +-
 .../main/java/net/shibboleth/idp/plugin/impl/FirstPartyIdPPlugin.java   | 2 +-
 .../java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java     | 2 +-
 .../saml/saml2/profile/delegation/impl/DecorateDelegatedAssertion.java  | 1 +
 .../shibboleth/idp/saml/saml2/profile/impl/PreProcessLogoutMessage.java | 2 +-
 .../net/shibboleth/idp/saml/saml2/profile/impl/SAMLAuthnController.java | 2 +-
 7 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java b/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java
index 9f40b5d47..39f8c3f9c 100644
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java
+++ b/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java
@@ -220,7 +220,7 @@ public abstract class PropertyDrivenIdPPlugin extends AbstractIdPPlugin {
      * Provides default update locations to use.
      * 
      * @return default update locations
-     * @throws PluginException 
+     * @throws PluginException if a derived class throws it (see derived classes)
      */
     @Nonnull @NonnullElements @Unmodifiable @NotLive protected List<URL> getDefaultUpdateURLs() throws PluginException {
         return Collections.emptyList();
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/JarCheckCLI.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/JarCheckCLI.java
index 75c7d4d3c..311c6bf09 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/JarCheckCLI.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/JarCheckCLI.java
@@ -65,7 +65,7 @@ public final class JarCheckCLI extends AbstractIdPHomeAwareCommandLine<JarCheckA
     @Nonnull private List<String> distJars = Collections.emptyList();
 
     /** Populate {@link #webAppJars}, {@link #pluginJars} and {@link #distJars}. 
-     * @param args
+     * @param args the arguments
      */
     private void loadJarFiles(final JarCheckArguments args) {
         final Path idpHome = Path.of(args.getIdPHome());
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/plugin/impl/FirstPartyIdPPlugin.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/plugin/impl/FirstPartyIdPPlugin.java
index 0fa506a7d..e407a1c05 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/plugin/impl/FirstPartyIdPPlugin.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/plugin/impl/FirstPartyIdPPlugin.java
@@ -50,7 +50,7 @@ public class FirstPartyIdPPlugin extends PropertyDrivenIdPPlugin {
     }
 
     /** {@inheritDoc} 
-     * @throws PluginException */
+     * @throws PluginException if the URLs cannot be resolved */
     @Override
     @Nonnull @NonnullElements @Unmodifiable @NotLive public List<URL> getDefaultUpdateURLs() throws PluginException {
         try {
diff --git a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java
index 5950c300e..49eaad7f4 100644
--- a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java
+++ b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java
@@ -338,7 +338,7 @@ public class AuthenticationFlowDescriptor extends AbstractIdentifiableInitializa
      * Sets a subject decorating component called prior to completing authentication and passing
      * control to subject canonicalization.
      * 
-     * @param decorator
+     * @param decorator the decorator to set
      * 
      * @since 4.1.0
      */
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/delegation/impl/DecorateDelegatedAssertion.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/delegation/impl/DecorateDelegatedAssertion.java
index b8a528733..868b22e68 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/delegation/impl/DecorateDelegatedAssertion.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/delegation/impl/DecorateDelegatedAssertion.java
@@ -421,6 +421,7 @@ public class DecorateDelegatedAssertion extends AbstractProfileAction {
      * 
      * @return the AttributeValue object containing the EPR
      */
+    @SuppressWarnings("unchecked")
     @Nonnull private XMLObject buildLibertSSOSEPRAttributeValue(@Nonnull final ProfileRequestContext requestContext, 
             @Nonnull final Assertion assertion) {
         
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/PreProcessLogoutMessage.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/PreProcessLogoutMessage.java
index 27c16cb15..3b4c37334 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/PreProcessLogoutMessage.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/PreProcessLogoutMessage.java
@@ -98,7 +98,7 @@ public class PreProcessLogoutMessage extends AbstractProfileAction {
      * 
      * <p>Defaults to false.</p>
      * 
-     * @param flag
+     * @param flag what to set
      */
     public void setAssumeAsynchronousLogout(final boolean flag) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/SAMLAuthnController.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/SAMLAuthnController.java
index 4c2f29df5..dbf312cf5 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/SAMLAuthnController.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/saml2/profile/impl/SAMLAuthnController.java
@@ -125,7 +125,7 @@ public class SAMLAuthnController extends AbstractInitializableComponent {
     /**
      * Set inbound bindings to use to deduce ProtocolBinding attribute.
      * 
-     * @param bindings
+     * @param bindings the bindings to set
      */
     public void setInboundBindings(@Nullable @NonnullElements final Collection<BindingDescriptor> bindings) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);

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