improved documentation about Mojo Javadoc Tags
git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1337552 13f79535-47bb-0310-9956-ffa450edef68master
parent
e6b364faf5
commit
3c3ef6d796
|
|
@ -30,8 +30,8 @@
|
||||||
|
|
||||||
<artifactId>maven-plugin-tools-java</artifactId>
|
<artifactId>maven-plugin-tools-java</artifactId>
|
||||||
|
|
||||||
<name>Maven Plugin Tool for Java</name>
|
<name>Maven Plugin Tool for Java with Javadoc Tags</name>
|
||||||
<description>Descriptor extractor for plugins written in Java.</description>
|
<description>Descriptor extractor for plugins written in Java annotated with Mojo Javadoc Tags.</description>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<!-- maven -->
|
<!-- maven -->
|
||||||
|
|
|
||||||
|
|
@ -27,12 +27,12 @@
|
||||||
~~ NOTE: For help with the syntax of this file, see:
|
~~ NOTE: For help with the syntax of this file, see:
|
||||||
~~ http://maven.apache.org/doxia/references/apt-format.html
|
~~ 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}}
|
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;
|
import org.apache.maven.plugin.AbstractMojo;
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,10 @@
|
||||||
<artifactId>maven-plugin-tools-javadoc</artifactId>
|
<artifactId>maven-plugin-tools-javadoc</artifactId>
|
||||||
|
|
||||||
<name>Maven Plugin Tools Javadoc</name>
|
<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>
|
<inceptionYear>2008</inceptionYear>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
------
|
------
|
||||||
Vincent Siveton
|
Vincent Siveton
|
||||||
------
|
------
|
||||||
February 2008
|
2012-05-12
|
||||||
------
|
------
|
||||||
|
|
||||||
~~ Licensed to the Apache Software Foundation (ASF) under one
|
~~ Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
|
@ -28,9 +28,9 @@
|
||||||
|
|
||||||
Maven Plugin Tools Javadoc
|
Maven Plugin Tools Javadoc
|
||||||
|
|
||||||
The Maven Plugin Tools Javadoc project is a collection of several
|
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}taglets}} which are used by
|
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html}javadoc taglets}}
|
||||||
the Plugin tool.
|
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
|
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}}.
|
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html}Reference Guide}}.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
------
|
------
|
||||||
Vincent Siveton
|
Vincent Siveton
|
||||||
------
|
------
|
||||||
February 2008
|
2008-02-01
|
||||||
------
|
------
|
||||||
|
|
||||||
~~ Licensed to the Apache Software Foundation (ASF) under one
|
~~ Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
------
|
------
|
||||||
Vincent Siveton
|
Vincent Siveton
|
||||||
------
|
------
|
||||||
February 2008
|
2008-02-01
|
||||||
------
|
------
|
||||||
|
|
||||||
~~ Licensed to the Apache Software Foundation (ASF) under one
|
~~ Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
|
@ -62,8 +62,8 @@ Usage
|
||||||
</project>
|
</project>
|
||||||
+-----+
|
+-----+
|
||||||
|
|
||||||
<<Note>>: Several taglets are similars to the Javadoc
|
<<Note>>: Several taglets are similar to simple Javadoc
|
||||||
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#tag}-tag}} option, i.e.:
|
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#tag}-tag}} options, i.e.:
|
||||||
|
|
||||||
*--------------------------------------------+---------------------------------+
|
*--------------------------------------------+---------------------------------+
|
||||||
|| Taglet Class || Javadoc -tag option
|
|| Taglet Class || Javadoc -tag option
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue