You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2021/12/12 23:53:12 UTC

[maven-reporting-api] 02/02: [MSHARED-844] Upgrade Doxia API to 1.11.1

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

slachiewicz pushed a commit to branch MSHARED-844
in repository https://gitbox.apache.org/repos/asf/maven-reporting-api.git

commit c45966d088dbd1b367ec48396f7bed2632cbc08c
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Mon Dec 13 00:24:38 2021 +0100

    [MSHARED-844] Upgrade Doxia API to 1.11.1
---
 pom.xml                                            | 24 +++++++++++++++++++++-
 .../maven/reporting/MavenMultiPageReport.java      |  7 +++++++
 .../org/apache/maven/reporting/MavenReport.java    |  8 ++++----
 3 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/pom.xml b/pom.xml
index 3c647fc..d464fad 100644
--- a/pom.xml
+++ b/pom.xml
@@ -74,11 +74,33 @@ under the License.
     <project.build.outputTimestamp>2020-04-04T09:03:59Z</project.build.outputTimestamp>
   </properties>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <version>3.3.1</version>
+        </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-project-info-reports-plugin</artifactId>
+          <version>3.1.2</version>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
   <dependencies>
     <dependency>
       <groupId>org.apache.maven.doxia</groupId>
       <artifactId>doxia-sink-api</artifactId>
-      <version>1.9.1</version>
+      <version>1.11.1</version>
+      <exclusions>
+        <exclusion>
+          <artifactId>plexus-container-default</artifactId>
+          <groupId>org.codehaus.plexus</groupId>
+        </exclusion>
+      </exclusions>
     </dependency>
   </dependencies>
 </project>
diff --git a/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java b/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
index 0a4db97..4c8e6ec 100644
--- a/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
+++ b/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
@@ -36,6 +36,13 @@ import java.util.Locale;
 public interface MavenMultiPageReport
     extends MavenReport
 {
+    /**
+     * Generate multi page report.
+     *
+     * @param sink The sink to write to.
+     * @param locale The locale to use.
+     * @throws MavenReportException if an error occurs.
+     */
     void generate( Sink sink, SinkFactory sinkFactory, Locale locale )
         throws MavenReportException;
 }
diff --git a/src/main/java/org/apache/maven/reporting/MavenReport.java b/src/main/java/org/apache/maven/reporting/MavenReport.java
index 72bea3c..0ca6086 100644
--- a/src/main/java/org/apache/maven/reporting/MavenReport.java
+++ b/src/main/java/org/apache/maven/reporting/MavenReport.java
@@ -102,16 +102,16 @@ public interface MavenReport
      * An external report is a report which calls a third party program which generates some reports too.
      * A good example is javadoc tool.
      *
-     * @return <tt>true</tt> if this report is external, <tt>false</tt> otherwise.
-     * Default should be <tt>false</tt>.
+     * @return {@code true} if this report is external, {@code false} otherwise.
+     * Default should be {@code false}.
      */
     boolean isExternalReport();
 
     /**
      * Verify some conditions before generate the report.
      *
-     * @return <tt>true</tt> if this report could be generated, <tt>false</tt> otherwise.
-     * Default should be <tt>true</tt>.
+     * @return {@code true} if this report could be generated, {@code false} otherwise.
+     * Default should be {@code true}.
      */
     boolean canGenerateReport();
 }