Polishing.

Fix javadoc links.

See gh-125.
This commit is contained in:
Mark Paluch
2017-10-19 08:24:48 +02:00
parent b30d81fa43
commit bee76beff1
7 changed files with 11 additions and 11 deletions

View File

@@ -208,7 +208,7 @@ public class LeaseAwareVaultPropertySource
* map.
*
* @param data the map
* @return
* @return the flattened map.
*/
protected Map<String, String> toStringMap(Map<String, Object> data) {
return JsonMapFlattener.flatten(data);

View File

@@ -184,7 +184,7 @@ public class VaultPropertySource extends EnumerablePropertySource<VaultOperation
* map.
*
* @param data the map
* @return
* @return the flattened map.
*/
protected Map<String, String> toStringMap(Map<String, Object> data) {
return JsonMapFlattener.flatten(data);

View File

@@ -60,7 +60,7 @@ import org.springframework.web.client.HttpStatusCodeException;
/**
* Event-based container to request secrets from Vault and renew the associated
* {@link Lease}. Secrets can be rotated, depending on the requested
* {@link RequestedSecret.Mode}.
* {@link RequestedSecret#getMode()}.
*
* Usage example:
*

View File

@@ -29,9 +29,9 @@ import org.springframework.data.convert.TypeMapper;
public interface VaultTypeMapper extends TypeMapper<Map<String, Object>> {
/**
* Returns whether the given key is the type key.
* Returns whether the given {@code key} is the type key.
*
* @return
* @return {@literal true} if the {@code key} is the type key.
*/
boolean isTypeKey(String key);
}

View File

@@ -96,7 +96,7 @@ public class VaultQuery {
* Compose a new {@link VaultQuery} using predicates of {@literal this} and the
* {@code other} query using logical {@code AND}.
*
* @param other must not be {@literal null}.
* @param predicate must not be {@literal null}.
* @return a new composed {@link VaultQuery}.
* @see Predicate#and(Predicate)
*/

View File

@@ -51,11 +51,11 @@ public abstract class AbstractResult<V> {
}
/**
* Returns {@link true} if and only if the batch operation was completed successfully.
* Use {@link #getCause()} to obtain the actual exception if the operation completed
* with an error.
* Returns {@literal true} if and only if the batch operation was completed
* successfully. Use {@link #getCause()} to obtain the actual exception if the
* operation completed with an error.
*
* @return {@link true} if the batch operation was completed successfully.
* @return {@literal true} if the batch operation was completed successfully.
*/
public boolean isSuccessful() {
return exception == null;

View File

@@ -48,7 +48,7 @@ public class VaultTransitKeyCreationRequest {
/**
* Create a new {@link VaultTransitKeyCreationRequest} specifically for a {@code type}
* .
* @param the key type to use, must not be {@literal null} or empty.
* @param type the key type to use, must not be {@literal null} or empty.
* @return a new {@link VaultTransitKeyCreationRequest} for the given key {@code type}
* .
* @since 2.0