From df38c418d968c9542ad9fd37432de5fd32771e5e Mon Sep 17 00:00:00 2001
From: Vincent Siveton <vsiveton@apache.org>
Date: Tue, 19 Feb 2008 11:37:25 +0000
Subject: [PATCH] o more javadoc

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@629075 13f79535-47bb-0310-9956-ffa450edef68
---
 .../AbstractScriptedMojoDescriptorExtractor.java |  2 ++
 .../plugin/extractor/ExtractionException.java    | 16 +++++++++++++++-
 .../extractor/MojoDescriptorExtractor.java       | 11 +++++++++++
 3 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
index 8c90d8d..9be8364 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
@@ -38,11 +38,13 @@ import java.util.TreeMap;
 
 /**
  * @author jdcasey
+ * @version $Id$
  */
 public abstract class AbstractScriptedMojoDescriptorExtractor
     extends AbstractLogEnabled
     implements MojoDescriptorExtractor
 {
+    /** {@inheritDoc} */
     public List execute( MavenProject project, PluginDescriptor pluginDescriptor )
         throws ExtractionException, InvalidPluginDescriptorException
     {
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java
index 260bd94..783531f 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java
@@ -19,18 +19,32 @@ package org.apache.maven.tools.plugin.extractor;
  * under the License.
  */
 
+/**
+ * Wrap errors when extraction exception occurred.
+ *
+ * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
+ * @version $Id$
+ */
 public class ExtractionException
     extends Exception
 {
+    /** serialVersionUID */
+    static final long serialVersionUID = 9074953540861573535L;
 
+    /**
+     * @param message given message
+     * @param cause given cause
+     */
     public ExtractionException( String message, Throwable cause )
     {
         super( message, cause );
     }
 
+    /**
+     * @param message a given message
+     */
     public ExtractionException( String message )
     {
         super( message );
     }
-
 }
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java
index a8a2886..4fad4ec 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java
@@ -27,11 +27,22 @@ import java.util.List;
 
 /**
  * @author jdcasey
+ * @version $Id$
  */
 public interface MojoDescriptorExtractor
 {
+    /** Plexus role for lookup */
     String ROLE = MojoDescriptorExtractor.class.getName();
 
+    /**
+     * Execute the mojo extraction.
+     *
+     * @param project not null Maven project
+     * @param pluginDescriptor not null plugin descriptor
+     * @return a list of mojo descriptors.
+     * @throws ExtractionException if any
+     * @throws InvalidPluginDescriptorException if any
+     */
     List execute( MavenProject project, PluginDescriptor pluginDescriptor )
         throws ExtractionException, InvalidPluginDescriptorException;
 }
\ No newline at end of file