maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject [maven-reporting-exec] branch master updated: [MSHARED-927] fix javadoc issues with JDK 8
Date Sat, 20 Jun 2020 07:28:38 GMT
This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-reporting-exec.git


The following commit(s) were added to refs/heads/master by this push:
     new 29b784c  [MSHARED-927] fix javadoc issues with JDK 8
29b784c is described below

commit 29b784c0fa687c08397dabc4ea5e6e9f337efe16
Author: Hervé Boutemy <hboutemy@apache.org>
AuthorDate: Sat Jun 20 09:28:33 2020 +0200

    [MSHARED-927] fix javadoc issues with JDK 8
---
 pom.xml                                            |  2 +-
 .../exec/DefaultMavenPluginManagerHelper.java      |  7 +++++-
 .../reporting/exec/DefaultMavenReportExecutor.java |  6 ++---
 .../reporting/exec/MavenPluginManagerHelper.java   | 26 +++++++++++-----------
 .../maven/reporting/exec/MavenReportExecution.java | 12 +++++-----
 .../maven/reporting/exec/MavenReportExecutor.java  |  4 ++--
 6 files changed, 31 insertions(+), 26 deletions(-)

diff --git a/pom.xml b/pom.xml
index b5e9283..606ecea 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,7 +29,7 @@
 
   <groupId>org.apache.maven.reporting</groupId>
   <artifactId>maven-reporting-exec</artifactId>
-  <version>1.5.2-SNAPSHOT</version>
+  <version>1.6.0-SNAPSHOT</version>
 
   <name>Apache Maven Reporting Executor</name>
   <description>Classes to manage report plugin executions with Maven 3.</description>
diff --git a/src/main/java/org/apache/maven/reporting/exec/DefaultMavenPluginManagerHelper.java
b/src/main/java/org/apache/maven/reporting/exec/DefaultMavenPluginManagerHelper.java
index 858b014..3dccd97 100644
--- a/src/main/java/org/apache/maven/reporting/exec/DefaultMavenPluginManagerHelper.java
+++ b/src/main/java/org/apache/maven/reporting/exec/DefaultMavenPluginManagerHelper.java
@@ -36,7 +36,7 @@ import org.codehaus.plexus.component.annotations.Requirement;
 import org.codehaus.plexus.logging.Logger;
 
 /**
- * 
+ * <p>DefaultMavenPluginManagerHelper class.</p>
  */
 @Component( role = MavenPluginManagerHelper.class )
 public class DefaultMavenPluginManagerHelper
@@ -56,6 +56,9 @@ public class DefaultMavenPluginManagerHelper
 
     private Method getRepositorySession;
 
+    /**
+     * <p>Constructor for DefaultMavenPluginManagerHelper.</p>
+     */
     public DefaultMavenPluginManagerHelper()
     {
         try
@@ -125,6 +128,7 @@ public class DefaultMavenPluginManagerHelper
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public PluginDescriptor getPluginDescriptor( Plugin plugin, MavenSession session )
         throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException
@@ -174,6 +178,7 @@ public class DefaultMavenPluginManagerHelper
         return null;
     }
 
+    /** {@inheritDoc} */
     @Override
     public void setupPluginRealm( PluginDescriptor pluginDescriptor, MavenSession session,
ClassLoader parent,
                                   List<String> imports, List<String> excludeArtifactIds
)
diff --git a/src/main/java/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.java
b/src/main/java/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.java
index 112e334..419bd27 100644
--- a/src/main/java/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.java
+++ b/src/main/java/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.java
@@ -63,6 +63,7 @@ import org.codehaus.plexus.util.xml.Xpp3DomUtils;
  * <p>
  * <b>Note</b> if no version is defined in the report plugin, the version will
be searched with
  * {@link #resolvePluginVersion(ReportPlugin, MavenReportExecutorRequest) resolvePluginVersion(...)}
method:
+ * </p>
  * <ol>
  * <li>use the one defined in the reportPlugin configuration,</li>
  * <li>search similar (same groupId and artifactId) plugin in the build/plugins section
of the pom,</li>
@@ -70,9 +71,9 @@ import org.codehaus.plexus.util.xml.Xpp3DomUtils;
  * <li>ask {@link PluginVersionResolver} to get a fallback version (display a warning
as it's not a recommended use).
  * </li>
  * </ol>
- * </p>
  * <p>
  * Following steps are done:
+ * </p>
  * <ul>
  * <li>get {@link PluginDescriptor} from the {@link MavenPluginManager} (through
  * {@link MavenPluginManagerHelper#getPluginDescriptor(Plugin, org.apache.maven.execution.MavenSession)
@@ -90,7 +91,6 @@ import org.codehaus.plexus.util.xml.Xpp3DomUtils;
  * LifecycleExecutor.calculateForkedExecutions(...)} if any forked execution is needed: if
yes, execute the forked
  * execution here</li>
  * </ul>
- * </p>
  * 
  * @author Olivier Lamy
  */
@@ -555,7 +555,7 @@ public class DefaultMavenReportExecutor
      * @param reportPlugin the report plugin to resolve the version
      * @param mavenReportExecutorRequest the current report execution context
      * @return the report plugin version
-     * @throws PluginVersionResolutionException
+     * @throws PluginVersionResolutionException on plugin version resolution issue
      */
     protected String resolvePluginVersion( ReportPlugin reportPlugin,
                                            MavenReportExecutorRequest mavenReportExecutorRequest
)
diff --git a/src/main/java/org/apache/maven/reporting/exec/MavenPluginManagerHelper.java b/src/main/java/org/apache/maven/reporting/exec/MavenPluginManagerHelper.java
index 03f5ccd..bc1f8e0 100644
--- a/src/main/java/org/apache/maven/reporting/exec/MavenPluginManagerHelper.java
+++ b/src/main/java/org/apache/maven/reporting/exec/MavenPluginManagerHelper.java
@@ -43,12 +43,12 @@ public interface MavenPluginManagerHelper
      * Helper for {@link org.apache.maven.plugin.MavenPluginManager#getPluginDescriptor
      * MavenPluginManager#getPluginDescriptor(Plugin, List, xxx.aether.RepositorySystemSession)}
      * 
-     * @param plugin
-     * @param session
-     * @return
-     * @throws PluginResolutionException
-     * @throws PluginDescriptorParsingException
-     * @throws InvalidPluginDescriptorException
+     * @param plugin the plugin
+     * @param session the session
+     * @return the plugin descriptor
+     * @throws PluginResolutionException on resolution issue
+     * @throws PluginDescriptorParsingException on descriptor parsing issue
+     * @throws InvalidPluginDescriptorException on invalid descriptor
      */
     PluginDescriptor getPluginDescriptor( Plugin plugin, MavenSession session )
         throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException;
@@ -57,13 +57,13 @@ public interface MavenPluginManagerHelper
      * Helper for {@link org.apache.maven.plugin.MavenPluginManager#setupPluginRealm
      * MavenPluginManager#setupPluginRealm(PluginDescriptor, ..., List, xxx.aether.graph.DependencyFilter)}
      * 
-     * @param pluginDescriptor
-     * @param session
-     * @param parent
-     * @param imports
-     * @param excludeArtifactIds
-     * @throws PluginResolutionException
-     * @throws PluginContainerException
+     * @param pluginDescriptor the plugin descriptor
+     * @param session the session
+     * @param parent the parent classloader
+     * @param imports classloader imports
+     * @param excludeArtifactIds artifacts excluded from classloader
+     * @throws PluginResolutionException on resolution issue
+     * @throws PluginContainerException on issue with configuration
      */
     void setupPluginRealm( PluginDescriptor pluginDescriptor, MavenSession session, ClassLoader
parent,
                                   List<String> imports, List<String> excludeArtifactIds
)
diff --git a/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java b/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java
index 2d6cbe1..b857731 100644
--- a/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java
+++ b/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java
@@ -26,13 +26,13 @@ import org.apache.maven.reporting.MavenReport;
  * <p>
  *   Since Maven 3, reporting plugins (ie {@link MavenReport}s) are not anymore prepared
by Maven core.
  *   This class will store all necessary information for later {@link MavenReport} generation/execution:
- *   <ul>
- *     <li>a {@link MavenReport},</li>
- *     <li>the goal name associated to the report,</li>
- *     <li>the associated {@link ClassLoader} for the report generation,</li>
- *     <li>the {@link Plugin} associated to the {@link MavenReport}.</li>
- *   </ul> 
  * </p>
+ * <ul>
+ *   <li>a {@link MavenReport},</li>
+ *   <li>the goal name associated to the report,</li>
+ *   <li>the associated {@link ClassLoader} for the report generation,</li>
+ *   <li>the {@link Plugin} associated to the {@link MavenReport}.</li>
+ * </ul> 
  * <p>
  *   With this bean, a plugin wanting to generate a report (= <i>"execute"</i>
the report) has to call the
  *   {@link MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)}
diff --git a/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java b/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java
index edf8d4e..36db32c 100644
--- a/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java
+++ b/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java
@@ -39,9 +39,9 @@ public interface MavenReportExecutor
     /**
      * Build the {@link org.apache.maven.reporting.MavenReport}s, with associated forked
executions if necessary. 
      * 
-     * @param mavenReportExecutorRequest
+     * @param mavenReportExecutorRequest the request
      * @return a list or prepared Maven report executions
-     * @throws MojoExecutionException
+     * @throws MojoExecutionException on report execution issue
      */
     List<MavenReportExecution> buildMavenReports( MavenReportExecutorRequest mavenReportExecutorRequest
)
         throws MojoExecutionException;


Mime
View raw message