Javadoc updates

Author: steve-perkins

src/main/java/com/bettercloud/vault/Vault.java

@@ -76,6 +76,9 @@ public Vault(final VaultConfig vaultConfig) {
 
     /**
      * Construct a Vault driver instance with the provided config settings, and use the provided global KV Engine version for all secrets.
+     *
+     * @param vaultConfig             Configuration settings for Vault interaction (e.g. server address, token, etc)
+     * @param engineVersion           Which version of the Key/Value Secret Engine to use globally (i.e. 1 or 2)
      */
     public Vault(final VaultConfig vaultConfig, final Integer engineVersion) {
         if (engineVersion < 1 || engineVersion > 2) {
@@ -99,6 +102,8 @@ public Vault(final VaultConfig vaultConfig, final Integer engineVersion) {
      *                                If a secrets KV Engine version map is not supplied, use Vault APIs to determine the
      *                                KV Engine version for each secret. This call requires admin rights.
      * @param globalFallbackVersion   The Integer version of the KV Engine to use as a global fallback.
+     *
+     * @throws VaultException         If any error occurs
      */
     public Vault(final VaultConfig vaultConfig, final Boolean useSecretsEnginePathMap, final Integer globalFallbackVersion)
             throws VaultException {

src/main/java/com/bettercloud/vault/VaultConfig.java

@@ -83,6 +83,8 @@ public VaultConfig environmentLoader(final EnvironmentLoader environmentLoader)
      * @param nameSpace The namespace to use globally in this VaultConfig instance.
      * @return This object, with the namespace populated, ready for additional builder-pattern method calls or else
      * finalization with the build() method
+     *
+     * @throws VaultException  If any error occurs
      */
     public VaultConfig nameSpace(final String nameSpace) throws VaultException {
         if (nameSpace != null && !nameSpace.isEmpty()) {

src/main/java/com/bettercloud/vault/api/Logical.java

@@ -649,7 +649,6 @@ private Integer engineVersionForSecretPath(final String secretPath) {
      *
      * @param path The Vault secret path to check (e.g. <code>secret/</code>).
      * @return The response information received from Vault
-     * @throws VaultException If any error occurs, or unexpected response received from Vault
      */
     public Integer getEngineVersionForSecretPath(final String path) {
         return this.engineVersionForSecretPath(path);

src/main/java/com/bettercloud/vault/api/LogicalUtilities.java

@@ -100,6 +100,8 @@ public static String adjustPathForList(final String path, final Logical.logicalO
      *
      * @param path      The Vault path to check or mutate, based on the operation.
      * @param operation The operation being performed, e.g. readV2 or writeV1.
+     *
+     * @return The modified path
      */
     public static String adjustPathForDelete(final String path, final Logical.logicalOperations operation) {
         final List<String> pathSegments = getPathSegments(path);
@@ -118,6 +120,8 @@ public static String adjustPathForDelete(final String path, final Logical.logica
      * When deleting secret versions, you must inject the path segment "delete" right after the lowest-level path segment.
      *
      * @param path The Vault path to check or mutate, based on the operation.
+     *
+     * @return The modified path
      */
     public static String adjustPathForVersionDelete(final String path) {
         final List<String> pathSegments = getPathSegments(path);