Fix the javadoc errors

OneIdentity · Jul 20, 2023 · 607d8bc · 607d8bc
1 parent 3c818e6
commit 607d8bc
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 20 deletions.
diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardA2AContext.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardA2AContext.java
@@ -36,13 +36,13 @@ public interface ISafeguardA2AContext
     char[] retrievePassword(char[] apiKey) throws ObjectDisposedException, SafeguardForJavaException, ArgumentException;
 
     /**
-     * Sets a password using Safeguard A2A.
+     *  Sets a password using Safeguard A2A.
      *
-     * @param apiKey     API key corresponding to the configured account.
-     * @param password   Password to set.
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ArgumentException
+     *  @param apiKey     API key corresponding to the configured account.
+     *  @param password   Password to set.
+     *  @throws ObjectDisposedException Object has already been disposed.
+     *  @throws SafeguardForJavaException General Safeguard for Java exception.
+     *  @throws ArgumentException Invalid argument.
     */ 
     void SetPassword(char[] apiKey, char[] password) throws ObjectDisposedException, SafeguardForJavaException, ArgumentException;
 
@@ -70,15 +70,15 @@ public interface ISafeguardA2AContext
     List<IApiKeySecret> retrieveApiKeySecret(char[] apiKey) throws ObjectDisposedException, ArgumentException, SafeguardForJavaException;
 
     /**
-     * Sets an SSH private key using Safeguard A2A.
+     *  Sets an SSH private key using Safeguard A2A.
      *
-     * @param apiKey        API key corresponding to the configured account.
-     * @param privateKey    Private key to set.
-     * @param password      Password associated with the private key.
-     * @param keyFormat     Format to use when returning private key.              
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException              
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ArgumentException              
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException              
+     *  @param apiKey        API key corresponding to the configured account.
+     *  @param privateKey    Private key to set.
+     *  @param password      Password associated with the private key.
+     *  @param keyFormat     Format to use when returning private key.              
+     *  @throws ObjectDisposedException Object has already been disposed.
+     *  @throws SafeguardForJavaException General Safeguard for Java exception.
+     *  @throws ArgumentException Invalid argument.
      */ 
     void SetPrivateKey(char[] apiKey, char[] privateKey, char[] password, KeyFormat keyFormat) throws ObjectDisposedException, ArgumentException, SafeguardForJavaException;
 

diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardSessionsConnection.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardSessionsConnection.java
@@ -43,10 +43,10 @@ FullResponse invokeMethodFull(Method method, String relativeUrl, String body)
             throws ObjectDisposedException, SafeguardForJavaException, ArgumentException;
 
     /**
-     * Provides support for HTTP streaming requests
+     *  Provides support for HTTP streaming requests
      * 
-     * @return returns ISpsStreamingRequest
-     * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException
+     *  @return returns ISpsStreamingRequest
+     *  @throws ObjectDisposedException Object has already been disposed.
      */
     ISpsStreamingRequest getStreamingRequest() throws ObjectDisposedException;
 }
diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/StreamResponse.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/StreamResponse.java
@@ -20,9 +20,10 @@ public StreamResponse(CloseableHttpResponse resp) {
     private Long contentLength = 0L;
 
     /**
-     * Get the response stream object
+     *  Get the response stream object
      *
-     * @return The HTTP response body content as an inputstream
+     *  @return The HTTP response body content as an InputStream
+     *  @throws SafeguardForJavaException General Safeguard for Java exception.
      */
     public InputStream getStream() throws SafeguardForJavaException
     {

diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/data/SafeguardEventListenerState.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/data/SafeguardEventListenerState.java
@@ -1,6 +1,6 @@
 package com.oneidentity.safeguard.safeguardjava.data;
 
-    /** <summary>
+    /**
      * Connection state of the Safeguard event listener.
      */ 
     public enum SafeguardEventListenerState