From e300147c7a439ae0cc10bc88343f181f5644a2cf Mon Sep 17 00:00:00 2001 From: David O'Sullivan Date: Thu, 22 Dec 2022 17:49:55 +0000 Subject: [PATCH] Corrects issues reported by javadoc plugin --- pom.xml | 6 +++++- .../java/org/springframework/cloud/bindings/Binding.java | 7 +++++++ .../java/org/springframework/cloud/bindings/Bindings.java | 1 + 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index d55aa60..fb33c25 100644 --- a/pom.xml +++ b/pom.xml @@ -138,7 +138,11 @@ org.apache.maven.plugins maven-javadoc-plugin ${maven-javadoc-plugin.version} - + + true + 1.8 + + attach-javadocs diff --git a/src/main/java/org/springframework/cloud/bindings/Binding.java b/src/main/java/org/springframework/cloud/bindings/Binding.java index 6a2dee3..ebd707b 100644 --- a/src/main/java/org/springframework/cloud/bindings/Binding.java +++ b/src/main/java/org/springframework/cloud/bindings/Binding.java @@ -57,6 +57,7 @@ public final class Binding { /** * Creates a new {@code Binding} instance using the specified file system root. + * @param path the path to the {@code Binding}. */ public Binding(Path path) { this(path.getFileName().toString(), path, createSecretMap(path)); @@ -140,6 +141,7 @@ public final class Binding { /** * Returns the name of the binding. + * @return the name of the binding */ public String getName() { return name; @@ -147,6 +149,7 @@ public final class Binding { /** * Returns the path of the binding. + * @return the path of the binding */ public Path getPath() { return path; @@ -154,6 +157,7 @@ public final class Binding { /** * Returns the secret of the binding. + * @return a Map of the secret of the binding */ public Map getSecret() { return Collections.unmodifiableMap(secret); @@ -161,6 +165,7 @@ public final class Binding { /** * Returns the type of the binding. + * @return the type of the binding */ public String getType() { return type; @@ -168,6 +173,7 @@ public final class Binding { /** * Returns the provider of the binding. + * @return the provider of the binding */ @Nullable public String getProvider() { @@ -178,6 +184,7 @@ public final class Binding { * Returns the {@link Path} to a secret file on disk. * * @param name the name of the secret key. + * @return the {@link Path} to a secret file on disk. */ public Path getSecretFilePath(String name) { for (String d : Arrays.asList("metadata", "secret")) { diff --git a/src/main/java/org/springframework/cloud/bindings/Bindings.java b/src/main/java/org/springframework/cloud/bindings/Bindings.java index 9403cab..4f59dd8 100644 --- a/src/main/java/org/springframework/cloud/bindings/Bindings.java +++ b/src/main/java/org/springframework/cloud/bindings/Bindings.java @@ -112,6 +112,7 @@ public final class Bindings { /** * Returns all the {@link Binding}s that were found during construction. + * @return all the {@link Binding}s that were found during construction. */ public List getBindings() { return bindings;