You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/12/26 16:20:52 UTC
(maven-plugin-tools) branch MPLUGIN-492 created (now 9bb13f04)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch MPLUGIN-492
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
at 9bb13f04 [MPLUGIN-492] Documentation for plugins in general: Goals comprises more than that
This branch includes the following new commits:
new 9bb13f04 [MPLUGIN-492] Documentation for plugins in general: Goals comprises more than that
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-plugin-tools) 01/01: [MPLUGIN-492] Documentation for plugins in general: Goals comprises more than that
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch MPLUGIN-492
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit 9bb13f0427d8795d2c47c5068fc4c8ba552892e2
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Tue Dec 26 17:20:08 2023 +0100
[MPLUGIN-492] Documentation for plugins in general: Goals comprises more than that
This closes #252
---
.../apache/maven/plugin/plugin/report/PluginOverviewRenderer.java | 6 ++++++
.../src/main/resources/plugin-report.properties | 3 ++-
.../src/main/resources/plugin-report_de.properties | 2 +-
.../src/main/resources/plugin-report_fr.properties | 1 -
.../src/main/resources/plugin-report_sv.properties | 1 -
5 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
index 478fa6e3..9b772fc1 100644
--- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
+++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java
@@ -95,6 +95,8 @@ class PluginOverviewRenderer extends AbstractPluginReportRenderer {
}
}
+ paragraph(getI18nString("description"));
+
renderGoalsSection(hasMavenReport);
renderSystemRequirementsSection();
@@ -107,6 +109,8 @@ class PluginOverviewRenderer extends AbstractPluginReportRenderer {
}
private void renderGoalsSection(boolean hasMavenReport) {
+ startSection(getI18nString("goals"));
+
paragraph(getI18nString("goals.intro"));
startTable();
@@ -157,6 +161,8 @@ class PluginOverviewRenderer extends AbstractPluginReportRenderer {
}
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
index 9dd84a92..c9479731 100644
--- 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
index 879ad417..a4975f11 100644
--- 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
index eccc2d2f..e430ab38 100644
--- 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
index 08709667..f4b89b98 100644
--- 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.