svn commit: r1669901 - in /maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc: AbstractFixJavadocMojo.java AbstractJavadocMojo.java

[kh...@apache.org]

Author: khmarbaise
Date: Sun Mar 29 12:37:43 2015
New Revision: 1669901

URL: http://svn.apache.org/r1669901
Log:
Fixing some 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

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=1669901&r1=1669900&r2=1669901&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 Sun Mar 29 12:37:43 2015
@@ -2652,7 +2652,7 @@ public abstract class AbstractFixJavadoc
      * @throws MojoExecutionException if any
      */
     private boolean isInherited( JavaMethod javaMethod )
-        throws MojoExecutionException, SecurityException
+        throws MojoExecutionException
     {
         if ( javaMethod.getAnnotations() != null )
         {

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=1669901&r1=1669900&r2=1669901&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 Sun Mar 29 12:37:43 2015
@@ -2156,6 +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
      * @see JavadocUtil#pruneDirs(MavenProject, List)
      */
     protected List<String> getSourcePaths()
@@ -2258,6 +2259,8 @@ 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
      */
     protected final List<String> getDependencySourcePaths()
         throws MavenReportException
@@ -5902,6 +5905,7 @@ public abstract class AbstractJavadocMoj
      * Construct the output file for the generated javadoc-options XML file, after creating the
      * javadocOptionsDir if necessary. This method does NOT write to the file in question.
      *
+     * @return The options {@link File} file.
      * @since 2.7
      */
     protected final File getJavadocOptionsFile()
@@ -5919,6 +5923,8 @@ public abstract class AbstractJavadocMoj
      * supplying to a distro module in a includeDependencySources configuration, so the javadoc options
      * from this execution can be reconstructed and merged in the distro build.
      *
+     * @return {@link JavadocOptions}
+     * @throws {@link IOException}
      * @since 2.7
      */
     protected final JavadocOptions buildJavadocOptions()
@@ -5963,6 +5969,7 @@ public abstract class AbstractJavadocMoj
     /**
      * Override this if you need to provide a bundle attachment classifier, as in the case of test
      * javadocs.
+     * @return The attachment classifier.
      */
     protected String getAttachmentClassifier()
     {
@@ -5972,8 +5979,8 @@ public abstract class AbstractJavadocMoj
     /**
      * Logs an error with throwable content only if in debug.
      *
-     * @param message
-     * @param t
+     * @param message The message which should be announced.
+     * @param t The throwable part of the message.
      */
     protected void logError( String message, Throwable t )
     {
@@ -5987,6 +5994,11 @@ public abstract class AbstractJavadocMoj
         }
     }
 
+    /**
+     * @param prefix The prefix of the exception.
+     * @param e The exception.
+     * @throws MojoExecutionException
+     */
     protected void failOnError( String prefix, Exception e )
         throws MojoExecutionException
     {