From 3c3ef6d79654146795dac9549f5d8dc36ad667c6 Mon Sep 17 00:00:00 2001
From: Herve Boutemy <hboutemy@apache.org>
Date: Sat, 12 May 2012 14:33:19 +0000
Subject: [PATCH] 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
---
 maven-plugin-tools-java/pom.xml                         | 4 ++--
 maven-plugin-tools-java/src/site/apt/index.apt          | 6 +++---
 maven-plugin-tools-javadoc/pom.xml                      | 5 ++++-
 maven-plugin-tools-javadoc/src/site/apt/index.apt       | 8 ++++----
 maven-plugin-tools-javadoc/src/site/apt/screenshots.apt | 2 +-
 maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm    | 6 +++---
 6 files changed, 17 insertions(+), 14 deletions(-)

diff --git a/maven-plugin-tools-java/pom.xml b/maven-plugin-tools-java/pom.xml
index e662e87..d8e0f2e 100644
--- a/maven-plugin-tools-java/pom.xml
+++ b/maven-plugin-tools-java/pom.xml
@@ -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 -->
diff --git a/maven-plugin-tools-java/src/site/apt/index.apt b/maven-plugin-tools-java/src/site/apt/index.apt
index b84ba23..e47b040 100644
--- a/maven-plugin-tools-java/src/site/apt/index.apt
+++ b/maven-plugin-tools-java/src/site/apt/index.apt
@@ -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;
diff --git a/maven-plugin-tools-javadoc/pom.xml b/maven-plugin-tools-javadoc/pom.xml
index 80413ba..4e376ce 100644
--- a/maven-plugin-tools-javadoc/pom.xml
+++ b/maven-plugin-tools-javadoc/pom.xml
@@ -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>
diff --git a/maven-plugin-tools-javadoc/src/site/apt/index.apt b/maven-plugin-tools-javadoc/src/site/apt/index.apt
index 3a50256..a4e26a9 100644
--- a/maven-plugin-tools-javadoc/src/site/apt/index.apt
+++ b/maven-plugin-tools-javadoc/src/site/apt/index.apt
@@ -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}}.
 
diff --git a/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt b/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt
index 425f2ed..4e9af9f 100644
--- a/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt
+++ b/maven-plugin-tools-javadoc/src/site/apt/screenshots.apt
@@ -3,7 +3,7 @@
  ------
  Vincent Siveton
  ------
- February 2008
+ 2008-02-01
  ------
 
 ~~ Licensed to the Apache Software Foundation (ASF) under one
diff --git a/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm b/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm
index df38e40..3798bff 100644
--- a/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm
+++ b/maven-plugin-tools-javadoc/src/site/apt/usage.apt.vm
@@ -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