o improved javadoc

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@617680 13f79535-47bb-0310-9956-ffa450edef68
master
Vincent Siveton 2008-02-01 22:30:32 +00:00
parent 6082bcfd99
commit eef5dffbc1
2 changed files with 11 additions and 1 deletions

View File

@ -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;
}

View File

@ -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
{