MNG-852: added Javadoc and parameter's documentation.

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@280096 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephane Nicoll 2005-09-11 08:43:37 +00:00
parent f0a666a43d
commit d18e4b8a1b
1 changed files with 24 additions and 3 deletions

View File

@ -26,6 +26,8 @@ import org.apache.maven.project.MavenProjectHelper;
import java.io.File; import java.io.File;
/** /**
* Build an EJB (and optional client) from the current project.
*
* @author <a href="evenisse@apache.org">Emmanuel Venisse</a> * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
* @version $Id$ * @version $Id$
* @goal ejb * @goal ejb
@ -38,35 +40,48 @@ public class EjbMojo
// TODO: will null work instead? // TODO: will null work instead?
private static final String[] DEFAULT_INCLUDES = new String[]{"**/**"}; private static final String[] DEFAULT_INCLUDES = new String[]{"**/**"};
private static final String[] DEFAULT_EXCLUDES = new String[]{"**/*Bean.class", "**/*CMP.class", "**/*Session.class", "**/package.html"}; private static final String[] DEFAULT_EXCLUDES = new String[]{"**/*Bean.class", "**/*CMP.class",
"**/*Session.class", "**/package.html"};
/** /**
* @todo File instead * The directory for the generated EJB.
*
* @parameter expression="${project.build.directory}" * @parameter expression="${project.build.directory}"
* @required * @required
* @readonly * @readonly
* @todo use File instead
*/ */
private String basedir; private String basedir;
/** /**
* Directory that resources are copied to during the build.
*
* @parameter expression="${project.build.outputDirectory}" * @parameter expression="${project.build.outputDirectory}"
* @required * @required
*/ */
private String outputDirectory; private String outputDirectory;
/** /**
* The name of the EJB file to generate.
*
* @parameter expression="${project.build.finalName}" * @parameter expression="${project.build.finalName}"
* @required * @required
* @deprecated "Please use the finalName element of build instead"
*/ */
private String jarName; private String jarName;
/** /**
* @todo boolean instead * Whether the ejb client jar should be generated or not. Default
* is false.
*
* @parameter * @parameter
* @todo boolean instead
*/ */
private String generateClient = Boolean.FALSE.toString(); private String generateClient = Boolean.FALSE.toString();
/** /**
* The maven project.
*
* @parameter expression="${project}" * @parameter expression="${project}"
* @required * @required
* @readonly * @readonly
@ -74,6 +89,8 @@ public class EjbMojo
private MavenProject project; private MavenProject project;
/** /**
* The maven project's helper.
*
* @parameter expression="${component.org.apache.maven.project.MavenProjectHelper}" * @parameter expression="${component.org.apache.maven.project.MavenProjectHelper}"
* @required * @required
* @readonly * @readonly
@ -81,11 +98,15 @@ public class EjbMojo
private MavenProjectHelper projectHelper; private MavenProjectHelper projectHelper;
/** /**
* The maven archiver to use.
*
* @parameter * @parameter
*/ */
private MavenArchiveConfiguration archive = new MavenArchiveConfiguration(); private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();
/** /**
* Generates an ejb jar and optionnaly an ejb-client jar.
*
* @todo Add license files in META-INF directory. * @todo Add license files in META-INF directory.
*/ */
public void execute() public void execute()