You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2018/05/24 20:58:29 UTC
[maven-javadoc-plugin] branch master updated: Fix javadoc errors
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 41a8475 Fix javadoc errors
41a8475 is described below
commit 41a847513a05662e503022e3d002b4c078a498dd
Author: rfscholte <rf...@apache.org>
AuthorDate: Thu May 24 22:58:16 2018 +0200
Fix javadoc errors
---
.../plugins/javadoc/AbstractFixJavadocMojo.java | 2 +-
.../maven/plugins/javadoc/AbstractJavadocMojo.java | 28 ++++++++++------------
.../maven/plugins/javadoc/JavadocReport.java | 4 ++--
.../apache/maven/plugins/javadoc/JavadocUtil.java | 18 ++++++++------
.../javadoc/resolver/SourceResolverConfig.java | 6 ++---
.../maven/plugins/javadoc/FixJavadocMojoTest.java | 3 ---
6 files changed, 29 insertions(+), 32 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
index a1c856c..424f886 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
@@ -86,7 +86,7 @@ import java.util.regex.Pattern;
/**
* Abstract class to fix Javadoc documentation and tags in source files.
- * <br/>
+ * <br>
* See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#wheretags">Where Tags
* Can Be Used</a>.
*
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
index 487bb0f..e19b68f 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
@@ -519,7 +519,7 @@ public abstract class AbstractJavadocMojo
* Specifies to use the
* <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#standard">
* options provided by the Standard Doclet</a> for a custom doclet.
- * <br/>
+ * <br>
* Example:
* <pre>
* <docletArtifacts>
@@ -1128,7 +1128,7 @@ public abstract class AbstractJavadocMojo
/**
* Creates links to existing javadoc-generated documentation of external referenced classes.
- * <br/>
+ * <br>
* <b>Notes</b>:
* <ol>
* <li>only used if {@link #isOffline} is set to <code>false</code>.</li>
@@ -1288,9 +1288,8 @@ public abstract class AbstractJavadocMojo
/**
* Omits the class/interface hierarchy pages from the generated docs.
- * <br/>
- * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#notree">notree</a>.
- * <br/>
+ * <br>
+ * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#notree">notree</a> option
*/
@Parameter( property = "notree", defaultValue = "false" )
private boolean notree;
@@ -1314,18 +1313,16 @@ public abstract class AbstractJavadocMojo
* <br/>
* <b>Note</b>: if {@link #detectOfflineLinks} is defined, the offline links between the project modules are
* automatically added if the goal is calling in a non-aggregator way.
- * <br/>
- * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/OfflineLink.html">Javadoc</a>.
- * <br/>
+ * <br>
+ * @see <a href="./apidocs/org/apache/maven/plugin/javadoc/options/OfflineLink.html">Javadoc</a>.
*/
@Parameter( property = "offlineLinks" )
private OfflineLink[] offlineLinks;
/**
* Specifies the destination directory where javadoc saves the generated HTML files.
- * <br/>
- * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#d">d</a>.
- * <br/>
+ * <br>
+ * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#d">d</a> option
*/
@Parameter( property = "destDir", alias = "destDir", defaultValue = "${project.build.directory}/apidocs",
required = true )
@@ -1346,8 +1343,7 @@ public abstract class AbstractJavadocMojo
/**
* Generates compile-time warnings for missing serial tags.
* <br/>
- * See <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#serialwarn">serialwarn</a>
- * <br/>
+ * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#serialwarn">serialwarn</a> option
*/
@Parameter( property = "serialwarn", defaultValue = "false" )
private boolean serialwarn;
@@ -2230,7 +2226,7 @@ public abstract class AbstractJavadocMojo
*
* @return a Collection of the project absolute source paths as <code>String</code>
* @throws MavenReportException {@link MavenReportException}
- * @see JavadocUtil#pruneDirs(MavenProject, List)
+ * @see JavadocUtil#pruneDirs(MavenProject, Collection)
*/
protected Map<String, Collection<String>> getSourcePaths()
throws MavenReportException
@@ -2332,7 +2328,7 @@ public abstract class AbstractJavadocMojo
/**
* 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}
+ * @param config {@link SourceResolverConfig}
* @return {@link SourceResolverConfig}
*/
protected SourceResolverConfig configureDependencySourceResolution( final SourceResolverConfig config )
@@ -2692,7 +2688,7 @@ public abstract class AbstractJavadocMojo
/**
* @param dependency {@link Dependency}
* @return {@link Artifact}
- * @throws MavenReportException
+ * @throws MavenReportException when artifact could not be resolved
*/
public Artifact resolveDependency( Dependency dependency )
throws MavenReportException
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
index f431114..dab71d8 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
@@ -168,9 +168,9 @@ public class JavadocReport
/**
* {@inheritDoc}
*
- * <br/>
+ * <br>
* The logic is the following:
- * <table>
+ * <table summary="Can-generate-report Matrix">
* <tbody>
* <tr>
* <th> isAggregator </th>
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
index 82cc0ed..a740c6e 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
@@ -212,7 +212,7 @@ public class JavadocUtil
/**
* Convenience method to wrap an argument value in single quotes (i.e. <code>'</code>). Intended for values which
- * may contain whitespaces. <br/>
+ * may contain whitespaces. <br>
* To prevent javadoc error, the line separator (i.e. <code>\n</code>) are skipped.
*
* @param value the argument value.
@@ -548,9 +548,9 @@ public class JavadocUtil
}
/**
- * Parse the output for 'javadoc -J-version' and return the javadoc version recognized. <br/>
+ * Parse the output for 'javadoc -J-version' and return the javadoc version recognized. <br>
* Here are some output for 'javadoc -J-version' depending the JDK used:
- * <table>
+ * <table summary="Output for 'javadoc -J-version' per JDK">
* <tr>
* <th>JDK</th>
* <th>Output for 'javadoc -J-version'</th>
@@ -608,9 +608,9 @@ public class JavadocUtil
}
/**
- * Parse a memory string which be used in the JVM arguments <code>-Xms</code> or <code>-Xmx</code>. <br/>
+ * Parse a memory string which be used in the JVM arguments <code>-Xms</code> or <code>-Xmx</code>. <br>
* Here are some supported memory string depending the JDK used:
- * <table>
+ * <table summary="Memory argument support per JDK">
* <tr>
* <th>JDK</th>
* <th>Memory argument support for <code>-Xms</code> or <code>-Xmx</code></th>
@@ -751,7 +751,7 @@ public class JavadocUtil
/**
* Auto-detect the class names of the implementation of <code>com.sun.tools.doclets.Taglet</code> class from a given
- * jar file. <br/>
+ * jar file. <br>
* <b>Note</b>: <code>JAVA_HOME/lib/tools.jar</code> is a requirement to find
* <code>com.sun.tools.doclets.Taglet</code> class.
*
@@ -859,7 +859,7 @@ public class JavadocUtil
/**
* Invoke Maven for the given project file with a list of goals and properties, the output will be in the invokerlog
- * file. <br/>
+ * file. <br>
* <b>Note</b>: the Maven Home should be defined in the <code>maven.home</code> Java system property or defined in
* <code>M2_HOME</code> system env variables.
*
@@ -1604,6 +1604,8 @@ public class JavadocUtil
/**
* Convenience method to determine that a collection is not empty or null.
+ * @param collection the collection to verify
+ * @return {@code true} if not {@code null} and not empty, otherwise {@code false}
*/
public static boolean isNotEmpty( final Collection<?> collection )
{
@@ -1612,6 +1614,8 @@ public class JavadocUtil
/**
* Convenience method to determine that a collection is empty or null.
+ * @param collection the collection to verify
+ * @return {@code true} if {@code null} or empty, otherwise {@code false}
*/
public static boolean isEmpty( final Collection<?> collection )
{
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java b/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java
index 1b6e28e..1dd2af4 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java
@@ -47,7 +47,7 @@ public class SourceResolverConfig
/**
* @param project {@link MavenProject}
- * @param buoildingRequest {@link ProjectBuildingRequest}
+ * @param buildingRequest {@link ProjectBuildingRequest}
* @param outputBasedir The output base directory.
*/
public SourceResolverConfig( final MavenProject project, final ProjectBuildingRequest buildingRequest,
@@ -59,7 +59,7 @@ public class SourceResolverConfig
}
/**
- * @param filter {@link ArtifactFilter}
+ * @param filter {@link AndFilter}
* @return {@link SourceResolverConfig}
*/
public SourceResolverConfig withFilter( final AndFilter filter )
@@ -131,7 +131,7 @@ public class SourceResolverConfig
}
/**
- * @return {@link TransformableFilter}
+ * @return {@link AndFilter}
*/
public AndFilter filter()
{
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/FixJavadocMojoTest.java b/src/test/java/org/apache/maven/plugins/javadoc/FixJavadocMojoTest.java
index 94a8142..a7644a7 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/FixJavadocMojoTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/FixJavadocMojoTest.java
@@ -464,9 +464,6 @@ public class FixJavadocMojoTest
assertTrue( withoutEmptyJavadocLines.endsWith( "any" ) );
}
- /**
- * @throws Throwable if any
- */
public void testJavadocCommentJdk5()
throws Exception
{
--
To stop receiving notification emails like this one, please contact
rfscholte@apache.org.