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 2024/01/02 15:47:15 UTC
svn commit: r1915057 - in /maven/website/content: guides/development/guide-plugin-documentation.html guides/introduction/introduction-to-plugin-prefix-mapping.html guides/plugin/guide-java-report-plugin-development.html maven-site-1.0-site.jar
Author: svn-site-role
Date: Tue Jan 2 15:47:15 2024
New Revision: 1915057
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/guides/development/guide-plugin-documentation.html
maven/website/content/guides/introduction/introduction-to-plugin-prefix-mapping.html
maven/website/content/guides/plugin/guide-java-report-plugin-development.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 Tue Jan 2 15:47:15 2024
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/guides/development/guide-plugin-documentation.apt at 2024-01-02
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/guides/development/guide-plugin-documentation.apt.vm at 2024-01-02
| Rendered using Apache Maven Fluido Skin 2.0.0-M6
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -48,7 +48,7 @@
<ul class="breadcrumb">
<li><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide to the Plugin Documentation Standard <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-plugin-documentation.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li class="active ">Guide to the Plugin Documentation Standard <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-plugin-documentation.apt.vm"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-01-02</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
@@ -223,8 +223,8 @@
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-plugin-plugin</artifactId>
- <version>2.5.1</version>
+ <artifactId>maven-plugin-report-plugin</artifactId>
+ <version>3.10.2</version>
</plugin>
</plugins>
</reporting>
@@ -232,23 +232,20 @@
</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
+<li>all <code>@Parameter</code> fields should have a descriptive comment, informative enough that even a regular user can understand
<div class="verbatim source"><pre class="prettyprint linenums"> [...]
/**
* Put something informative here that a regular user can understand.
- *
- * @parameter
*/
+ @Parameter
private boolean someparameter;
[...]</pre></div></li>
<li>class level comment should explain what the goal does
<div class="verbatim source"><pre class="prettyprint linenums">[...]
/**
* Everything here will show up on the top of the generated plugin info page.
- *
- * @goal somegoal
- * @phase compile
*/
+@Mojo(name = "somegoal", defaultPhase = LifecyclePhase.COMPILE)
public class ExampleMojo
extends AbstractWarMojo
{
@@ -256,7 +253,7 @@ public class ExampleMojo
throws MojoExecutionException, MojoFailureException
{
[...]</pre></div></li>
-<li>the <code>@component</code> and <code>@readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li></ul></section><section>
+<li>the <code>@Component</code> and <code>readonly</code> parameters are not required to have any comments but it's still a good practice to provide one</li></ul></section><section>
<h2>Site Organization </h2>
<p>Visibility of the information is also crucial, having uniform navigation links will greatly improve the visibility of the documentations. The index page can also help emphasize important sections and pages of the plugin documentation. </p><section>
<h3>Site Descriptor </h3>
@@ -371,7 +368,7 @@ Plugin Name
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.4</version>
+ <version>3.6.2</version>
<configuration>
<minmemory>128m</minmemory>
<maxmemory>512</maxmemory>
@@ -397,7 +394,7 @@ Plugin Name
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
- <version>2.1</version>
+ <version>3.3.1</version>
</plugin>
</plugins>
</reporting>
Modified: maven/website/content/guides/introduction/introduction-to-plugin-prefix-mapping.html
==============================================================================
--- maven/website/content/guides/introduction/introduction-to-plugin-prefix-mapping.html (original)
+++ maven/website/content/guides/introduction/introduction-to-plugin-prefix-mapping.html Tue Jan 2 15:47:15 2024
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt at 2024-01-02
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt.vm at 2024-01-02
| Rendered using Apache Maven Fluido Skin 2.0.0-M6
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -48,7 +48,7 @@
<ul class="breadcrumb">
<li><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Introduction to Plugin Prefix Resolution <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li class="active ">Introduction to Plugin Prefix Resolution <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt.vm"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-01-02</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
@@ -166,7 +166,7 @@
...
<plugin>
<artifactId>maven-plugin-plugin</artifactId>
- <version>2.3</version>
+ <version>3.10.2</version>
<configuration>
...
<goalPrefix>somePrefix</goalPrefix>
Modified: maven/website/content/guides/plugin/guide-java-report-plugin-development.html
==============================================================================
--- maven/website/content/guides/plugin/guide-java-report-plugin-development.html (original)
+++ maven/website/content/guides/plugin/guide-java-report-plugin-development.html Tue Jan 2 15:47:15 2024
@@ -2,7 +2,7 @@
<!--
- | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/guides/plugin/guide-java-report-plugin-development.apt at 2024-01-02
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0-M10 from content/apt/guides/plugin/guide-java-report-plugin-development.apt.vm at 2024-01-02
| Rendered using Apache Maven Fluido Skin 2.0.0-M6
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -49,7 +49,7 @@
<ul class="breadcrumb">
<li><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
- <li class="active ">Guide to Developing Java Report Plugins <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/plugin/guide-java-report-plugin-development.apt"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li class="active ">Guide to Developing Java Report Plugins <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/plugin/guide-java-report-plugin-development.apt.vm"><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-01-02</li>
<li class="pull-right"><span class="divider">|</span>
<a href="../../scm.html" title="Get Sources">Get Sources</a></li>
@@ -247,7 +247,7 @@
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
- <version>3.5</version>
+ <version>3.10.2</version>
<scope>provided</scope>
</dependency>
<dependency>
@@ -263,25 +263,21 @@
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
- <version>3.7.0</version>
+ <version>3.11.0</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
- <version>2.5.2</version>
+ <version>3.1.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
- <version>3.5.1</version>
+ <version>3.10.2</version>
<configuration>
<goalPrefix>simple</goalPrefix>
</configuration>
<executions>
<execution>
- <id>default-descriptor</id>
- <phase>process-classes</phase>
- </execution>
- <execution>
<id>generated-helpmojo</id>
<goals>
<goal>helpmojo</goal>
@@ -344,7 +340,7 @@ public class SimpleReport extends Abstra
/**
* Practical reference to the Maven project
*/
- @Parameter(defaultValue = "${project}", readonly = true)
+ @Parameter(defaultValue = "MavenProject: org.apache.maven:maven-site:1.0 @ /home/jenkins/82467a7c/workspace/aven_maven-box_maven-site_master/pom.xml", readonly = true)
private MavenProject project;
@Override
@@ -471,7 +467,7 @@ simple:simple
/**
* Where the HTML pages of the report will be created.
*/
- @Parameter( defaultValue = "${project.reporting.outputDirectory}", property = "outputDirectory", required = true )
+ @Parameter( defaultValue = "/home/jenkins/82467a7c/workspace/aven_maven-box_maven-site_master/target/site", property = "outputDirectory", required = true )
private File outputDirectory;
...
@@ -496,7 +492,7 @@ simple:simple
otherSink.text("The Other Report");
...</pre></div>
<p>The above example will create a <code>other-report.html</code> HTML file along with <code>simple-report.html</code>.</p>
-<p>Note: Despite the fact that you will be creating additional HTML files, the Velocity variable <code>$currentFileName</code> passed to the <code>site.vm</code> script of the Maven Skin will keep the name of the original report (i.e. the result of your <i>getOutputName()</i> method). <a href="/doxia/doxia-sitetools/doxia-site-renderer/">More information about the Velocity variables</a>.</p></section></section><section>
+<p>Note: Despite the fact that you will be creating additional HTML files, the Velocity variable <code>guides/plugin/guide-java-report-plugin-development.html</code> passed to the <code>site.vm</code> script of the Maven Skin will keep the name of the original report (i.e. the result of your <i>getOutputName()</i> method). <a href="/doxia/doxia-sitetools/doxia-site-renderer/">More information about the Velocity variables</a>.</p></section></section><section>
<h2>Resources</h2>
<ol style="list-style-type: decimal">
<li><a href="./guide-java-plugin-development.html">Guide to Developing Java Plugins</a>: Starting point, since a reporting plugin is a plugin...</li>
Modified: maven/website/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.