You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2008/02/01 23:30:34 UTC
svn commit: r617680 - in
/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator:
Generator.java PluginXdocGenerator.java
Author: vsiveton
Date: Fri Feb 1 14:30:32 2008
New Revision: 617680
URL: http://svn.apache.org/viewvc?rev=617680&view=rev
Log:
o improved javadoc
Modified:
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
Modified: maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java?rev=617680&r1=617679&r2=617680&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java Fri Feb 1 14:30:32 2008
@@ -25,11 +25,20 @@
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;
}
Modified: maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java?rev=617680&r1=617679&r2=617680&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java Fri Feb 1 14:30:32 2008
@@ -35,11 +35,12 @@
/**
* @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
{