From 38b1954ab1c75467f7cedfd42836d0cf19ec4fbb Mon Sep 17 00:00:00 2001
From: Scott Frederick <sfrederick@pivotal.io>
Date: Mon, 19 Oct 2020 15:38:02 -0500
Subject: [PATCH] Polish Maven plugin javadoc

This commit polishes the javadoc for Maven plugin classes now that
the plugin reference docs link to the javadoc. Visibility of some
MOJO parameter class getters and setters were also changed for
consistency.

See gh-21555
---
 .../springframework/boot/maven/Docker.java    | 69 +++++++++++++++----
 .../org/springframework/boot/maven/Image.java |  4 +-
 2 files changed, 57 insertions(+), 16 deletions(-)

diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Docker.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Docker.java
index 86dfa7eef6a..637de7d1483 100644
--- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Docker.java
+++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Docker.java
@@ -37,30 +37,47 @@ public class Docker {
 
 	private DockerRegistry publishRegistry;
 
+	/**
+	 * The host address of the Docker daemon.
+	 * @return the Docker host
+	 */
 	public String getHost() {
 		return this.host;
 	}
 
-	public void setHost(String host) {
+	void setHost(String host) {
 		this.host = host;
 	}
 
+	/**
+	 * Whether the Docker daemon requires TLS communication.
+	 * @return {@code true} to enable TLS
+	 */
 	public boolean isTlsVerify() {
 		return this.tlsVerify;
 	}
 
-	public void setTlsVerify(boolean tlsVerify) {
+	void setTlsVerify(boolean tlsVerify) {
 		this.tlsVerify = tlsVerify;
 	}
 
+	/**
+	 * The path to TLS certificate and key files required for TLS communication with the
+	 * Docker daemon.
+	 * @return the TLS certificate path
+	 */
 	public String getCertPath() {
 		return this.certPath;
 	}
 
-	public void setCertPath(String certPath) {
+	void setCertPath(String certPath) {
 		this.certPath = certPath;
 	}
 
+	/**
+	 * Configuration of the Docker registry where builder and run images are stored.
+	 * @return the registry configuration
+	 */
 	DockerRegistry getBuilderRegistry() {
 		return this.builderRegistry;
 	}
@@ -70,10 +87,14 @@ public class Docker {
 	 * registry.
 	 * @param builderRegistry the registry configuration
 	 */
-	public void setBuilderRegistry(DockerRegistry builderRegistry) {
+	void setBuilderRegistry(DockerRegistry builderRegistry) {
 		this.builderRegistry = builderRegistry;
 	}
 
+	/**
+	 * Configuration of the Docker registry where the generated image will be published.
+	 * @return the registry configuration
+	 */
 	DockerRegistry getPublishRegistry() {
 		return this.publishRegistry;
 	}
@@ -83,7 +104,7 @@ public class Docker {
 	 * registry.
 	 * @param builderRegistry the registry configuration
 	 */
-	public void setPublishRegistry(DockerRegistry builderRegistry) {
+	void setPublishRegistry(DockerRegistry builderRegistry) {
 		this.publishRegistry = builderRegistry;
 	}
 
@@ -167,43 +188,63 @@ public class Docker {
 			this.token = token;
 		}
 
-		String getUsername() {
+		/**
+		 * The username that will be used for user authentication to the registry.
+		 * @return the username
+		 */
+		public String getUsername() {
 			return this.username;
 		}
 
-		public void setUsername(String username) {
+		void setUsername(String username) {
 			this.username = username;
 		}
 
-		String getPassword() {
+		/**
+		 * The password that will be used for user authentication to the registry.
+		 * @return the password
+		 */
+		public String getPassword() {
 			return this.password;
 		}
 
-		public void setPassword(String password) {
+		void setPassword(String password) {
 			this.password = password;
 		}
 
-		String getEmail() {
+		/**
+		 * The email address that will be used for user authentication to the registry.
+		 * @return the email address
+		 */
+		public String getEmail() {
 			return this.email;
 		}
 
-		public void setEmail(String email) {
+		void setEmail(String email) {
 			this.email = email;
 		}
 
+		/**
+		 * The URL of the registry.
+		 * @return the registry URL
+		 */
 		String getUrl() {
 			return this.url;
 		}
 
-		public void setUrl(String url) {
+		void setUrl(String url) {
 			this.url = url;
 		}
 
-		String getToken() {
+		/**
+		 * The token that will be used for token authentication to the registry.
+		 * @return the authentication token
+		 */
+		public String getToken() {
 			return this.token;
 		}
 
-		public void setToken(String token) {
+		void setToken(String token) {
 			this.token = token;
 		}
 
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Image.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Image.java
index a869d114519..83ca2f0a946 100644
--- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Image.java
+++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Image.java
@@ -122,7 +122,7 @@ public class Image {
 		return this.pullPolicy;
 	}
 
-	public void setPullPolicy(PullPolicy pullPolicy) {
+	void setPullPolicy(PullPolicy pullPolicy) {
 		this.pullPolicy = pullPolicy;
 	}
 
@@ -134,7 +134,7 @@ public class Image {
 		return this.publish;
 	}
 
-	public void setPublish(Boolean publish) {
+	void setPublish(Boolean publish) {
 		this.publish = publish;
 	}