Author: snicoll
Date: Tue Sep 20 12:22:03 2005
New Revision: 290534
URL: http://svn.apache.org/viewcvs?rev=290534&view=rev
Log:
PR: MNG-858
Submitted by: Allan Ramirez
Reviewed by: Stephane Nicoll
Documentation of Jar plugin
Added:
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/apt/
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/apt/howto.apt
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/site.xml
Modified:
maven/components/trunk/maven-plugins/maven-jar-plugin/src/main/java/org/apache/maven/plugin/jar/JarMojo.java
Modified:
maven/components/trunk/maven-plugins/maven-jar-plugin/src/main/java/org/apache/maven/plugin/jar/JarMojo.java
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-jar-plugin/src/main/java/org/apache/maven/plugin/jar/JarMojo.java?rev=290534&r1=290533&r2=290534&view=diff
==============================================================================
---
maven/components/trunk/maven-plugins/maven-jar-plugin/src/main/java/org/apache/maven/plugin/jar/JarMojo.java
(original)
+++
maven/components/trunk/maven-plugins/maven-jar-plugin/src/main/java/org/apache/maven/plugin/jar/JarMojo.java
Tue Sep 20 12:22:03 2005
@@ -25,6 +25,8 @@
import java.io.File;
/**
+ * Build a JAR from the current project.
+ *
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
* @goal jar
@@ -34,27 +36,33 @@
public class JarMojo
extends AbstractMojo
{
-
+
private static final String[] DEFAULT_EXCLUDES = new
String[]{"**/package.html"};
private static final String[] DEFAULT_INCLUDES = new String[]{"**/**"};
/**
- * @todo Change type to File
- *
+ * Directory containing the generated JAR.
+ *
* @parameter expression="${project.build.directory}"
* @required
* @readonly
+ *
+ * @todo Change type to File
*/
private String basedir;
/**
+ * Name of the generated JAR.
+ *
* @parameter alias="jarName" expression="${project.build.finalName}"
* @required
*/
private String finalName;
/**
+ * Directory containing the classes.
+ *
* @parameter expression="${project.build.outputDirectory}"
* @required
* @readonly
@@ -62,6 +70,8 @@
private String outputDirectory;
/**
+ * The maven project.
+ *
* @parameter expression="${project}"
* @required
* @readonly
@@ -69,11 +79,15 @@
private MavenProject project;
/**
+ * The maven archiver to use.
+ *
* @parameter
*/
private MavenArchiveConfiguration archive = new
MavenArchiveConfiguration();
/**
+ * Generates the JAR.
+ *
* @todo Add license files in META-INF directory.
*/
public void execute()
@@ -107,5 +121,4 @@
throw new MojoExecutionException( "Error assembling JAR", e );
}
}
-
}
Added:
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/apt/howto.apt
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/apt/howto.apt?rev=290534&view=auto
==============================================================================
---
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/apt/howto.apt
(added)
+++
maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/apt/howto.apt
Tue Sep 20 12:22:03 2005
@@ -0,0 +1,20 @@
+ ------
+ Maven 2 JAR Plugin
+ ------
+
+Maven 2 JAR Plugin
+
+ Builds your project into a jar
+
+*How to Use
+
+ If the packaging of your project is set to 'jar', this plugin is executed
+ whenever it passes the "package" phase. Have it executed
+ using the command below from your project:
+
+-------------------
+ m2 package
+-------------------
+
+ From your project's target directory you'll able to see the generated jar
file.
+
Added: maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/site.xml?rev=290534&view=auto
==============================================================================
--- maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/site.xml
(added)
+++ maven/components/trunk/maven-plugins/maven-jar-plugin/src/site/site.xml Tue
Sep 20 12:22:03 2005
@@ -0,0 +1,21 @@
+<project name="Maven JAR plugin">
+ <bannerLeft>
+ <name>Maven JAR plugin</name>
+ <src>http://maven.apache.org/images/apache-maven-project.png</src>
+ <href>http://maven.apache.org/</href>
+ </bannerLeft>
+ <bannerRight>
+ <src>http://maven.apache.org/images/maven-small.gif</src>
+ </bannerRight>
+ <body>
+ <links>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+ </links>
+
+ <menu name="Maven JAR Quickstart">
+ <item name="Overview" href="howto.html"/>
+ </menu>
+ ${reports}
+ </body>
+</project>
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
