This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new 96f41e5d Fix formatting to have XML rendered correctly
96f41e5d is described below
commit 96f41e5d9b5409124779a0e8702d48dc255fd75b
Author: Piotrek Żygieło <[email protected]>
AuthorDate: Thu Dec 29 11:39:37 2022 +0100
Fix formatting to have XML rendered correctly
---
.../guides/development/guide-plugin-documentation.apt | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/content/apt/guides/development/guide-plugin-documentation.apt
b/content/apt/guides/development/guide-plugin-documentation.apt
index 31a3da04..883b5a22 100644
--- a/content/apt/guides/development/guide-plugin-documentation.apt
+++ b/content/apt/guides/development/guide-plugin-documentation.apt
@@ -76,12 +76,14 @@ mvn site
* <<<\<issueManagement\>>>> - describes the system used for reporting
problems and modification requests
+--------------+
+<project>
[...]
<issueManagement>
<system>jira</system>
<url>http://jira.someproject.org</url>
</issueManagement>
[...]
+</project>
+--------------+
* <<<\<inceptionYear\>>>> - year the plugin was first created
@@ -89,6 +91,7 @@ mvn site
* <<<\<mailingLists\>>>> - lists where other users or the developers can be
contacted for help and discussions
+--------------+
+<project>
[...]
<mailingLists>
<mailingList>
@@ -103,11 +106,13 @@ mvn site
</mailingList>
</mailingLists>
[...]
+</project>
+--------------+
* <<<\<licenses\>>>> - plugin license
+--------------+
+<project>
[...]
<licenses>
<license>
@@ -117,11 +122,13 @@ mvn site
</license>
</licenses>
[...]
+</project>
+--------------+
* <<<\<scm\>>>> - the source code management configuration - a plugin without
this would raise suspicion, might not be OSS
+--------------+
+<project>
[...]
<scm>
<connection>scm:svn:http://noonecares.com/some/plugin/project/trunk</connection>
@@ -129,17 +136,20 @@ mvn site
<url>http://noonecares.com/viewvc/some/project/trunk/</url>
</scm>
[...]
+</project>
+--------------+
* <<<\<organization\>>>> - the organization maintaining the plugin, just in
case we need someone to blame
+--------------+
+<project>
[...]
<organization>
<name>Noone Care Software Foundation</name>
<url>http://noonecare.org/</url>
</organization>
[...]
+</project>
+--------------+
*Plugin Configuration Parameters
@@ -148,6 +158,7 @@ mvn site
section unless it is already inherited from a parent POM:
+--------------+
+<project>
[...]
<reporting>
<plugins>
@@ -159,6 +170,7 @@ mvn site
</plugins>
</reporting>
[...]
+</project>
+--------------+
The comments, annotations and plugin parameter
@@ -342,6 +354,7 @@ Plugin Name
To enable javadoc for your plugin add the following to your <<<pom.xml>>>
+--------------+
+<project>
[...]
<build>
[...]
@@ -362,6 +375,7 @@ Plugin Name
[...]
</reporting>
[...]
+</project>
+--------------+
Check the documentation about the plugin's
{{{/plugins/maven-javadoc-plugin/javadoc-mojo.html}<<<javadoc:javadoc>>>}} goal
for the advanced configurations.
@@ -375,6 +389,7 @@ Plugin Name
To enable source code cross-references add the following to your
<<<pom.xml>>>
+--------------+
+<project>
[...]
<build>
[...]
@@ -389,6 +404,7 @@ Plugin Name
</plugins>
</reporting>
[...]
+</project>
+--------------+
Check the {{{/plugins/maven-jxr-plugin/jxr-mojo.html}JXR configuration
page}} for the possible configuration parameters.
