Skip to content

Commit 14e3d38

Browse files
slawekjaranowskislawekjaranowski
committed
[MPLUGIN-419] Fix documentation for maven-plugin-report-plugin
1 parent 154e741 commit 14e3d38

File tree

23 files changed

+65
-153
lines changed

23 files changed

+65
-153
lines changed

‎maven-plugin-annotations/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

‎maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,8 @@ public class DescriptorGeneratorMojo
194194
* This may be relative to the root of the generated Maven site.
195195
* It does not need to exist yet at the time when this goal is executed.
196196
* Must end with a slash.
197-
* <b>In case this is set the javadoc reporting goal should be executed prior to Plugin Report.</b>
197+
* <b>In case this is set the javadoc reporting goal should be executed prior to
198+
* <a href="../maven-plugin-report-plugin/index.html">Plugin Report</a>.</b>
198199
* @since 3.7.0
199200
*/
200201
@Parameter( property = "internalJavadocBaseUrl" )

‎maven-plugin-plugin/src/site/apt/examples/generate-report.apt.vm

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎maven-plugin-plugin/src/site/apt/index.apt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,10 @@ Maven Plugin Plugin
3434

3535
* Goals Overview
3636

37-
The Plugin Plugin has six goals:
37+
The Plugin Plugin has four goals:
3838

3939
* {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor,
4040

41-
* {{{./report-mojo.html}plugin:report}} generates the plugin documentation: one overview report
42-
(see {{{./plugin-info.html}example}}) and documentation for each plugin's goal (mojo),
43-
4441
* {{{./addPluginArtifactMetadata-mojo.html}plugin:addPluginArtifactMetadata}} injects any plugin-specific artifact
4542
metadata to the project's artifact, for subsequent installation and deployment,
4643

@@ -55,12 +52,11 @@ Maven Plugin Plugin
5552
General instructions on how to use the Plugin Plugin can be found on the {{{./usage.html}usage page}}. Some more
5653
specific use cases are described in the examples given below. Last but not least, users occasionally contribute
5754
additional examples, tips or errata to the
58-
{{{http://docs.codehaus.org/display/MAVENUSER/Plugin+Plugin}plugin's wiki page}}.
55+
{{{https://maven.apache.org/plugin-developers/index.html}Plugin Developers Centre page}}.
5956

60-
In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
61-
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
62-
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
63-
the {{{./mailing-lists.html}mail archive}}.
57+
In case you still have questions regarding the plugin's usage feel free to contact the {{{./mailing-lists.html}user mailing list}}.
58+
The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread.
59+
Hence, it is also worth browsing/searching the {{{./mailing-lists.html}mail archive}}.
6460

6561
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
6662
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
@@ -78,8 +74,6 @@ Maven Plugin Plugin
7874

7975
* {{{./examples/generate-descriptor.html}Configuring Generation of Plugin Descriptor}}
8076

81-
* {{{./examples/generate-report.html}Configuring Generation of Documentation Reports}}
82-
8377
* {{{./examples/generate-help.html}Configuring Generation of Help Mojo}}
8478

8579
[]

‎maven-plugin-plugin/src/site/apt/usage.apt

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,6 @@ mvn package
5454
mvn plugin:descriptor
5555
+-----+
5656

57-
* The <<<plugin:report>>> Goal
58-
59-
To generate the documentation of your plugin, execute the following on the command line:
60-
61-
+-----+
62-
mvn plugin:report
63-
+-----+
64-
65-
The xdoc files, one per goal, are generated by default in <<<$\{project.build.directory\}/generated-site/xdoc>>>,
66-
and an overview is generated in the site output.
67-
68-
If you add the plugin to the <<<reporting>>> section of your pom, you'll get the full report as html with <<<mvn site>>>.
69-
7057
* The <<<plugin:addPluginArtifactMetadata>>> Goal
7158

7259
The <<<plugin:addPluginArtifactMetadata>>> goal, on the other hand, is bound to the <<<package>>> phase of the build life cycle.

‎maven-plugin-plugin/src/site/site.xml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,18 @@ under the License.
2121

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

2626
<body>
2727
<menu name="Overview">
2828
<item name="Introduction" href="index.html"/>
2929
<item name="Goals" href="plugin-info.html"/>
3030
<item name="Usage" href="usage.html"/>
31-
<item name="Release Notes" href="jira-report.html"/>
3231
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
33-
<item name="License" href="http://www.apache.org/licenses/"/>
32+
<item name="License" href="https://www.apache.org/licenses/"/>
3433
<item name="Download" href="../download.html"/>
3534
</menu>
3635

37-
<menu name="Examples">
38-
<item name="Using Java5 annotations" href="/examples/using-annotations.html"/>
39-
<item name="Configuring Generation of Plugin Descriptor" href="/examples/generate-descriptor.html"/>
40-
<item name="Configuring Generation of Plugin Documentation" href="/examples/generate-report.html"/>
41-
<item name="Configuring Generation of HelpMojo" href="/examples/generate-help.html"/>
42-
</menu>
43-
4436
<menu name="Developers">
4537
<item name="Maven Plugin Tools" href="https://maven.apache.org/plugin-tools/index.html"/>
4638
<item name="Maven Plugin Descriptor" href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>

‎maven-plugin-report-plugin/src/it/plugin-info-jdk-default-version/src/site/site.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
23-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
22+
<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
23+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
2424
<body>
2525
<menu name="Overview">
2626
<item name="Goals" href="plugin-info.html"/>

‎maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@
6060
/**
6161
* Generates the Plugin's documentation report: <code>plugin-info.html</code> plugin overview page,
6262
* and one <code><i>goal</i>-mojo.html</code> per goal.
63-
* Relies on one output file from {@link org.apache.maven.plugin.plugin.DescriptorGeneratorMojo}.
63+
* Relies on one output file from <a href="../maven-plugin-plugin/descriptor-mojo.html">plugin:descriptor</a>.
6464
*
6565
* @author <a href="[email protected]">Stephane Nicoll</a>
6666
* @author <a href="mailto:[email protected]">Vincent Siveton</a>
67-
* @since 2.0
67+
* @since 3.7.0
6868
*/
6969
@Mojo( name = "report", threadSafe = true )
7070
@Execute( phase = LifecyclePhase.PROCESS_CLASSES )
@@ -155,7 +155,7 @@ public class PluginReport
155155
/**
156156
* Set this to "true" to skip generating the report.
157157
*
158-
* @since 2.8
158+
* @since 3.7.0
159159
*/
160160
@Parameter( defaultValue = "false", property = "maven.plugin.report.skip" )
161161
private boolean skip;
@@ -198,7 +198,7 @@ public class PluginReport
198198
/**
199199
* Path to {@code plugin.xml} plugin descriptor to generate the report from.
200200
*
201-
* @since 3.5.1
201+
* @since 3.7.0
202202
* @deprecated No longer evaluated, use {@link #enhancedPluginXmlFile}.
203203
*/
204204
@Parameter( defaultValue = "${project.build.outputDirectory}/META-INF/maven/plugin.xml", required = true,

‎maven-plugin-report-plugin/src/site/apt/index.apt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,17 @@ Maven Plugin Report Plugin
3333
* Goals Overview
3434

3535
The Plugin Report Plugin has one goal {{{./report-mojo.html}plugin-report:report}} which generates the plugin
36-
documentation: one overview report (see {{{./plugin-info.html}example}}) and documentation for each plugin's
37-
goal (mojo).
36+
documentation: one overview report and documentation for each plugin's goal (mojo).
3837

3938
[]
4039

4140
* Usage
4241

4342
General instructions on how to use the Plugin Report Plugin can be found on the {{{./usage.html}usage page}}.
4443

45-
In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
46-
free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
47-
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
48-
the {{{./mailing-lists.html}mail archive}}.
44+
In case you still have questions regarding the plugin's usage feel free to contact the {{{./mailing-lists.html}user mailing list}}.
45+
The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread.
46+
Hence, it is also worth browsing/searching the {{{./mailing-lists.html}mail archive}}.
4947

5048
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
5149
{{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your

‎maven-plugin-report-plugin/src/site/apt/usage.apt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@
2929

3030
Usage
3131

32-
The Plugin Report plugin is generally used for Maven plugins. Its goals are bound to different phases in the build life cycle.
33-
So when you execute a specific phase, the Plugin Plugin goals bound to it are also executed. Aside from this, each goal can
34-
also be explicitly executed from the command line.
32+
The Plugin Report Plugin is used to create reports about the plugin being built.
3533

3634
* The <<<plugin-report:report>>> Goal
3735

‎maven-plugin-report-plugin/src/site/site.xml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,18 @@ under the License.
2121

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

2626
<body>
2727
<menu name="Overview">
2828
<item name="Introduction" href="index.html"/>
2929
<item name="Goals" href="plugin-info.html"/>
3030
<item name="Usage" href="usage.html"/>
31-
<item name="Release Notes" href="jira-report.html"/>
3231
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
33-
<item name="License" href="http://www.apache.org/licenses/"/>
32+
<item name="License" href="https://www.apache.org/licenses/"/>
3433
<item name="Download" href="../download.html"/>
3534
</menu>
3635

37-
<menu name="Examples">
38-
<item name="Using Java5 annotations" href="/examples/using-annotations.html"/>
39-
<item name="Configuring Generation of Plugin Descriptor" href="/examples/generate-descriptor.html"/>
40-
<item name="Configuring Generation of Plugin Documentation" href="/examples/generate-report.html"/>
41-
<item name="Configuring Generation of HelpMojo" href="/examples/generate-help.html"/>
42-
</menu>
43-
4436
<menu name="Developers">
4537
<item name="Maven Plugin Tools" href="https://maven.apache.org/plugin-tools/index.html"/>
4638
<item name="Maven Plugin Descriptor" href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>

‎maven-plugin-tools-annotations/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

‎maven-plugin-tools-api/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

‎maven-plugin-tools-generators/src/site/site.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,15 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
<menu name="Reference">
31-
<item name="Plugin Descriptor" href="http://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>
30+
<item name="Plugin Descriptor" href="https://maven.apache.org/ref/current/maven-plugin-api/plugin.html"/>
3231
</menu>
3332
</body>
3433
</project>

‎maven-plugin-tools-java/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

‎maven-script/maven-plugin-tools-ant/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

‎maven-script/maven-plugin-tools-beanshell/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

‎maven-script/maven-plugin-tools-model/src/site/site.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ specific language governing permissions and limitations
1919
under the License.
2020
-->
2121

22-
<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">
22+
<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">
2323
<body>
2424
<menu name="Overview">
2525
<item name="Introduction" href="index.html"/>
2626
<item name="JavaDocs" href="apidocs/index.html"/>
2727
<item name="Source Xref" href="xref/index.html"/>
28-
<!--item name="FAQ" href="faq.html"/-->
2928
</menu>
3029
</body>
3130
</project>

0 commit comments

Comments
 (0)