Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions maven-plugin-annotations/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* <b>In case this is set the javadoc reporting goal should be executed prior to Plugin Report.</b>
* <b>In case this is set the javadoc reporting goal should be executed prior to
* <a href="../maven-plugin-report-plugin/index.html">Plugin Report</a>.</b>
* @since 3.7.0
*/
@Parameter( property = "internalJavadocBaseUrl" )
Expand Down
50 changes: 0 additions & 50 deletions maven-plugin-plugin/src/site/apt/examples/generate-report.apt.vm

This file was deleted.

16 changes: 5 additions & 11 deletions maven-plugin-plugin/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand All @@ -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
Expand All @@ -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}}

[]
13 changes: 0 additions & 13 deletions maven-plugin-plugin/src/site/apt/usage.apt
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,6 @@ mvn package
mvn plugin:descriptor
+-----+

* The <<<plugin:report>>> 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 <<<reporting>>> section of your pom, you'll get the full report as html with <<<mvn site>>>.

* The <<<plugin:addPluginArtifactMetadata>>> Goal

The <<<plugin:addPluginArtifactMetadata>>> goal, on the other hand, is bound to the <<<package>>> phase of the build life cycle.
Expand Down
12 changes: 2 additions & 10 deletions maven-plugin-plugin/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,18 @@ under the License.

<project xmlns="http://maven.apache.org/DECORATION/1.8.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">

<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="Release Notes" href="jira-report.html"/>
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
<item name="License" href="http://www.apache.org/licenses/"/>
<item name="License" href="https://www.apache.org/licenses/"/>
<item name="Download" href="../download.html"/>
</menu>

<menu name="Examples">
<item name="Using Java5 annotations" href="/examples/using-annotations.html"/>
<item name="Configuring Generation of Plugin Descriptor" href="/examples/generate-descriptor.html"/>
<item name="Configuring Generation of Plugin Documentation" href="/examples/generate-report.html"/>
<item name="Configuring Generation of HelpMojo" href="/examples/generate-help.html"/>
</menu>

<menu name="Developers">
<item name="Maven Plugin Tools" href="https://maven.apache.org/plugin-tools/index.html"/>
<item name="Maven Plugin Descriptor" href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Goals" href="plugin-info.html"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@
/**
* Generates the Plugin's documentation report: <code>plugin-info.html</code> plugin overview page,
* and one <code><i>goal</i>-mojo.html</code> per goal.
* Relies on one output file from {@link org.apache.maven.plugin.plugin.DescriptorGeneratorMojo}.
* Relies on one output file from <a href="../maven-plugin-plugin/descriptor-mojo.html">plugin:descriptor</a>.
*
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @since 2.0
* @since 3.7.0
*/
@Mojo( name = "report", threadSafe = true )
@Execute( phase = LifecyclePhase.PROCESS_CLASSES )
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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,
Expand Down
10 changes: 4 additions & 6 deletions maven-plugin-report-plugin/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,17 @@ 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).

[]

* Usage

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
Expand Down
4 changes: 1 addition & 3 deletions maven-plugin-report-plugin/src/site/apt/usage.apt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<<plugin-report:report>>> Goal

Expand Down
12 changes: 2 additions & 10 deletions maven-plugin-report-plugin/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,18 @@ under the License.

<project xmlns="http://maven.apache.org/DECORATION/1.8.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">

<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="Release Notes" href="jira-report.html"/>
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
<item name="License" href="http://www.apache.org/licenses/"/>
<item name="License" href="https://www.apache.org/licenses/"/>
<item name="Download" href="../download.html"/>
</menu>

<menu name="Examples">
<item name="Using Java5 annotations" href="/examples/using-annotations.html"/>
<item name="Configuring Generation of Plugin Descriptor" href="/examples/generate-descriptor.html"/>
<item name="Configuring Generation of Plugin Documentation" href="/examples/generate-report.html"/>
<item name="Configuring Generation of HelpMojo" href="/examples/generate-help.html"/>
</menu>

<menu name="Developers">
<item name="Maven Plugin Tools" href="https://maven.apache.org/plugin-tools/index.html"/>
<item name="Maven Plugin Descriptor" href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>
Expand Down
3 changes: 1 addition & 2 deletions maven-plugin-tools-annotations/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
3 changes: 1 addition & 2 deletions maven-plugin-tools-api/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
5 changes: 2 additions & 3 deletions maven-plugin-tools-generators/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,15 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu name="Reference">
<item name="Plugin Descriptor" href="http://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>
<item name="Plugin Descriptor" href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>
</menu>
</body>
</project>
3 changes: 1 addition & 2 deletions maven-plugin-tools-java/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.0.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
3 changes: 1 addition & 2 deletions maven-script/maven-plugin-tools-ant/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
3 changes: 1 addition & 2 deletions maven-script/maven-plugin-tools-beanshell/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
3 changes: 1 addition & 2 deletions maven-script/maven-plugin-tools-model/src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ specific language governing permissions and limitations
under the License.
-->

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.0.0.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
</body>
</project>
Loading