Prepare for Doxia 2.0.0

apache · Nov 12, 2023 · c45d748 · c45d748
1 parent 8c8d114
commit c45d748
Show file tree

Hide file tree

Showing 22 changed files with 33 additions and 46 deletions.
diff --git a/maven-plugin-annotations/pom.xml b/maven-plugin-annotations/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-annotations</artifactId>

diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>

diff --git a/maven-plugin-report-plugin/pom.xml b/maven-plugin-report-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>

diff --git a/...-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java b/...-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java
@@ -107,21 +107,17 @@ protected MavenProject getProject() {
      * {@inheritDoc}
      */
     public boolean canGenerateReport() {
+        if (skip || skipReport) {
+            return false;
+        }
+
         return true;
     }
 
     /**
      * {@inheritDoc}
      */
     protected void executeReport(Locale locale) throws MavenReportException {
-        if (!canGenerateReport()) {
-            return;
-        }
-        if (skip || skipReport) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
-            return;
-        }
-
         // Generate the plugin's documentation
         generatePluginDocumentation(locale);
     }

diff --git a/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml
@@ -100,9 +100,6 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-site-plugin</artifactId>
         <version>@sitePluginVersion@</version>
-        <configuration>
-          <locales>en</locales>
-        </configuration>
       </plugin>
     </plugins>
   </build>

diff --git a/maven-plugin-report-plugin/src/it/plugin-report/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report/pom.xml
@@ -91,7 +91,7 @@ under the License.
         <artifactId>maven-site-plugin</artifactId>
         <version>@sitePluginVersion@</version>
         <configuration>
-          <locales>en,de,fr</locales>
+          <locales>default,de,fr</locales>
         </configuration>
       </plugin>
     </plugins>

diff --git a/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java b/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java
@@ -101,19 +101,15 @@ protected MavenProject getProject() {
 
     /** {@inheritDoc} */
     public boolean canGenerateReport() {
+        if (skip || skipReport) {
+            return false;
+        }
+
         return true;
     }
 
     /** {@inheritDoc} */
     protected void executeReport(Locale locale) throws MavenReportException {
-        if (!canGenerateReport()) {
-            return;
-        }
-        if (skip || skipReport) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
-            return;
-        }
-
         // Generate the plugin's documentation
         generatePluginDocumentation(locale);
     }

diff --git a/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java b/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java
@@ -37,7 +37,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics;
-import org.apache.maven.doxia.util.HtmlTools;
+import org.apache.maven.doxia.util.DoxiaUtils;
 import org.apache.maven.plugin.descriptor.MojoDescriptor;
 import org.apache.maven.plugin.descriptor.Parameter;
 import org.apache.maven.plugin.logging.Log;
@@ -260,7 +260,7 @@ private void renderParameterOverviewTableRow(Parameter parameter) {
         renderTableCellWithCode(
                 format("parameter.name", parameter.getName()),
                 // no need for additional URI encoding as it returns only URI safe characters
-                Optional.of("#" + HtmlTools.encodeId(parameter.getName())));
+                Optional.of("#" + DoxiaUtils.encodeId(parameter.getName())));
 
         // type
         Map.Entry<String, Optional<String>> type = getLinkedType(parameter, true);

diff --git a/...rt-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java b/...rt-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
@@ -283,7 +283,7 @@ private void renderUsageSection(boolean hasMavenReport) {
         sb.append("  ...").append(Markup.EOL);
         sb.append("</project>");
 
-        verbatimText(sb.toString());
+        verbatimSource(sb.toString());
 
         sink.paragraph();
         linkPatternedText(getI18nString("configuration.end"));

diff --git a/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java b/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java
@@ -137,7 +137,6 @@ public boolean canGenerateReport() {
     @Override
     protected void executeReport(Locale locale) throws MavenReportException {
         if (skip) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
             return;
         }
 
@@ -205,24 +204,23 @@ public String getOutputName() {
      */
     private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Locale locale)
             throws MavenReportException {
-
         if (pluginDescriptor.getMojos() != null) {
             for (MojoDescriptor descriptor : pluginDescriptor.getMojos()) {
                 GoalRenderer renderer;
                 try {
                     String filename = descriptor.getGoal() + "-mojo.html";
-                    Sink sink = getSinkFactory().createSink(outputDirectory, filename);
+                    Sink sink = getSinkFactory().createSink(getReportOutputDirectory(), filename);
                     renderer = new GoalRenderer(
                             sink,
                             i18n,
                             locale,
                             project,
                             descriptor,
-                            outputDirectory,
+                            getReportOutputDirectory(),
                             disableInternalJavadocLinkValidation,
                             getLog());
                 } catch (IOException e) {
-                    throw new MavenReportException("Can not generate sink for mojo " + descriptor.getGoal(), e);
+                    throw new MavenReportException("Cannot generate sink for mojo " + descriptor.getGoal(), e);
                 }
                 renderer.render();
             }

diff --git a/maven-plugin-tools-annotations/pom.xml b/maven-plugin-tools-annotations/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-annotations</artifactId>

diff --git a/maven-plugin-tools-api/pom.xml b/maven-plugin-tools-api/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-api</artifactId>

diff --git a/maven-plugin-tools-generators/pom.xml b/maven-plugin-tools-generators/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-generators</artifactId>

diff --git a/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml b/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml
@@ -47,7 +47,7 @@
         </li>
       </ul>
       <subsection name="Required Parameters">
-        <table border="0" class="bodyTable">
+        <table class="bodyTable">
           <tr>
             <th>Name</th>
             <th>Type</th>
@@ -81,7 +81,7 @@
         </table>
       </subsection>
       <subsection name="Optional Parameters">
-        <table border="0" class="bodyTable">
+        <table class="bodyTable">
           <tr>
             <th>Name</th>
             <th>Type</th>
@@ -109,7 +109,7 @@
       <subsection name="Parameter Details">
         <h4>
           <strong>
-            <a name="dir">&lt;dir&gt;</a>
+            <a id="dir">&lt;dir&gt;</a>
           </strong>
         </h4>
         <div>Test parameter description</div>
@@ -142,7 +142,7 @@
         <hr/>
         <h4>
           <strong>
-            <a name="withoutSince">&lt;withoutSince&gt;</a>
+            <a id="withoutSince">&lt;withoutSince&gt;</a>
           </strong>
         </h4>
         <div>(no description)</div>

diff --git a/maven-plugin-tools-java/pom.xml b/maven-plugin-tools-java/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-java</artifactId>

diff --git a/maven-script/maven-plugin-tools-ant/pom.xml b/maven-script/maven-plugin-tools-ant/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-ant</artifactId>

diff --git a/maven-script/maven-plugin-tools-beanshell/pom.xml b/maven-script/maven-plugin-tools-beanshell/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-beanshell</artifactId>

diff --git a/maven-script/maven-plugin-tools-model/pom.xml b/maven-script/maven-plugin-tools-model/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-model</artifactId>

diff --git a/maven-script/maven-script-ant/pom.xml b/maven-script/maven-script-ant/pom.xml
@@ -23,7 +23,7 @@ under the License.
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-script-ant</artifactId>

diff --git a/maven-script/maven-script-beanshell/pom.xml b/maven-script/maven-script-beanshell/pom.xml
@@ -23,7 +23,7 @@ under the License.
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-script</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-script-beanshell</artifactId>

diff --git a/maven-script/pom.xml b/maven-script/pom.xml
@@ -23,7 +23,7 @@ under the License.
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.10.3-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-script</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -29,7 +29,7 @@
 
   <groupId>org.apache.maven.plugin-tools</groupId>
   <artifactId>maven-plugin-tools</artifactId>
-  <version>3.10.3-SNAPSHOT</version>
+  <version>3.11.0-SNAPSHOT</version>
   <packaging>pom</packaging>
 
   <name>Maven Plugin Tools</name>