You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2023/07/08 12:24:39 UTC

[maven-javadoc-plugin] branch MJAVADOC-757 created (now d33677e0)

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a change to branch MJAVADOC-757
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git


      at d33677e0 [MJAVADOC-757] fix Javadoc warnings

This branch includes the following new commits:

     new d33677e0 [MJAVADOC-757] fix Javadoc warnings

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[maven-javadoc-plugin] 01/01: [MJAVADOC-757] fix Javadoc warnings

Posted by el...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch MJAVADOC-757
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git

commit d33677e090615c3c0fb602393a0ce1188932fbac
Author: Elliotte Rusty Harold <el...@users.noreply.github.com>
AuthorDate: Sat Jul 8 08:24:30 2023 -0400

    [MJAVADOC-757] fix Javadoc warnings
---
 .../maven/plugins/javadoc/AbstractFixJavadocMojo.java |  4 ++--
 .../maven/plugins/javadoc/AbstractJavadocMojo.java    | 19 ++++++++-----------
 .../org/apache/maven/plugins/javadoc/JavadocUtil.java |  7 ++++---
 .../maven/plugins/javadoc/ResourcesBundleMojo.java    |  2 +-
 .../maven/plugins/javadoc/TestFixJavadocMojo.java     |  3 +--
 5 files changed, 16 insertions(+), 19 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 75a88fbe..cf5ab033 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
@@ -87,8 +87,8 @@ import org.codehaus.plexus.util.StringUtils;
 
 /**
  * Abstract class to fix Javadoc documentation and tags in source files.
- * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used">Where Tags
- * Can Be Used</a>.
+ *
+ * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used">Where Tags Can Be Used</a>
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @since 2.6
  */
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 8374125c..84e27228 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
@@ -1682,7 +1682,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
     /**
      * @param p not null maven project
      * @return the list of directories where compiled classes are placed for the given project. These dirs are
-     *         added in the javadoc classpath.
+     *         added to the javadoc classpath.
      */
     protected List<File> getProjectBuildOutputDirs(MavenProject p) {
         if (StringUtils.isEmpty(p.getBuild().getOutputDirectory())) {
@@ -1693,10 +1693,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
     }
 
     /**
-     * Either returns the attached artifact file or outputDirectory
-     *
-     * @param project
-     * @return
+     * @param mavenProject the project in which to find a classes file
+     * @return null, the attached artifact file, or outputDirectory.
      */
     protected File getClassesFile(MavenProject project) {
         if (!isAggregator() && isTest()) {
@@ -6026,8 +6024,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
     }
 
     /**
-     *
-     * @return List of projects to be part of aggregated javadoc
+     * @return list of projects to be part of aggregated javadoc
      */
     private List<MavenProject> getAggregatedProjects() {
         if (this.reactorProjects == null) {
@@ -6046,8 +6043,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
     }
 
     /**
-     *
-     * @return <code>true</code> if the module need to be skipped from aggregate generation
+     * @param mavenProject the project that might be skipped
+     * @return <code>true</code> if the project needs to be skipped from aggregate generation
      */
     protected boolean isSkippedModule(MavenProject mavenProject) {
         if (this.skippedModules == null || this.skippedModules.isEmpty()) {
@@ -6058,8 +6055,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
     }
 
     /**
-     *
-     * @return <code>true</code> if the pom configuration skip javadoc generation for the project
+     * @param mavenProject the project that might be skipped
+     * @return <code>true</code> if the pom configuration skips javadoc generation for the project
      */
     protected boolean isSkippedJavadoc(MavenProject mavenProject) {
         String property = mavenProject.getProperties().getProperty("maven.javadoc.skip");
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 91942bb3..c58a8ed0 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
@@ -393,9 +393,10 @@ public class JavadocUtil {
      * Convenience method that gets the files to be included in the javadoc.
      *
      * @param sourceDirectory the directory where the source files are located
-     * @param excludePackages the packages to be excluded in the javadocs
-     * @param sourceFileIncludes files to include.
-     * @param sourceFileExcludes files to exclude.
+     * @param sourceFileIncludes files to include
+     * @param sourceFileExcludes files to exclude
+     * @param excludePackages packages to be excluded from the javadocs
+     * @return the files from which javadoc should be generated
      */
     protected static List<String> getFilesFromSource(
             File sourceDirectory,
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java
index d93926e5..60d7e08e 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java
@@ -62,7 +62,7 @@ public class ResourcesBundleMojo extends AbstractJavadocMojo {
 
     /**
      * Base name of artifacts produced by this project. This will be combined with
-     * {@link ResourcesBundleMojo#getAttachmentClassifier()} to produce the name for this bundle
+     * {@link AbstractJavadocMojo#getAttachmentClassifier()} to produce the name for this bundle
      * jar.
      */
     @Parameter(defaultValue = "${project.build.finalName}", readonly = true)
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java
index 877c5f2d..e44f193c 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java
@@ -33,8 +33,7 @@ import org.apache.maven.project.MavenProject;
 
 /**
  * Fix Javadoc documentation and tags for the <code>Test Java code</code> for the project.
- * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used">Where Tags Can
- * Be Used</a>.
+ * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used">Where Tags Can Be Used</a>.
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @since 2.6
  */