You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/12 16:33:19 UTC
svn commit: r1337552 - in /maven/plugin-tools/trunk:
maven-plugin-tools-java/ maven-plugin-tools-java/src/site/apt/
maven-plugin-tools-javadoc/ maven-plugin-tools-javadoc/src/site/apt/
Author: hboutemy
Date: Sat May 12 14:33:19 2012
New Revision: 1337552
URL: http://svn.apache.org/viewvc?rev=1337552&view=rev
Log:
improved documentation about Mojo Javadoc Tags
Modified:
maven/plugin-tools/trunk/maven-plugin-tools-java/pom.xml
maven/plugin-tools/trunk/maven-plugin-tools-java/src/site/apt/index.apt
maven/plugin-tools/trunk/maven-plugin-tools-javadoc/pom.xml
maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/index.apt
maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt
maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm
Modified: maven/plugin-tools/trunk/maven-plugin-tools-java/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-java/pom.xml?rev=1337552&r1=1337551&r2=1337552&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-java/pom.xml (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-java/pom.xml Sat May 12 14:33:19 2012
@@ -30,8 +30,8 @@
<artifactId>maven-plugin-tools-java</artifactId>
- <name>Maven Plugin Tool for Java</name>
- <description>Descriptor extractor for plugins written in Java.</description>
+ <name>Maven Plugin Tool for Java with Javadoc Tags</name>
+ <description>Descriptor extractor for plugins written in Java annotated with Mojo Javadoc Tags.</description>
<dependencies>
<!-- maven -->
Modified: maven/plugin-tools/trunk/maven-plugin-tools-java/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-java/src/site/apt/index.apt?rev=1337552&r1=1337551&r2=1337552&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-java/src/site/apt/index.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-java/src/site/apt/index.apt Sat May 12 14:33:19 2012
@@ -27,12 +27,12 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Maven Plugin Tool for Java
+Maven Plugin Tool for Java Annotated with Mojo Javadoc Tags
The Maven Plugin Tool for Java is the Java impl of {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
- to extract descriptors for plugins written in Java.
+ to extract descriptors for plugins written in Java annotated with Mojo Javadoc Tags.
-* Supported javadoc annotations
+* Supported Mojo Javadoc Tags
+---------+
import org.apache.maven.plugin.AbstractMojo;
Modified: maven/plugin-tools/trunk/maven-plugin-tools-javadoc/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-javadoc/pom.xml?rev=1337552&r1=1337551&r2=1337552&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-javadoc/pom.xml (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-javadoc/pom.xml Sat May 12 14:33:19 2012
@@ -31,7 +31,10 @@
<artifactId>maven-plugin-tools-javadoc</artifactId>
<name>Maven Plugin Tools Javadoc</name>
- <description>The Maven Plugin Tools Javadoc provides several Javadoc taglets to be used when generating Javadoc.</description>
+ <description>
+ The Maven Plugin Tools Javadoc provides several Javadoc taglets to be used when generating Javadoc from
+ java sources annotated with Mojo Javadoc Tags.
+ </description>
<inceptionYear>2008</inceptionYear>
<dependencies>
Modified: maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/index.apt?rev=1337552&r1=1337551&r2=1337552&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/index.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/index.apt Sat May 12 14:33:19 2012
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- February 2008
+ 2012-05-12
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,9 +28,9 @@
Maven Plugin Tools Javadoc
- The Maven Plugin Tools Javadoc project is a collection of several
- {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html}taglets}} which are used by
- the Plugin tool.
+ The Maven Plugin Tools Javadoc module is a collection of several
+ {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html}javadoc taglets}}
+ to enhance javadoc generated from sources annotated with {{{../maven-plugin-tools-java}Mojo Javadoc Tags}}.
For more information about the standard Javadoc tool, please refer to
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html}Reference Guide}}.
Modified: maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt?rev=1337552&r1=1337551&r2=1337552&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt Sat May 12 14:33:19 2012
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- February 2008
+ 2008-02-01
------
~~ Licensed to the Apache Software Foundation (ASF) under one
Modified: maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm?rev=1337552&r1=1337551&r2=1337552&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm Sat May 12 14:33:19 2012
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- February 2008
+ 2008-02-01
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -62,8 +62,8 @@ Usage
</project>
+-----+
- <<Note>>: Several taglets are similars to the Javadoc
- {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#tag}-tag}} option, i.e.:
+ <<Note>>: Several taglets are similar to simple Javadoc
+ {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#tag}-tag}} options, i.e.:
*--------------------------------------------+---------------------------------+
|| Taglet Class || Javadoc -tag option