From eef5dffbc1f73262385a1214c991745fd0822b6f Mon Sep 17 00:00:00 2001
From: Vincent Siveton <vsiveton@apache.org>
Date: Fri, 1 Feb 2008 22:30:32 +0000
Subject: [PATCH] o improved javadoc

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@617680 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/maven/tools/plugin/generator/Generator.java   | 9 +++++++++
 .../tools/plugin/generator/PluginXdocGenerator.java      | 3 ++-
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
index df3f028..6cc8fb2 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
@@ -25,11 +25,20 @@ import java.io.File;
 import java.io.IOException;
 
 /**
+ * Generate something, for instance a plugin report, from a plugin descriptor.
+ *
  * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
  * @version $Id$
  */
 public interface Generator
 {
+    /**
+     * Execute the generation for a given plugin descriptor.
+     *
+     * @param destinationDirectory required
+     * @param pluginDescriptor required
+     * @throws IOException if any
+     */
     void execute( File destinationDirectory, PluginDescriptor pluginDescriptor )
         throws IOException;
 }
\ No newline at end of file
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
index 2f06d8a..bb35780 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
@@ -35,11 +35,12 @@ import java.util.List;
 
 /**
  * @todo add example usage tag that can be shown in the doco
+ * @version $Id$
  */
 public class PluginXdocGenerator
     implements Generator
 {
-
+    /** {@inheritDoc} */
     public void execute( File destinationDirectory, PluginDescriptor pluginDescriptor )
         throws IOException
     {