Minor JavaDoc corrections

stklcode · Dec 24, 2016 · 17145e5 · 17145e5
1 parent e988833
commit 17145e5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/src/main/java/de/stklcode/jvault/connector/HTTPVaultConnector.java b/src/main/java/de/stklcode/jvault/connector/HTTPVaultConnector.java
@@ -135,7 +135,8 @@ public HTTPVaultConnector(String baseURL) {
     /**
      * Create connector using full URL and trusted certificate.
      *
-     * @param baseURL The URL
+     * @param baseURL    The URL
+     * @param sslContext Custom SSL Context
      */
     public HTTPVaultConnector(String baseURL, SSLContext sslContext) {
         this.baseURL = baseURL;

diff --git a/src/main/java/de/stklcode/jvault/connector/VaultConnector.java b/src/main/java/de/stklcode/jvault/connector/VaultConnector.java
@@ -405,6 +405,7 @@ default boolean registerAppUserId(final String appID, final String policy, final
      *
      * @param leaseID   the lase ID
      * @return Renewed lease
+     * @throws VaultConnectorException on error
      */
     default SecretResponse renew(final String leaseID) throws VaultConnectorException {
         return renew(leaseID, null);
@@ -416,6 +417,7 @@ default SecretResponse renew(final String leaseID) throws VaultConnectorExceptio
      * @param leaseID   the lase ID
      * @param increment number of seconds to extend lease time
      * @return Renewed lease
+     * @throws VaultConnectorException on error
      */
     SecretResponse renew(final String leaseID, final Integer increment) throws VaultConnectorException;
 

diff --git a/src/main/java/de/stklcode/jvault/connector/factory/HTTPVaultConnectorFactory.java b/src/main/java/de/stklcode/jvault/connector/factory/HTTPVaultConnectorFactory.java
@@ -128,6 +128,7 @@ public HTTPVaultConnectorFactory withPrefix(String prefix) {
      *
      * @param cert path to certificate file
      * @return self
+     * @throws VaultConnectorException on error
      * @since 0.4.0
      */
     public HTTPVaultConnectorFactory withTrustedCA(Path cert) throws VaultConnectorException {