Skip to content

Commit 38b1954

Browse files
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
1 parent 0f069ee commit 38b1954

File tree

2 files changed

+57
-16
lines changed
  • spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven

2 files changed

+57
-16
lines changed

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Docker.java

+55-14
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,47 @@ public class Docker {
3737

3838
private DockerRegistry publishRegistry;
3939

40+
/**
41+
* The host address of the Docker daemon.
42+
* @return the Docker host
43+
*/
4044
public String getHost() {
4145
return this.host;
4246
}
4347

44-
public void setHost(String host) {
48+
void setHost(String host) {
4549
this.host = host;
4650
}
4751

52+
/**
53+
* Whether the Docker daemon requires TLS communication.
54+
* @return {@code true} to enable TLS
55+
*/
4856
public boolean isTlsVerify() {
4957
return this.tlsVerify;
5058
}
5159

52-
public void setTlsVerify(boolean tlsVerify) {
60+
void setTlsVerify(boolean tlsVerify) {
5361
this.tlsVerify = tlsVerify;
5462
}
5563

64+
/**
65+
* The path to TLS certificate and key files required for TLS communication with the
66+
* Docker daemon.
67+
* @return the TLS certificate path
68+
*/
5669
public String getCertPath() {
5770
return this.certPath;
5871
}
5972

60-
public void setCertPath(String certPath) {
73+
void setCertPath(String certPath) {
6174
this.certPath = certPath;
6275
}
6376

77+
/**
78+
* Configuration of the Docker registry where builder and run images are stored.
79+
* @return the registry configuration
80+
*/
6481
DockerRegistry getBuilderRegistry() {
6582
return this.builderRegistry;
6683
}
@@ -70,10 +87,14 @@ DockerRegistry getBuilderRegistry() {
7087
* registry.
7188
* @param builderRegistry the registry configuration
7289
*/
73-
public void setBuilderRegistry(DockerRegistry builderRegistry) {
90+
void setBuilderRegistry(DockerRegistry builderRegistry) {
7491
this.builderRegistry = builderRegistry;
7592
}
7693

94+
/**
95+
* Configuration of the Docker registry where the generated image will be published.
96+
* @return the registry configuration
97+
*/
7798
DockerRegistry getPublishRegistry() {
7899
return this.publishRegistry;
79100
}
@@ -83,7 +104,7 @@ DockerRegistry getPublishRegistry() {
83104
* registry.
84105
* @param builderRegistry the registry configuration
85106
*/
86-
public void setPublishRegistry(DockerRegistry builderRegistry) {
107+
void setPublishRegistry(DockerRegistry builderRegistry) {
87108
this.publishRegistry = builderRegistry;
88109
}
89110

@@ -167,43 +188,63 @@ public DockerRegistry(String token) {
167188
this.token = token;
168189
}
169190

170-
String getUsername() {
191+
/**
192+
* The username that will be used for user authentication to the registry.
193+
* @return the username
194+
*/
195+
public String getUsername() {
171196
return this.username;
172197
}
173198

174-
public void setUsername(String username) {
199+
void setUsername(String username) {
175200
this.username = username;
176201
}
177202

178-
String getPassword() {
203+
/**
204+
* The password that will be used for user authentication to the registry.
205+
* @return the password
206+
*/
207+
public String getPassword() {
179208
return this.password;
180209
}
181210

182-
public void setPassword(String password) {
211+
void setPassword(String password) {
183212
this.password = password;
184213
}
185214

186-
String getEmail() {
215+
/**
216+
* The email address that will be used for user authentication to the registry.
217+
* @return the email address
218+
*/
219+
public String getEmail() {
187220
return this.email;
188221
}
189222

190-
public void setEmail(String email) {
223+
void setEmail(String email) {
191224
this.email = email;
192225
}
193226

227+
/**
228+
* The URL of the registry.
229+
* @return the registry URL
230+
*/
194231
String getUrl() {
195232
return this.url;
196233
}
197234

198-
public void setUrl(String url) {
235+
void setUrl(String url) {
199236
this.url = url;
200237
}
201238

202-
String getToken() {
239+
/**
240+
* The token that will be used for token authentication to the registry.
241+
* @return the authentication token
242+
*/
243+
public String getToken() {
203244
return this.token;
204245
}
205246

206-
public void setToken(String token) {
247+
void setToken(String token) {
207248
this.token = token;
208249
}
209250

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/Image.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ public PullPolicy getPullPolicy() {
122122
return this.pullPolicy;
123123
}
124124

125-
public void setPullPolicy(PullPolicy pullPolicy) {
125+
void setPullPolicy(PullPolicy pullPolicy) {
126126
this.pullPolicy = pullPolicy;
127127
}
128128

@@ -134,7 +134,7 @@ public Boolean getPublish() {
134134
return this.publish;
135135
}
136136

137-
public void setPublish(Boolean publish) {
137+
void setPublish(Boolean publish) {
138138
this.publish = publish;
139139
}
140140

0 commit comments

Comments
 (0)