[MPLUGIN-492] Documentation for plugins in general: Goals comprises m…

…ore than that This closes #252
apache · Dec 26, 2023 · 9bb13f0 · 9bb13f0
1 parent fc41218
commit 9bb13f0
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
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
@@ -95,6 +95,8 @@ protected void renderBody() {
             }
         }
 
+        paragraph(getI18nString("description"));
+
         renderGoalsSection(hasMavenReport);
 
         renderSystemRequirementsSection();
@@ -107,6 +109,8 @@ protected void renderBody() {
     }
 
     private void renderGoalsSection(boolean hasMavenReport) {
+        startSection(getI18nString("goals"));
+
         paragraph(getI18nString("goals.intro"));
 
         startTable();
@@ -157,6 +161,8 @@ private void renderGoalsSection(boolean hasMavenReport) {
         }
 
         endTable();
+
+        endSection();
     }
 
     private void renderSystemRequirementsSection() {

diff --git a/maven-plugin-report-plugin/src/main/resources/plugin-report.properties b/maven-plugin-report-plugin/src/main/resources/plugin-report.properties
@@ -18,9 +18,10 @@
 #
 
 report.plugin.name=Plugin Documentation
-report.plugin.description=This report provides goals and parameters documentation of a plugin.
+report.plugin.description=This report describes goals, parameters details, requirements and sample usage of this plugin.
 report.plugin.title=Plugin Documentation
 
+report.plugin.goals=Goals
 report.plugin.goals.nogoal=No goals defined in this plugin.
 report.plugin.goals.intro=Goals available for this plugin:
 report.plugin.goals.column.goal=Goal

diff --git a/maven-plugin-report-plugin/src/main/resources/plugin-report_de.properties b/maven-plugin-report-plugin/src/main/resources/plugin-report_de.properties
@@ -18,7 +18,7 @@
 #
 
 report.plugin.name=Plugin-Dokumentation
-report.plugin.description=Dieser Bericht dokumentiert die Goals des Plugins und deren Parameter.
+report.plugin.description=Dieser Bericht dokumentiert die Goals, Parameterdetails, Anforderungen und Verwendungsbeispiele dieses Plugins.
 report.plugin.title=Plugin-Dokumentation
 
 report.plugin.goals.nogoal=Keine Goals verf\u00FCgbar.

diff --git a/maven-plugin-report-plugin/src/main/resources/plugin-report_fr.properties b/maven-plugin-report-plugin/src/main/resources/plugin-report_fr.properties
@@ -18,7 +18,6 @@
 #
 
 report.plugin.name=Documentation du plugin
-report.plugin.description=Ce rapport fournit de la documentation sur les goals et les param\u00EAtres d'un plugin.
 report.plugin.title=Documentation du plugin
 
 report.plugin.goals.nogoal=Aucun goal disponible.

diff --git a/maven-plugin-report-plugin/src/main/resources/plugin-report_sv.properties b/maven-plugin-report-plugin/src/main/resources/plugin-report_sv.properties
@@ -18,7 +18,6 @@
 #
 
 report.plugin.name=Plugindokumentation
-report.plugin.description=Denna rapport tillhandah\u00E5ller m\u00E5l- och parameterdokumentation f\u00F6r en plugin.
 report.plugin.title=Plugindokumentation
 
 report.plugin.goals.nogoal=Inga m\u00E5l tillg\u00E4ngliga \u00E4nnu.