Fixing checkstyle reported things.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@1672206 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/maven/plugin/javadoc/resolver/ResourceResolver.java b/src/main/java/org/apache/maven/plugin/javadoc/resolver/ResourceResolver.java
index fd76acd..6cd7f7f 100644
--- a/src/main/java/org/apache/maven/plugin/javadoc/resolver/ResourceResolver.java
+++ b/src/main/java/org/apache/maven/plugin/javadoc/resolver/ResourceResolver.java
@@ -59,8 +59,14 @@
public final class ResourceResolver
{
+ /**
+ * The classifier for sources.
+ */
public static final String SOURCES_CLASSIFIER = "sources";
+ /**
+ * The classifier for test sources
+ */
public static final String TEST_SOURCES_CLASSIFIER = "test-sources";
private static final List<String> SOURCE_VALID_CLASSIFIERS = Arrays.asList( SOURCES_CLASSIFIER,
@@ -74,6 +80,11 @@
{
}
+ /**
+ * @param config {@link SourceResolverConfig}
+ * @return list of {@link JavadocBundle}.
+ * @throws IOException {@link IOException}
+ */
@SuppressWarnings( "unchecked" )
public static List<JavadocBundle> resolveDependencyJavadocBundles( final SourceResolverConfig config )
throws IOException
@@ -111,6 +122,12 @@
return bundles;
}
+ /**
+ * @param config {@link SourceResolverConfig}
+ * @return The list of resolved dependencies.
+ * @throws ArtifactResolutionException {@link ArtifactResolutionException}
+ * @throws ArtifactNotFoundException {@link ArtifactNotFoundException}
+ */
@SuppressWarnings( "unchecked" )
public static List<String> resolveDependencySourcePaths( final SourceResolverConfig config )
throws ArtifactResolutionException, ArtifactNotFoundException
diff --git a/src/main/java/org/apache/maven/plugin/javadoc/resolver/SourceResolverConfig.java b/src/main/java/org/apache/maven/plugin/javadoc/resolver/SourceResolverConfig.java
index 88b45b2..f1376d3 100644
--- a/src/main/java/org/apache/maven/plugin/javadoc/resolver/SourceResolverConfig.java
+++ b/src/main/java/org/apache/maven/plugin/javadoc/resolver/SourceResolverConfig.java
@@ -61,6 +61,16 @@
private final Log log;
+ /**
+ * @param log {@link Log}
+ * @param project {@link MavenProject}
+ * @param localRepository {@link ArtifactRepository}
+ * @param outputBasedir The output base directory.
+ * @param artifactResolver {@link ArtifactResolver}
+ * @param artifactFactory {@link ArtifactFactory}
+ * @param artifactMetadataSource {@link ArtifactMetadataSource}
+ * @param archiverManager {@link ArchiverManager}
+ */
public SourceResolverConfig( final Log log, final MavenProject project, final ArtifactRepository localRepository,
final File outputBasedir, final ArtifactResolver artifactResolver,
final ArtifactFactory artifactFactory,
@@ -77,97 +87,153 @@
this.archiverManager = archiverManager;
}
+ /**
+ * @param filter {@link ArtifactFilter}
+ * @return {@link SourceResolverConfig}
+ */
public SourceResolverConfig withFilter( final ArtifactFilter filter )
{
this.filter = filter;
return this;
}
+ /**
+ * @param reactorProjects The list of reactor projects.
+ * @return {@link SourceResolverConfig}
+ */
public SourceResolverConfig withReactorProjects( final List<MavenProject> reactorProjects )
{
this.reactorProjects = reactorProjects;
return this;
}
+ /**
+ * @return {@link SourceResolverConfig}
+ */
public SourceResolverConfig withCompileSources()
{
compileSourceIncluded = true;
return this;
}
+ /**
+ * @return {@link SourceResolverConfig}
+ */
public SourceResolverConfig withoutCompileSources()
{
compileSourceIncluded = false;
return this;
}
+ /**
+ * @return {@link SourceResolverConfig}
+ */
public SourceResolverConfig withTestSources()
{
testSourceIncluded = true;
return this;
}
+ /**
+ * @return {@link SourceResolverConfig}
+ */
public SourceResolverConfig withoutTestSources()
{
testSourceIncluded = false;
return this;
}
+ /**
+ * @return {@link MavenProject}
+ */
public MavenProject project()
{
return project;
}
+ /**
+ * @return {@link ArtifactRepository}
+ */
public ArtifactRepository localRepository()
{
return localRepository;
}
+ /**
+ * @return {@link ArtifactFilter}
+ */
public ArtifactFilter filter()
{
return filter;
}
+ /**
+ * @return list of {@link MavenProject}
+ */
public List<MavenProject> reactorProjects()
{
return reactorProjects;
}
+ /**
+ * @return {@link #outputBasedir}
+ */
public File outputBasedir()
{
return outputBasedir;
}
+ /**
+ * @return {@link #compileSourceIncluded}
+ */
public boolean includeCompileSources()
{
return compileSourceIncluded;
}
+ /**
+ * @return {@link #testSourceIncluded}
+ */
public boolean includeTestSources()
{
return testSourceIncluded;
}
+ /**
+ * @return {@link #artifactResolver}
+ */
public ArtifactResolver artifactResolver()
{
return artifactResolver;
}
+ /**
+ * @return {@link #artifactMetadataSource}
+ */
public ArtifactMetadataSource artifactMetadataSource()
{
return artifactMetadataSource;
}
+ /**
+ * @return {@link #archiverManager}
+ */
public ArchiverManager archiverManager()
{
return archiverManager;
}
+ /**
+ * @return {@link #artifactFactory}
+ */
public ArtifactFactory artifactFactory()
{
return artifactFactory;
}
+ /**
+ * @return {@link #log}
+ */
public Log log()
{
return log;
