diff --git a/maven-plugin-annotations/src/site/site.xml b/maven-plugin-annotations/src/site/site.xml index aa167ffd4..e39b127ee 100644 --- a/maven-plugin-annotations/src/site/site.xml +++ b/maven-plugin-annotations/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java index 84388041e..0954a7274 100644 --- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java +++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java @@ -194,7 +194,8 @@ public class DescriptorGeneratorMojo * This may be relative to the root of the generated Maven site. * It does not need to exist yet at the time when this goal is executed. * Must end with a slash. - * In case this is set the javadoc reporting goal should be executed prior to Plugin Report. + * In case this is set the javadoc reporting goal should be executed prior to + * Plugin Report. * @since 3.7.0 */ @Parameter( property = "internalJavadocBaseUrl" ) diff --git a/maven-plugin-plugin/src/site/apt/examples/generate-report.apt.vm b/maven-plugin-plugin/src/site/apt/examples/generate-report.apt.vm deleted file mode 100644 index 10d90f54b..000000000 --- a/maven-plugin-plugin/src/site/apt/examples/generate-report.apt.vm +++ /dev/null @@ -1,50 +0,0 @@ - ------ - Configuring Generation of Documentation Reports - ------ - Vincent Siveton - ------ - 2008-01-01 - ------ - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you under the Apache License, Version 2.0 (the -~~ "License"); you may not use this file except in compliance -~~ with the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, -~~ software distributed under the License is distributed on an -~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -~~ KIND, either express or implied. See the License for the -~~ specific language governing permissions and limitations -~~ under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Configuring Generation of Documentation Reports - - To configure the generation of the documentation reports, add the following to the project's POM: - -+-----+ - - ... - - - - org.apache.maven.plugins - maven-plugin-plugin - ${project.version} - - - ... - - ... - -+-----+ - - The documentation is generated by default in <<<$\{project.build.directory\}/site>>>. diff --git a/maven-plugin-plugin/src/site/apt/index.apt b/maven-plugin-plugin/src/site/apt/index.apt index c0c4538a6..371d77347 100644 --- a/maven-plugin-plugin/src/site/apt/index.apt +++ b/maven-plugin-plugin/src/site/apt/index.apt @@ -34,13 +34,10 @@ Maven Plugin Plugin * Goals Overview - The Plugin Plugin has six goals: + The Plugin Plugin has four goals: * {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor, - * {{{./report-mojo.html}plugin:report}} generates the plugin documentation: one overview report - (see {{{./plugin-info.html}example}}) and documentation for each plugin's goal (mojo), - * {{{./addPluginArtifactMetadata-mojo.html}plugin:addPluginArtifactMetadata}} injects any plugin-specific artifact metadata to the project's artifact, for subsequent installation and deployment, @@ -55,12 +52,11 @@ Maven Plugin Plugin General instructions on how to use the Plugin Plugin can be found on the {{{./usage.html}usage page}}. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the - {{{http://docs.codehaus.org/display/MAVENUSER/Plugin+Plugin}plugin's wiki page}}. + {{{https://maven.apache.org/plugin-developers/index.html}Plugin Developers Centre page}}. - In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel - free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could - already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching - the {{{./mailing-lists.html}mail archive}}. + In case you still have questions regarding the plugin's usage feel free to contact the {{{./mailing-lists.html}user mailing list}}. + The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. + Hence, it is also worth browsing/searching the {{{./mailing-lists.html}mail archive}}. If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your @@ -78,8 +74,6 @@ Maven Plugin Plugin * {{{./examples/generate-descriptor.html}Configuring Generation of Plugin Descriptor}} - * {{{./examples/generate-report.html}Configuring Generation of Documentation Reports}} - * {{{./examples/generate-help.html}Configuring Generation of Help Mojo}} [] diff --git a/maven-plugin-plugin/src/site/apt/usage.apt b/maven-plugin-plugin/src/site/apt/usage.apt index 0e4241550..c39844ace 100644 --- a/maven-plugin-plugin/src/site/apt/usage.apt +++ b/maven-plugin-plugin/src/site/apt/usage.apt @@ -54,19 +54,6 @@ mvn package mvn plugin:descriptor +-----+ -* The <<>> Goal - - To generate the documentation of your plugin, execute the following on the command line: - -+-----+ -mvn plugin:report -+-----+ - - The xdoc files, one per goal, are generated by default in <<<$\{project.build.directory\}/generated-site/xdoc>>>, - and an overview is generated in the site output. - - If you add the plugin to the <<>> section of your pom, you'll get the full report as html with <<>>. - * The <<>> Goal The <<>> goal, on the other hand, is bound to the <<>> phase of the build life cycle. diff --git a/maven-plugin-plugin/src/site/site.xml b/maven-plugin-plugin/src/site/site.xml index 485f079e3..cdb16f185 100644 --- a/maven-plugin-plugin/src/site/site.xml +++ b/maven-plugin-plugin/src/site/site.xml @@ -21,26 +21,18 @@ under the License. + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd"> - - + - - - - - - - diff --git a/maven-plugin-report-plugin/src/it/plugin-info-jdk-default-version/src/site/site.xml b/maven-plugin-report-plugin/src/it/plugin-info-jdk-default-version/src/site/site.xml index 3c125b591..c0a8d7a2f 100644 --- a/maven-plugin-report-plugin/src/it/plugin-info-jdk-default-version/src/site/site.xml +++ b/maven-plugin-report-plugin/src/it/plugin-info-jdk-default-version/src/site/site.xml @@ -19,8 +19,8 @@ specific language governing permissions and limitations under the License. --> - + diff --git a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java index b31e44236..c865899ca 100644 --- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java +++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java @@ -60,11 +60,11 @@ /** * Generates the Plugin's documentation report: plugin-info.html plugin overview page, * and one goal-mojo.html per goal. - * Relies on one output file from {@link org.apache.maven.plugin.plugin.DescriptorGeneratorMojo}. + * Relies on one output file from plugin:descriptor. * * @author Stephane Nicoll * @author Vincent Siveton - * @since 2.0 + * @since 3.7.0 */ @Mojo( name = "report", threadSafe = true ) @Execute( phase = LifecyclePhase.PROCESS_CLASSES ) @@ -155,7 +155,7 @@ public class PluginReport /** * Set this to "true" to skip generating the report. * - * @since 2.8 + * @since 3.7.0 */ @Parameter( defaultValue = "false", property = "maven.plugin.report.skip" ) private boolean skip; @@ -198,7 +198,7 @@ public class PluginReport /** * Path to {@code plugin.xml} plugin descriptor to generate the report from. * - * @since 3.5.1 + * @since 3.7.0 * @deprecated No longer evaluated, use {@link #enhancedPluginXmlFile}. */ @Parameter( defaultValue = "${project.build.outputDirectory}/META-INF/maven/plugin.xml", required = true, diff --git a/maven-plugin-report-plugin/src/site/apt/index.apt b/maven-plugin-report-plugin/src/site/apt/index.apt index dbe9da8a4..92baffe91 100644 --- a/maven-plugin-report-plugin/src/site/apt/index.apt +++ b/maven-plugin-report-plugin/src/site/apt/index.apt @@ -33,8 +33,7 @@ Maven Plugin Report Plugin * Goals Overview The Plugin Report Plugin has one goal {{{./report-mojo.html}plugin-report:report}} which generates the plugin - documentation: one overview report (see {{{./plugin-info.html}example}}) and documentation for each plugin's - goal (mojo). + documentation: one overview report and documentation for each plugin's goal (mojo). [] @@ -42,10 +41,9 @@ Maven Plugin Report Plugin General instructions on how to use the Plugin Report Plugin can be found on the {{{./usage.html}usage page}}. - In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel - free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could - already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching - the {{{./mailing-lists.html}mail archive}}. + In case you still have questions regarding the plugin's usage feel free to contact the {{{./mailing-lists.html}user mailing list}}. + The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. + Hence, it is also worth browsing/searching the {{{./mailing-lists.html}mail archive}}. If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your diff --git a/maven-plugin-report-plugin/src/site/apt/usage.apt b/maven-plugin-report-plugin/src/site/apt/usage.apt index 0d42b90dd..d53b1d2d3 100644 --- a/maven-plugin-report-plugin/src/site/apt/usage.apt +++ b/maven-plugin-report-plugin/src/site/apt/usage.apt @@ -29,9 +29,7 @@ Usage - The Plugin Report plugin is generally used for Maven plugins. Its goals are bound to different phases in the build life cycle. - So when you execute a specific phase, the Plugin Plugin goals bound to it are also executed. Aside from this, each goal can - also be explicitly executed from the command line. + The Plugin Report Plugin is used to create reports about the plugin being built. * The <<>> Goal diff --git a/maven-plugin-report-plugin/src/site/site.xml b/maven-plugin-report-plugin/src/site/site.xml index 485f079e3..cdb16f185 100644 --- a/maven-plugin-report-plugin/src/site/site.xml +++ b/maven-plugin-report-plugin/src/site/site.xml @@ -21,26 +21,18 @@ under the License. + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd"> - - + - - - - - - - diff --git a/maven-plugin-tools-annotations/src/site/site.xml b/maven-plugin-tools-annotations/src/site/site.xml index aa167ffd4..e39b127ee 100644 --- a/maven-plugin-tools-annotations/src/site/site.xml +++ b/maven-plugin-tools-annotations/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-plugin-tools-api/src/site/site.xml b/maven-plugin-tools-api/src/site/site.xml index aa167ffd4..e39b127ee 100644 --- a/maven-plugin-tools-api/src/site/site.xml +++ b/maven-plugin-tools-api/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-plugin-tools-generators/src/site/site.xml b/maven-plugin-tools-generators/src/site/site.xml index e942a4c5f..1640469c0 100644 --- a/maven-plugin-tools-generators/src/site/site.xml +++ b/maven-plugin-tools-generators/src/site/site.xml @@ -19,16 +19,15 @@ specific language governing permissions and limitations under the License. --> - + - - + diff --git a/maven-plugin-tools-java/src/site/site.xml b/maven-plugin-tools-java/src/site/site.xml index aa167ffd4..7b9a4c4d2 100644 --- a/maven-plugin-tools-java/src/site/site.xml +++ b/maven-plugin-tools-java/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-script/maven-plugin-tools-ant/src/site/site.xml b/maven-script/maven-plugin-tools-ant/src/site/site.xml index aa167ffd4..e39b127ee 100644 --- a/maven-script/maven-plugin-tools-ant/src/site/site.xml +++ b/maven-script/maven-plugin-tools-ant/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-script/maven-plugin-tools-beanshell/src/site/site.xml b/maven-script/maven-plugin-tools-beanshell/src/site/site.xml index aa167ffd4..e39b127ee 100644 --- a/maven-script/maven-plugin-tools-beanshell/src/site/site.xml +++ b/maven-script/maven-plugin-tools-beanshell/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-script/maven-plugin-tools-model/src/site/site.xml b/maven-script/maven-plugin-tools-model/src/site/site.xml index aa167ffd4..7b9a4c4d2 100644 --- a/maven-script/maven-plugin-tools-model/src/site/site.xml +++ b/maven-script/maven-plugin-tools-model/src/site/site.xml @@ -19,13 +19,12 @@ specific language governing permissions and limitations under the License. --> - + - diff --git a/maven-script/maven-script-ant/src/site/site.xml b/maven-script/maven-script-ant/src/site/site.xml index 3a16bf98b..238b5340c 100644 --- a/maven-script/maven-script-ant/src/site/site.xml +++ b/maven-script/maven-script-ant/src/site/site.xml @@ -19,18 +19,17 @@ specific language governing permissions and limitations under the License. --> - + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.0.0.xsd"> - - \ No newline at end of file + diff --git a/maven-script/maven-script-beanshell/src/site/site.xml b/maven-script/maven-script-beanshell/src/site/site.xml index 3a16bf98b..238b5340c 100644 --- a/maven-script/maven-script-beanshell/src/site/site.xml +++ b/maven-script/maven-script-beanshell/src/site/site.xml @@ -19,18 +19,17 @@ specific language governing permissions and limitations under the License. --> - + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.0.0.xsd"> - - \ No newline at end of file + diff --git a/maven-script/src/site/site.xml b/maven-script/src/site/site.xml index 67aa11c18..72b9e7bd0 100644 --- a/maven-script/src/site/site.xml +++ b/maven-script/src/site/site.xml @@ -19,12 +19,12 @@ specific language governing permissions and limitations under the License. --> - + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.0.0.xsd"> - \ No newline at end of file + diff --git a/src/site/site.xml b/src/site/site.xml index 2c185da5a..2c8fb9af9 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -31,12 +31,18 @@ under the License. - + + + + + + + diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 500eb6006..0040f11d9 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -66,62 +66,66 @@ maven-plugin-plugin Create a Maven plugin descriptor for any mojos found in the source tree, generate reports, create help goal. - + + + maven-plugin-report-plugin + The Plugin Report Plugin is used to create reports about the plugin being built. + maven-plugin-tools-generators Generators (XML descriptor, help, documentation), used by maven-plugin-plugin to generate content from descriptor extracted from sources. - + maven-plugin-tools-api Extractor API, used by maven-plugin-plugin to extract Mojo information. - +   maven-plugin-tools-java Extractor for plugins written in Java annotated with Mojo Javadoc Tags. - +     maven-plugin-tools-javadoc Provides doclets to support Mojo Javadoc Tags in the Javadoc Tool. - +   maven-plugin-tools-annotations Extractor for plugins written in Java with Java annotations. - +     maven-plugin-annotations Provides the Java annotations to use in Mojos. - + maven-script Maven Script Mojo Support lets developer write Maven plugins/goals with scripting languages instead of compiled Java. - +   maven-plugin-tools-beanshell Extractor for plugins written in Beanshell. - +   maven-script-beanshell Maven Beanshell Mojo Support, ie write Maven plugins with Beanshell scripts. - +   maven-plugin-tools-ant Extractor for plugins written in Ant. - +   maven-script-ant Maven Ant Mojo Support, ie write Maven plugins with Ant script. - +   maven-plugin-tools-model Plugin Metadata Model for script-based plugins. - +

The plugin descriptor is first being generated in memory finally containing some values in HTML format before being persisted into three different formats. The formats differ in

    -
  • whether they contain extended attributes (not part of the Plugin Descriptor Spec
    • +
  • whether they contain extended attributes (not part of the Plugin Descriptor Spec
  • whether descriptive values contain HTML or plain text
Javadoc tags are in general being resolved and replaced by their XHTML value before they end up in the according plugin descriptor attributes description and deprecated.