[maven-jxr] branch master updated: Fix Javadoc

[rf...@apache.org]

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-jxr.git


The following commit(s) were added to refs/heads/master by this push:
     new 1eb6203  Fix Javadoc
1eb6203 is described below

commit 1eb62036cc525e395555520aa2fe9e54b36d40bc
Author: rfscholte <rf...@apache.org>
AuthorDate: Sat Sep 22 12:01:44 2018 +0200

    Fix Javadoc
---
 .../src/main/java/org/apache/maven/plugin/jxr/JxrReportUtil.java     | 5 ++---
 maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java                | 4 ++--
 maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java  | 4 ++--
 maven-jxr/src/main/java/org/apache/maven/jxr/pacman/BaseType.java    | 1 -
 4 files changed, 6 insertions(+), 8 deletions(-)

diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReportUtil.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReportUtil.java
index d9cc4ed..9da6835 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReportUtil.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReportUtil.java
@@ -261,9 +261,6 @@ public class JxrReportUtil
      * Generates the site structure using the project hierarchy (project and its modules) or using the
      * distributionManagement elements from the pom.xml.
      *
-     * @todo come from site plugin!
-     * @see org.apache.maven.plugins.site.SiteStageMojo#getStructure(MavenProject project, boolean ignoreMissingSiteUrl
-     *      )
      * @param project
      * @param ignoreMissingSiteUrl
      * @return the structure relative path
@@ -272,6 +269,8 @@ public class JxrReportUtil
     protected static String getStructure( MavenProject project, boolean ignoreMissingSiteUrl )
         throws IOException
     {
+        // @todo come from site plugin!
+        // @see o.a.m.p.site.SiteStageMojo#getStructure(MavenProject project, boolean ignoreMissingSiteUrl )
         if ( project.getDistributionManagement() == null )
         {
             String hierarchy = project.getName();
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java b/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
index 83d9dcc..c87fcb9 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
@@ -129,7 +129,7 @@ public class JXR
      * Check to see if the file is a Java source file.
      *
      * @param filename The name of the file to check
-     * @return <code>true</true> if the file is a Java file
+     * @return <code>true</code> if the file is a Java file
      */
     public static boolean isJavaFile( String filename )
     {
@@ -140,7 +140,7 @@ public class JXR
      * Check to see if the file is an HTML file.
      *
      * @param filename The name of the file to check
-     * @return <code>true</true> if the file is an HTML file
+     * @return <code>true</code> if the file is an HTML file
      */
     public static boolean isHtmlFile( String filename )
     {
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java b/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
index b236082..2140623 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
@@ -72,11 +72,11 @@ import java.util.Set;
  * <pre>
  *  htmlFilter
  *    |__
- *      ongoingMultiLineCommentFilter -> uriFilter
+ *      ongoingMultiLineCommentFilter -&gt; uriFilter
  *        |__
  *          inlineCommentFilter
  *            |__
- *              beginMultiLineCommentFilter -> ongoingMultiLineCommentFilter
+ *              beginMultiLineCommentFilter -&gt; ongoingMultiLineCommentFilter
  *                |__
  *                  stringFilter
  *                    |__
diff --git a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/BaseType.java b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/BaseType.java
index 8359755..e0485c9 100644
--- a/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/BaseType.java
+++ b/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/BaseType.java
@@ -23,7 +23,6 @@ package org.apache.maven.jxr.pacman;
  * put your documentation comment here
  *
  * @author jvanzyl
- * @created February 23, 2002
  */
 public abstract class BaseType
 {