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 Jason van Zyl * @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 {