Author: khmarbaise Date: Wed Apr 8 22:10:02 2015 New Revision: 1672205 URL: http://svn.apache.org/r1672205 Log: Fixing checkstyle reported things.
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/JavadocBundle.java Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractFixJavadocMojo.java Wed Apr 8 22:10:02 2015 @@ -200,8 +200,14 @@ public abstract class AbstractFixJavadoc */ private static final String CLIRR_MAVEN_PLUGIN_GOAL = "check"; + /** + * Java Files Pattern. + */ public static final String JAVA_FILES = "**\\/*.java"; + /** + * Default version value. + */ public static final String DEFAULT_VERSION_VALUE = "\u0024Id: \u0024Id"; // ---------------------------------------------------------------------- Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java Wed Apr 8 22:10:02 2015 @@ -19,6 +19,40 @@ package org.apache.maven.plugin.javadoc; * under the License. */ +import static org.apache.maven.plugin.javadoc.JavadocUtil.isEmpty; +import static org.apache.maven.plugin.javadoc.JavadocUtil.isNotEmpty; +import static org.apache.maven.plugin.javadoc.JavadocUtil.toList; +import static org.apache.maven.plugin.javadoc.JavadocUtil.toRelative; +import static org.codehaus.plexus.util.IOUtil.close; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.Writer; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Calendar; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Properties; +import java.util.Set; +import java.util.StringTokenizer; + import org.apache.commons.lang.ClassUtils; import org.apache.commons.lang.SystemUtils; import org.apache.maven.artifact.Artifact; @@ -87,40 +121,6 @@ import org.codehaus.plexus.util.cli.Comm import org.codehaus.plexus.util.cli.Commandline; import org.codehaus.plexus.util.xml.Xpp3Dom; -import java.io.File; -import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.io.Writer; -import java.net.MalformedURLException; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.net.URLClassLoader; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Calendar; -import java.util.Collection; -import java.util.Collections; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashSet; -import java.util.LinkedList; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.Properties; -import java.util.Set; -import java.util.StringTokenizer; - -import static org.apache.maven.plugin.javadoc.JavadocUtil.isEmpty; -import static org.apache.maven.plugin.javadoc.JavadocUtil.isNotEmpty; -import static org.apache.maven.plugin.javadoc.JavadocUtil.toList; -import static org.apache.maven.plugin.javadoc.JavadocUtil.toRelative; -import static org.codehaus.plexus.util.IOUtil.close; - /** * Base class with majority of Javadoc functionalities. * @@ -2130,7 +2130,7 @@ public abstract class AbstractJavadocMoj * * @param sourcePaths a List that contains the paths to the source files * @return a List that contains the specific path for every source file - * @throws MavenReportException + * @throws MavenReportException {@link MavenReportException} */ protected List<String> getFiles( List<String> sourcePaths ) throws MavenReportException @@ -2156,7 +2156,7 @@ public abstract class AbstractJavadocMoj * of the project will be used. * * @return a List of the project absolute source paths as <code>String</code> - * @throws MavenReportException + * @throws MavenReportException {@link MavenReportException} * @see JavadocUtil#pruneDirs(MavenProject, List) */ protected List<String> getSourcePaths() @@ -2250,6 +2250,8 @@ public abstract class AbstractJavadocMoj /** * Override this method to customize the configuration for resolving dependency sources. The default * behavior enables the resolution of -sources jar files. + * @param config {@linke SourceResolverConfig} + * @return {@link SourceResolverConfig} */ protected SourceResolverConfig configureDependencySourceResolution( final SourceResolverConfig config ) { @@ -2260,7 +2262,7 @@ public abstract class AbstractJavadocMoj * Resolve dependency sources so they can be included directly in the javadoc process. To customize this, * override {@link AbstractJavadocMojo#configureDependencySourceResolution(SourceResolverConfig)}. * @return List of source paths. - * @throws MavenReportException + * @throws MavenReportException {@link MavenReportException} */ protected final List<String> getDependencySourcePaths() throws MavenReportException @@ -2613,6 +2615,11 @@ public abstract class AbstractJavadocMoj return StringUtils.join( classpathElements.iterator(), File.pathSeparator ); } + /** + * @param dependency {@link Dependency} + * @return {@link Artifact} + * @throws MavenReportException + */ public Artifact resolveDependency( Dependency dependency ) throws MavenReportException { @@ -5924,7 +5931,7 @@ public abstract class AbstractJavadocMoj * from this execution can be reconstructed and merged in the distro build. * * @return {@link JavadocOptions} - * @throws {@link IOException} + * @throws IOException {@link IOException} * @since 2.7 */ protected final JavadocOptions buildJavadocOptions() @@ -5997,7 +6004,7 @@ public abstract class AbstractJavadocMoj /** * @param prefix The prefix of the exception. * @param e The exception. - * @throws MojoExecutionException + * @throws MojoExecutionException {@link MojoExecutionException} */ protected void failOnError( String prefix, Exception e ) throws MojoExecutionException Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java Wed Apr 8 22:10:02 2015 @@ -250,8 +250,8 @@ public class JavadocJar * @param javadocFiles the directory where the generated jar file will be put * @param jarFileName the filename of the generated jar file * @return a File object that contains the generated jar file - * @throws ArchiverException if any - * @throws IOException if any + * @throws ArchiverException {@link ArchiverException} + * @throws IOException {@link IOException} */ private File generateArchive( File javadocFiles, String jarFileName ) throws ArchiverException, IOException Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Wed Apr 8 22:10:02 2015 @@ -278,10 +278,13 @@ public class JavadocReport updateReportOutputDirectory( reportOutputDirectory, destDir ); } - public void setDestDir( String destDir ) + /** + * @param theDestDir The destiation directory. + */ + public void setDestDir( String theDestDir ) { - this.destDir = destDir; - updateReportOutputDirectory( reportOutputDirectory, destDir ); + this.destDir = theDestDir; + updateReportOutputDirectory( reportOutputDirectory, theDestDir ); } private void updateReportOutputDirectory( File reportOutputDirectory, String destDir ) Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocUtil.java Wed Apr 8 22:10:02 2015 @@ -166,6 +166,9 @@ public class JavadocUtil /** * Determine whether a file should be excluded from the provided list of paths, based on whether * it exists and is already present in the list. + * @param f The files. + * @param pruned The list of pruned files.. + * @return true if the file could be pruned false otherwise. */ public static boolean shouldPruneFile( String f, List<String> pruned ) { @@ -525,6 +528,8 @@ public class JavadocUtil * @param sourceDirectory the directory where the source files are located * @param files the variable that contains the appended filenames of the files to be included in the javadoc * @param excludePackages the packages to be excluded in the javadocs + * @param sourceFileIncludes files to include. + * @param sourceFileExcludes files to exclude. */ protected static void addFilesFromSource( List<String> files, File sourceDirectory, List<String> sourceFileIncludes, Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java Wed Apr 8 22:10:02 2015 @@ -49,8 +49,14 @@ public class ResourcesBundleMojo extends AbstractJavadocMojo { + /** + * Bundle options path. + */ public static final String BUNDLE_OPTIONS_PATH = "META-INF/maven/javadoc-options.xml"; + /** + * Resources directory path. + */ public static final String RESOURCES_DIR_PATH = "resources"; /** Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/JavadocBundle.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/JavadocBundle.java?rev=1672205&r1=1672204&r2=1672205&view=diff ============================================================================== --- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/JavadocBundle.java (original) +++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/resolver/JavadocBundle.java Wed Apr 8 22:10:02 2015 @@ -33,17 +33,27 @@ public class JavadocBundle private final JavadocOptions options; + /** + * @param options {@link JavadocOptions} + * @param resourcesDirectory The resources directory. + */ public JavadocBundle( final JavadocOptions options, final File resourcesDirectory ) { this.options = options; this.resourcesDirectory = resourcesDirectory; } + /** + * @return {@link #resourcesDirectory} + */ public File getResourcesDirectory() { return resourcesDirectory; } + /** + * @return {@link #options} + */ public JavadocOptions getOptions() { return options;