svn commit: r280096 - /maven/components/trunk/maven-plugins/maven-ejb-plugin/src/main/java/org/apache/maven/plugin/ejb/EjbMojo.java

[sn...@apache.org]

Author: snicoll
Date: Sun Sep 11 01:43:37 2005
New Revision: 280096

URL: http://svn.apache.org/viewcvs?rev=280096&view=rev
Log:
MNG-852: added Javadoc and parameter's documentation.

Modified:
    maven/components/trunk/maven-plugins/maven-ejb-plugin/src/main/java/org/apache/maven/plugin/ejb/EjbMojo.java

Modified: maven/components/trunk/maven-plugins/maven-ejb-plugin/src/main/java/org/apache/maven/plugin/ejb/EjbMojo.java
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-ejb-plugin/src/main/java/org/apache/maven/plugin/ejb/EjbMojo.java?rev=280096&r1=280095&r2=280096&view=diff
==============================================================================
--- maven/components/trunk/maven-plugins/maven-ejb-plugin/src/main/java/org/apache/maven/plugin/ejb/EjbMojo.java (original)
+++ maven/components/trunk/maven-plugins/maven-ejb-plugin/src/main/java/org/apache/maven/plugin/ejb/EjbMojo.java Sun Sep 11 01:43:37 2005
@@ -26,6 +26,8 @@
 import java.io.File;
 
 /**
+ * Build an EJB (and optional client) from the current project.
+ *
  * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
  * @version $Id$
  * @goal ejb
@@ -38,35 +40,48 @@
     // TODO: will null work instead?
     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}"
      * @required
      * @readonly
+     * @todo use File instead
      */
     private String basedir;
 
     /**
+     * Directory that resources are copied to during the build.
+     *
      * @parameter expression="${project.build.outputDirectory}"
      * @required
      */
     private String outputDirectory;
 
     /**
+     * The name of the EJB file to generate.
+     *
      * @parameter expression="${project.build.finalName}"
      * @required
+     * @deprecated "Please use the finalName element of build instead"
      */
     private String jarName;
 
     /**
-     * @todo boolean instead
+     * Whether the ejb client jar should be generated or not. Default
+     * is false.
+     *
      * @parameter
+     * @todo boolean instead
      */
     private String generateClient = Boolean.FALSE.toString();
 
     /**
+     * The maven project.
+     *
      * @parameter expression="${project}"
      * @required
      * @readonly
@@ -74,6 +89,8 @@
     private MavenProject project;
 
     /**
+     * The maven project's helper.
+     *
      * @parameter expression="${component.org.apache.maven.project.MavenProjectHelper}"
      * @required
      * @readonly
@@ -81,11 +98,15 @@
     private MavenProjectHelper projectHelper;
 
     /**
+     * The maven archiver to use.
+     *
      * @parameter
      */
     private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();
 
     /**
+     * Generates an ejb jar and optionnaly an ejb-client jar.
+     *
      * @todo Add license files in META-INF directory.
      */
     public void execute()



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org