Skip to content

Commit f99b598

Browse files
elharoelharo
authored
Follow Oracle javadoc guidelines (apache#1519)
1 parent cf4ffcc commit f99b598

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+322
-325
lines changed

‎src/main/java/org/apache/maven/plugins/dependency/AbstractDependencyMojo.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ public abstract class AbstractDependencyMojo extends AbstractMojo {
5757
protected List<MavenProject> reactorProjects;
5858

5959
/**
60-
* The Maven session
60+
* The Maven session.
6161
*/
6262
protected final MavenSession session;
6363

6464
/**
6565
* If the plugin should be silent.
6666
*
67-
* @deprecated to be removed in 4.0; use -q command line option instead
6867
* @since 2.0
68+
* @deprecated to be removed in 4.0; use -q command line option instead
6969
*/
7070
@Deprecated
7171
@Parameter(property = "silent", defaultValue = "false")
@@ -82,19 +82,19 @@ public abstract class AbstractDependencyMojo extends AbstractMojo {
8282
/**
8383
* Skip plugin execution only during incremental builds (e.g. triggered from M2E).
8484
*
85-
* @since 3.4.0
8685
* @see #skip
86+
* @since 3.4.0
8787
*/
8888
@Parameter(defaultValue = "false")
8989
private boolean skipDuringIncrementalBuild;
9090

9191
/**
92-
* For IDE build support
92+
* For IDE build support.
9393
*/
9494
private final BuildContext buildContext;
9595

9696
/**
97-
* POM
97+
* POM.
9898
*/
9999
private final MavenProject project;
100100

@@ -126,16 +126,16 @@ public final void execute() throws MojoExecutionException, MojoFailureException
126126
protected abstract void doExecute() throws MojoExecutionException, MojoFailureException;
127127

128128
/**
129-
* @return Returns a new ProjectBuildingRequest populated from the current session and the current project remote
130-
* repositories, used to resolve artifacts.
129+
* @return returns a new ProjectBuildingRequest populated from the current session and the current project remote
130+
* repositories, used to resolve artifacts
131131
*/
132132
public ProjectBuildingRequest newResolveArtifactProjectBuildingRequest() {
133133
return newProjectBuildingRequest(remoteRepositories);
134134
}
135135

136136
/**
137-
* @return Returns a new ProjectBuildingRequest populated from the current session and the current project remote
138-
* repositories, used to resolve plugins.
137+
* @return returns a new ProjectBuildingRequest populated from the current session and the current project remote
138+
* repositories, used to resolve plugins
139139
*/
140140
protected ProjectBuildingRequest newResolvePluginProjectBuildingRequest() {
141141
return newProjectBuildingRequest(remotePluginRepositories);
@@ -150,7 +150,7 @@ private ProjectBuildingRequest newProjectBuildingRequest(List<ArtifactRepository
150150
}
151151

152152
/**
153-
* @return Returns the project.
153+
* @return returns the project
154154
*/
155155
public MavenProject getProject() {
156156
return this.project;

‎src/main/java/org/apache/maven/plugins/dependency/GetMojo.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public class GetMojo extends AbstractMojo {
8181

8282
/**
8383
* Repositories in the format id::[layout]::url or just url, separated by comma. ie.
84-
* central::default::https://repo.maven.apache.org/maven2,myrepo::::https://repo.acme.com,https://repo.acme2.com
84+
* central::default::https://repo.maven.apache.org/maven2,myrepo::::https://repo.acme.com,https://repo.acme2.com.
8585
*/
8686
@Parameter(property = "remoteRepositories")
8787
private String remoteRepositories;
@@ -249,7 +249,7 @@ protected boolean isSkip() {
249249
/**
250250
* The groupId of the artifact to resolve. Ignored if {@link #artifact} is used.
251251
*
252-
* @param groupId The groupId.
252+
* @param groupId the groupId
253253
*/
254254
@Parameter(property = "groupId")
255255
public void setGroupId(String groupId) {
@@ -259,7 +259,7 @@ public void setGroupId(String groupId) {
259259
/**
260260
* The artifactId of the artifact to resolve. Ignored if {@link #artifact} is used.
261261
*
262-
* @param artifactId The artifactId.
262+
* @param artifactId the artifactId
263263
*/
264264
@Parameter(property = "artifactId")
265265
public void setArtifactId(String artifactId) {
@@ -269,7 +269,7 @@ public void setArtifactId(String artifactId) {
269269
/**
270270
* The version of the artifact to resolve. Ignored if {@link #artifact} is used.
271271
*
272-
* @param version The version.
272+
* @param version the version
273273
*/
274274
@Parameter(property = "version")
275275
public void setVersion(String version) {
@@ -279,8 +279,7 @@ public void setVersion(String version) {
279279
/**
280280
* The classifier of the artifact to resolve. Ignored if {@link #artifact} is used.
281281
*
282-
* @param classifier The classifier to be used.
283-
*
282+
* @param classifier the classifier to be used
284283
* @since 2.3
285284
*/
286285
@Parameter(property = "classifier")
@@ -291,7 +290,7 @@ public void setClassifier(String classifier) {
291290
/**
292291
* The packaging of the artifact to resolve. Ignored if {@link #artifact} is used.
293292
*
294-
* @param type packaging.
293+
* @param type packaging
295294
*/
296295
@Parameter(property = "packaging", defaultValue = "jar")
297296
public void setPackaging(String type) {

‎src/main/java/org/apache/maven/plugins/dependency/PropertiesMojo.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
public class PropertiesMojo extends AbstractMojo {
5050

5151
/**
52-
* The current Maven project
52+
* The current Maven project.
5353
*/
5454
private final MavenProject project;
5555

@@ -69,7 +69,7 @@ public PropertiesMojo(MavenProject project) {
6969
/**
7070
* Main entry into mojo. Gets the list of dependencies and iterates through setting a property for each artifact.
7171
*
72-
* @throws MojoExecutionException with a message if an error occurs.
72+
* @throws MojoExecutionException with a message if an error occurs
7373
*/
7474
@Override
7575
public void execute() throws MojoExecutionException {

‎src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public class PurgeLocalRepositoryMojo extends AbstractMojo {
9393
private final ArtifactHandlerManager artifactHandlerManager;
9494

9595
/**
96-
* The dependency resolver
96+
* The dependency resolver.
9797
*/
9898
private final DependencyResolver dependencyResolver;
9999

@@ -243,9 +243,9 @@ private class DirectDependencyFilter extends AbstractFilter {
243243
private final List<Dependency> directDependencies;
244244

245245
/**
246-
* Default constructor
246+
* Default constructor.
247247
*
248-
* @param directDependencies Set of dependencies objects which represent the direct dependencies of the project
248+
* @param directDependencies set of dependencies objects which represent the direct dependencies of the project
249249
*/
250250
DirectDependencyFilter(Artifact projectArtifact, List<Dependency> directDependencies) {
251251
this.projectArtifact = projectArtifact;
@@ -287,7 +287,7 @@ private boolean artifactsGAMatch(Node node, String groupId, String artifactId) {
287287
}
288288

289289
/**
290-
* Includes only snapshot artifacts
290+
* Includes only snapshot artifacts.
291291
*/
292292
private static class SnapshotsFilter extends AbstractFilter {
293293
@Override
@@ -330,7 +330,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
330330
* Determines if all projects in the reactor should be purged from their dependencies. When this goal is started on
331331
* the command-line, it is always the case. When it is bound to a phase in the lifecycle, it is never the case.
332332
*
333-
* @return <code>true</code> if all projects in the reactor should be purged, <code>false</code> otherwise.
333+
* @return <code>true</code> if all projects in the reactor should be purged, <code>false</code> otherwise
334334
*/
335335
private boolean shouldPurgeAllProjectsInReactor() {
336336
Source source = mojoExecution.getSource();
@@ -340,9 +340,9 @@ private boolean shouldPurgeAllProjectsInReactor() {
340340
/**
341341
* Purges the local repository for the dependencies in the given Maven project.
342342
*
343-
* @param theProject Maven project.
344-
* @param purgedArtifacts The artifacts that were already purged.
345-
* @throws MojoFailureException in case of errors during the purge.
343+
* @param theProject maven project
344+
* @param purgedArtifacts the artifacts that were already purged
345+
* @throws MojoFailureException in case of errors during the purge
346346
*/
347347
private void purgeLocalRepository(MavenProject theProject, Set<Artifact> purgedArtifacts)
348348
throws MojoFailureException {
@@ -375,8 +375,8 @@ private void purgeLocalRepository(MavenProject theProject, Set<Artifact> purgedA
375375
/**
376376
* Purge/Delete artifacts from the local repository according to the given patterns.
377377
*
378-
* @param theIncludes The includes.
379-
* @throws MojoExecutionException in case of an error.
378+
* @param theIncludes the includes
379+
* @throws MojoExecutionException in case of an error
380380
*/
381381
private void manualPurge(List<String> theIncludes) throws MojoExecutionException {
382382
MessageBuilder messageBuilder = MessageUtils.buffer();
@@ -417,7 +417,7 @@ private void manualPurge(List<String> theIncludes) throws MojoExecutionException
417417
}
418418

419419
/**
420-
* Convert a groupId:artifactId:version to a file system path
420+
* Convert a groupId:artifactId:version to a file system path.
421421
*
422422
* @param gav the groupId:artifactId:version string
423423
* @return the corresponding path
@@ -440,11 +440,11 @@ private String gavToPath(String gav) {
440440

441441
/**
442442
* Create the includes exclude filter to use when resolving and purging dependencies Also excludes any "system"
443-
* scope dependencies
443+
* scope dependencies.
444444
*
445-
* @param theProject The Maven project.
446-
* @param dependencies The dependencies to use as a reference if we're excluding transitive dependencies
447-
* @param purgedArtifacts The artifacts already purged.
445+
* @param theProject the Maven project
446+
* @param dependencies the dependencies to use as a reference if we're excluding transitive dependencies
447+
* @param purgedArtifacts the artifacts already purged
448448
* @return the created filter
449449
*/
450450
private TransformableFilter createPurgeArtifactsFilter(
@@ -494,18 +494,18 @@ private TransformableFilter createPurgeArtifactsFilter(
494494
/**
495495
* Returns a string that represents a pattern for an exclude filter for the given artifact.
496496
*
497-
* @param artifact Artifact.
498-
* @return String representation of a pattern for an exclude filter for the given artifact.
497+
* @param artifact artifact
498+
* @return string representation of a pattern for an exclude filter for the given artifact
499499
*/
500500
private String toPatternExcludes(Artifact artifact) {
501501
return artifact.getGroupId() + ":" + artifact.getArtifactId() + ":"
502502
+ artifact.getArtifactHandler().getExtension() + ":" + artifact.getVersion();
503503
}
504504

505505
/**
506-
* Convert comma separated list of includes to List object
506+
* Convert comma separated list of includes to List object.
507507
*
508-
* @param theInclude The list of includes
508+
* @param theInclude the list of includes
509509
* @return the includes list
510510
*/
511511
private List<String> parseIncludes(String theInclude) {

‎src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
129129
private String scriptableFlag;
130130

131131
/**
132-
* Flag to use for scriptable output
132+
* Flag to use for scriptable output.
133133
*
134134
* @since 2.0-alpha-5
135135
*/
136136
@Parameter(defaultValue = "${basedir}", readonly = true)
137137
private File baseDir;
138138

139139
/**
140-
* Target folder
140+
* Target folder.
141141
*
142142
* @since 2.0-alpha-5
143143
*/
@@ -309,7 +309,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
309309

310310
/**
311311
* @return {@link ProjectDependencyAnalyzer}
312-
* @throws MojoExecutionException in case of an error.
312+
* @throws MojoExecutionException in case of an error
313313
*/
314314
protected ProjectDependencyAnalyzer createProjectDependencyAnalyzer() throws MojoExecutionException {
315315

‎src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeDepMgt.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,15 +203,15 @@ public String getExclusionKey(Artifact artifact) {
203203
}
204204

205205
/**
206-
* @param ex The exclusion key.
206+
* @param ex the exclusion key
207207
* @return the resulting combination of groupId+artifactId
208208
*/
209209
public String getExclusionKey(Exclusion ex) {
210210
return ex.getGroupId() + ":" + ex.getArtifactId();
211211
}
212212

213213
/**
214-
* Calculate the mismatches between the DependencyManagement and resolved artifacts
214+
* Calculate the mismatches between the DependencyManagement and resolved artifacts.
215215
*
216216
* @param depMgtMap a keyset of the Dependency.GetManagementKey for quick lookup
217217
* @param allDependencyArtifacts the set of all artifacts to compare

‎src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReport.java‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ public class AnalyzeReport extends AbstractMavenReport {
5252
private final ProjectDependencyAnalyzer analyzer;
5353

5454
/**
55-
* Internationalization component
55+
* Internationalization component.
5656
*/
5757
private final I18N i18n;
5858

5959
/**
60-
* Ignore Runtime/Provided/Test/System scopes for unused dependency analysis
60+
* Ignore Runtime/Provided/Test/System scopes for unused dependency analysis.
6161
*
6262
* @since 2.2
6363
*/
@@ -140,19 +140,25 @@ public boolean canGenerateReport() {
140140
return true;
141141
}
142142

143-
/** {@inheritDoc} */
143+
/**
144+
* {@inheritDoc}
145+
*/
144146
@Override
145147
public String getOutputName() {
146148
return "dependency-analysis";
147149
}
148150

149-
/** {@inheritDoc} */
151+
/**
152+
* {@inheritDoc}
153+
*/
150154
@Override
151155
public String getName(Locale locale) {
152156
return getI18nString(locale, "name");
153157
}
154158

155-
/** {@inheritDoc} */
159+
/**
160+
* {@inheritDoc}
161+
*/
156162
@Override
157163
public String getDescription(Locale locale) {
158164
return getI18nString(locale, "description");
@@ -161,9 +167,9 @@ public String getDescription(Locale locale) {
161167
// protected methods ------------------------------------------------------
162168

163169
/**
164-
* @param locale The locale
165-
* @param key The key to search for
166-
* @return The text appropriate for the locale.
170+
* @param locale the locale
171+
* @param key the key to search for
172+
* @return the text appropriate for the locale
167173
*/
168174
protected String getI18nString(Locale locale, String key) {
169175
return i18n.getString("analyze-report", locale, "report.analyze." + key);

‎src/main/java/org/apache/maven/plugins/dependency/analyze/AnalyzeReportRenderer.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ public String getTitle() {
5151
}
5252

5353
/**
54-
* @param key The key.
55-
* @return The translated string.
54+
* @param key the key
55+
* @return the translated string
5656
*/
5757
private String getI18nString(String key) {
5858
return i18n.getString("analyze-report", locale, "report.analyze." + key);

0 commit comments

Comments
 (0)