improved documentation about Mojo Javadoc Tags

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1337552 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2012-05-12 14:33:19 +00:00
parent e6b364faf5
commit 3c3ef6d796
6 changed files with 17 additions and 14 deletions

View File

@ -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 -->

View File

@ -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;

View File

@ -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>

View File

@ -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}}.

View File

@ -3,7 +3,7 @@
------
Vincent Siveton
------
February 2008
2008-02-01
------
~~ Licensed to the Apache Software Foundation (ASF) under one

View File

@ -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