[java-idp-plugin-duo] branch main updated: Javadoc improvements

[Phil Smart]

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

philsmart pushed a commit to branch main
in repository java-idp-plugin-duo.

View the commit online:
http://git.shibboleth.net/view/?p=java-idp-plugin-duo.git;a=commit;h=42a46e50b29b83443cdc71e322d2c90446d883fc

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

commit 42a46e50b29b83443cdc71e322d2c90446d883fc
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Wed Sep 9 15:15:28 2020 +0100

    Javadoc improvements
---
 .../java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClient.java     | 6 +++---
 .../net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientFactory.java   | 2 +-
 .../net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientRegistry.java  | 4 ++--
 .../idp/plugin/authn/duo/sdk/impl/DuoSDKClientAdaptor.java          | 4 ++--
 .../idp/plugin/authn/duo/sdk/impl/DuoSDKClientFactory.java          | 2 +-
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClient.java b/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClient.java
index f6ba97a..fb9a839 100644
--- a/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClient.java
+++ b/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClient.java
@@ -30,7 +30,7 @@ public interface DuoOIDCClient {
     /**
      * Check the health of the Duo 2FA endpoint. 
      * 
-     * @return the heath check response, never {@literal null}.
+     * @return the heath check response, never {@code null}.
      * 
      * @throws DuoClientException if there is an error returning the health check response
      */
@@ -42,7 +42,7 @@ public interface DuoOIDCClient {
      * @param username The user to be authenticated by Duo.
      * @param state A randomly generated minimum 22 character String, which is relied back to the client.
      * 
-     * @return the redirect URL as a string, never {@literal null}.
+     * @return the redirect URL as a string, never {@code null}.
      * 
      * @throws DuoClientException if there is an error creating the authentication URL.
      */
@@ -57,7 +57,7 @@ public interface DuoOIDCClient {
      *              about the authentication.
      * @param username The user to be authenticated by Duo.
      *
-     * @return the token, never {@literal null}.
+     * @return the token, never {@code null}.
      * 
      * @throws DuoClientException if there is an error exchanging the auth_code for a token result.
      */
diff --git a/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientFactory.java b/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientFactory.java
index a46bbf6..64ad8d9 100644
--- a/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientFactory.java
+++ b/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientFactory.java
@@ -29,7 +29,7 @@ public interface DuoOIDCClientFactory {
      * 
      * @param integration the duo integration used to instantiate the client.
      * 
-     * @return the created Duo client, never {@literal null}.
+     * @return the created Duo client, never {@code null}.
      *
      * @throws DuoClientException if there is an error creating the Duo client.
      */
diff --git a/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientRegistry.java b/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientRegistry.java
index fc3715d..13cc91c 100644
--- a/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientRegistry.java
+++ b/idp-duo-api/src/main/java/net/shibboleth/idp/plugin/authn/duo/DuoOIDCClientRegistry.java
@@ -33,9 +33,9 @@ public interface DuoOIDCClientRegistry {
      * 
      * <p>implNote: Clients could either be pre-registered, or lazy-initialised when first needed.</p>
      *  
-     * @param integration the Duo integration to find a client for, never {@literal null}.
+     * @param integration the Duo integration to find a client for, never {@code null}.
      * 
-     * @return a {@link DuoOIDCClient} appropriate for this integration, never {@literal null}.
+     * @return a {@link DuoOIDCClient} appropriate for this integration, never {@code null}.
      * 
      * @throws DuoRegistryException if there is an issue locating or creating a Duo client.
      */
diff --git a/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientAdaptor.java b/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientAdaptor.java
index df6e528..4f6c3d4 100644
--- a/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientAdaptor.java
+++ b/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientAdaptor.java
@@ -44,8 +44,8 @@ final class DuoSDKClientAdaptor implements DuoOIDCClient{
      * 
      * Constructor. Initialises the native Duo SDK client.
      *
-     * @param integration the Duo integration to initialize the client from. Never {@literal null}.
-     * @param caCerts the list of CA Certificates used to validate connections to Duo. Can be {@literal null}.
+     * @param integration the Duo integration to initialize the client from. Never {@code null}.
+     * @param caCerts the list of CA Certificates used to validate connections to Duo. Can be {@code null}.
      * 
      * @throws DuoClientException if there is an error instantiating the client
      */
diff --git a/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientFactory.java b/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientFactory.java
index 06577a2..3e3cae5 100644
--- a/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientFactory.java
+++ b/idp-duo-native-client-impl/src/main/java/net/shibboleth/idp/plugin/authn/duo/sdk/impl/DuoSDKClientFactory.java
@@ -27,7 +27,7 @@ public class DuoSDKClientFactory implements DuoOIDCClientFactory{
     
     /**
      * Sets the list of CA certificate pins used to verify the Duo client connection
-     * to the API host. If {@literal null}, the client will use the internal defaults.
+     * to the API host. If {@code null}, the client will use the internal defaults.
      * 
      * @param certs the list of certificate pins.
      */

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