You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2022/12/30 22:28:15 UTC
svn commit: r1906288 - in /maven/website/content: guides/development/guide-plugin-documentation.html guides/mini/guide-configuring-plugins.html maven-site-1.0-site.jar
Author: svn-site-role
Date: Fri Dec 30 22:28:15 2022
New Revision: 1906288
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/guides/development/guide-plugin-documentation.html
maven/website/content/guides/mini/guide-configuring-plugins.html
maven/website/content/maven-site-1.0-site.jar
Modified: maven/website/content/guides/development/guide-plugin-documentation.html
==============================================================================
--- maven/website/content/guides/development/guide-plugin-documentation.html (original)
+++ maven/website/content/guides/development/guide-plugin-documentation.html Fri Dec 30 22:28:15 2022
@@ -152,15 +152,18 @@
<li><code><url></code> - the site of the plugin, normally <i>maven.apache.org</i> or <i>org.mojohaus</i></li>
<li><code><prerequisites></code> - the minimum version of Maven required to use this plugin</li>
<li><code><issueManagement></code> - describes the system used for reporting problems and modification requests
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<issueManagement>
<system>jira</system>
<url>http://jira.someproject.org</url>
</issueManagement>
- [...] </pre></div></li>
+ [...]
+</project></pre></div></li>
<li><code><inceptionYear></code> - year the plugin was first created</li>
<li><code><mailingLists></code> - lists where other users or the developers can be contacted for help and discussions
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<mailingLists>
<mailingList>
<name>Project users</name>
@@ -173,9 +176,11 @@
[...]
</mailingList>
</mailingLists>
- [...] </pre></div></li>
+ [...]
+</project></pre></div></li>
<li><code><licenses></code> - plugin license
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<licenses>
<license>
<name>Apache License, Version 2.0</name>
@@ -183,25 +188,31 @@
<distribution>repo</distribution>
</license>
</licenses>
- [...]</pre></div></li>
+ [...]
+</project></pre></div></li>
<li><code><scm></code> - the source code management configuration - a plugin without this would raise suspicion, might not be OSS
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<scm>
<connection>scm:svn:http://noonecares.com/some/plugin/project/trunk</connection>
<developerConnection>scm:svn:https://noonecares.com/some/plugin/project/trunk</developerConnection>
<url>http://noonecares.com/viewvc/some/project/trunk/</url>
</scm>
- [...]</pre></div></li>
+ [...]
+</project></pre></div></li>
<li><code><organization></code> - the organization maintaining the plugin, just in case we need someone to blame
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<organization>
<name>Noone Care Software Foundation</name>
<url>http://noonecare.org/</url>
</organization>
- [...]</pre></div></li></ul></section></section><section>
+ [...]
+</project></pre></div></li></ul></section></section><section>
<h2><a name="Plugin_Configuration_Parameters"></a>Plugin Configuration Parameters</h2>
<p>The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the <code><reporting></code> section unless it is already inherited from a parent POM:</p>
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<reporting>
<plugins>
<plugin>
@@ -211,7 +222,8 @@
</plugin>
</plugins>
</reporting>
- [...] </pre></div>
+ [...]
+</project></pre></div>
<p>The comments, annotations and plugin parameter names are extracted from the plugin source and rendered in the Plugin Info page. In order for the generated site to be useful here are some guidelines you can follow when documenting your plugin.</p>
<ul>
<li>all <code>@parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand
@@ -342,7 +354,8 @@ Plugin Name
<li>Maven Javadoc Plugin
<p>Javadocs provide documentation that makes it easier for developers to know how to use a particular class. Instead of reading and understanding the actual source code, the developer can use the Javadocs instead to lookup the class attributes and methods.</p>
<p>To enable javadoc for your plugin add the following to your <code>pom.xml</code></p>
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<build>
[...]
</build>
@@ -361,12 +374,14 @@ Plugin Name
</plugins>
[...]
</reporting>
- [...]</pre></div>
+ [...]
+</project></pre></div>
<p>Check the documentation about the plugin's <a href="/plugins/maven-javadoc-plugin/javadoc-mojo.html"><code>javadoc:javadoc</code></a> goal for the advanced configurations.</p></li>
<li>Maven JXR Plugin
<p>The Maven JXR Plugin generates a cross-reference of the project sources. The generated cross-references are also linked to the corresponding javadoc if javadoc is generated. The cross-references is great for those who wants to better understand the inner workings of the plugin.</p>
<p>To enable source code cross-references add the following to your <code>pom.xml</code></p>
-<div class="source"><pre class="prettyprint linenums"> [...]
+<div class="source"><pre class="prettyprint linenums"><project>
+ [...]
<build>
[...]
</build>
@@ -379,7 +394,8 @@ Plugin Name
</plugin>
</plugins>
</reporting>
- [...] </pre></div>
+ [...]
+</project></pre></div>
<p>Check the <a href="/plugins/maven-jxr-plugin/jxr-mojo.html">JXR configuration page</a> for the possible configuration parameters.</p></li></ul></section></section>
</main>
</div>
Modified: maven/website/content/guides/mini/guide-configuring-plugins.html
==============================================================================
--- maven/website/content/guides/mini/guide-configuring-plugins.html (original)
+++ maven/website/content/guides/mini/guide-configuring-plugins.html Fri Dec 30 22:28:15 2022
@@ -232,7 +232,8 @@ public class MyQueryMojo
<p>Parametrisation of Mojos is relying internally on Plexus Component Configuration API provided by <a class="externalLink" href="https://github.com/eclipse/sisu.plexus">sisu-plexus</a>.</p><section>
<h4><a name="Mapping_Value_Objects">Mapping Value Objects</a></h4>
<p>Mapping value types, like Boolean or Integer, is very simple. The <code><configuration></code> element might look like the following:</p>
-<div class="source"><pre class="prettyprint linenums">...
+<div class="source"><pre class="prettyprint linenums"><project>
+...
<configuration>
<myString>a string</myString>
<myBoolean>true</myBoolean>
@@ -241,7 +242,8 @@ public class MyQueryMojo
<myFile>c:\temp</myFile>
<myURL>http://maven.apache.org</myURL>
</configuration>
-...</pre></div>
+...
+</project></pre></div>
<p>The detailed type coercion is explained in the table below. For conversion to primitive types their according <a class="externalLink" href="https://docs.oracle.com/javase/tutorial/java/data/autoboxing.html">wrapper classes are used and automatically unboxed</a>.</p>
<table border="1" class="table table-striped">
<tr class="a">
@@ -300,27 +302,31 @@ public class MyQueryMojo
<td align="center"><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html#URL-java.lang.String-"><code>new URL(String)</code></a></td></tr></table></section><section>
<h4><a name="Mapping_Complex_Objects">Mapping Complex Objects</a></h4>
<p>Mapping complex types is also fairly straight forward. Let's look at a simple example where we are trying to map a configuration for Person object. The <code><configuration/></code> element might look like the following:</p>
-<div class="source"><pre class="prettyprint linenums">...
+<div class="source"><pre class="prettyprint linenums"><project>
+...
<configuration>
<person>
<firstName>Jason</firstName>
<lastName>van Zyl</lastName>
</person>
</configuration>
-...</pre></div>
+...
+</project></pre></div>
<p>The rules for mapping complex objects are as follows:</p>
<ul>
<li>There must be a private field that corresponds to name of the element being mapped. So in our case the <code>person</code> element must map to a <code>person</code> field in the mojo.</li>
<li>The object instantiated must be in the same package as the Mojo itself. So if your mojo is in <code>com.mycompany.mojo.query</code> then the mapping mechanism will look in that package for an object named <code>Person</code>. The mechanism capitalizes the first letter of the element name and uses that to search for the object to instantiate.</li>
<li>If you wish to have the object to be instantiated live in a different package or have a more complicated name, specify this using an <code>implementation</code> attribute like the following:</li></ul>
-<div class="source"><pre class="prettyprint linenums">...
+<div class="source"><pre class="prettyprint linenums"><project>
+...
<configuration>
<person implementation="com.mycompany.mojo.query.SuperPerson">
<firstName>Jason</firstName>
<lastName>van Zyl</lastName>
</person>
</configuration>
-...</pre></div></section><section>
+...
+</project></pre></div></section><section>
<h4><a name="Mapping_Collection_Types">Mapping Collection Types</a></h4>
<p>The configuration mapping mechanism can easily deal with most collections so let's go through a few examples to show you how it's done:</p><section>
<h5><a name="Mapping_Collections_and_Arrays">Mapping Collections and Arrays</a></h5>
@@ -387,14 +393,16 @@ public class MyQueryMojo
@Parameter
private Map<String,String> myMap;
...</pre></div>
-<div class="source"><pre class="prettyprint linenums">...
+<div class="source"><pre class="prettyprint linenums"><project>
+...
<configuration>
<myMap>
<key1>value1</key1>
<key2>value2</key2>
</myMap>
</configuration>
-...</pre></div>
+...
+</project></pre></div>
<p>Unlike Collections the value type for Maps is always derived from the parameter type information from either <a class="externalLink" href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html#getGenericType()"><code>Field.getGenericType()</code></a> or <a class="externalLink" href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html#getGenericParameterTypes()"><code>Method.getGenericParameterTypes()</code></a>. It falls back to <code>String</code>. The key type must always be <code>String</code>.</p>
<p>In contrast to value objects and collections/arrays there is no string coercion defined for maps, i.e. you cannot give parameters of that type via CLI argument. </p></section><section>
<h5><a name="Mapping_Properties">Mapping Properties</a></h5>
@@ -403,7 +411,8 @@ public class MyQueryMojo
@Parameter
private Properties myProperties;
...</pre></div>
-<div class="source"><pre class="prettyprint linenums">...
+<div class="source"><pre class="prettyprint linenums"><project>
+...
<configuration>
<myProperties>
<property>
@@ -416,7 +425,8 @@ public class MyQueryMojo
</property>
</myProperties>
</configuration>
-...</pre></div>
+...
+</project></pre></div>
<p>In contrast to value objects and collections/arrays there is no string coercion defined for properties, i.e. you cannot give parameters of those type via CLI argument. </p></section></section></section></section><section>
<h2><a name="Configuring_Build_Plugins">Configuring Build Plugins</a></h2>
<p>The following is only to configure Build plugins in the <code><build></code> element.</p><section>
Modified: maven/website/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.