maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject [maven-ant-plugin] 11/48: o Improve documentation.
Date Wed, 20 Dec 2017 09:27:20 GMT
This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to annotated tag maven-ant-plugin-2.1
in repository https://gitbox.apache.org/repos/asf/maven-ant-plugin.git

commit 7898ccb23aeafa5c778acaff23efa422ba3bf76d
Author: Dennis Lundberg <dennisl@apache.org>
AuthorDate: Sun Jan 6 15:33:08 2008 +0000

    o Improve documentation.
    
    git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-ant-plugin@609329
13f79535-47bb-0310-9956-ffa450edef68
---
 .../java/org/apache/maven/plugin/ant/AntMojo.java  | 10 ++++----
 src/site/apt/examples/using.apt                    |  8 +++---
 src/site/apt/usage.apt                             | 30 +++++++++++++---------
 3 files changed, 27 insertions(+), 21 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugin/ant/AntMojo.java b/src/main/java/org/apache/maven/plugin/ant/AntMojo.java
index 6407fba..a93386b 100644
--- a/src/main/java/org/apache/maven/plugin/ant/AntMojo.java
+++ b/src/main/java/org/apache/maven/plugin/ant/AntMojo.java
@@ -51,21 +51,21 @@ public class AntMojo
     private MavenProject project;
 
     /**
-     * Used for resolving artifacts
+     * Used for resolving artifacts.
      *
      * @component
      */
     private ArtifactResolver resolver;
 
     /**
-     * Factory for creating artifact objects
+     * Factory for creating artifact objects.
      *
      * @component
      */
     private ArtifactFactory factory;
 
     /**
-     * The local repository where the artifacts are located
+     * The local repository where the artifacts are located.
      *
      * @parameter expression="${localRepository}"
      * @required
@@ -73,7 +73,7 @@ public class AntMojo
     private ArtifactRepository localRepository;
 
     /**
-     * The remote repositories where artifacts are located
+     * The remote repositories where artifacts are located.
      *
      * @parameter expression="${project.remoteArtifactRepositories}"
      */
@@ -89,7 +89,7 @@ public class AntMojo
     private Settings settings;
 
     /**
-     * Overwrite or not the <code>build.xml</code>
+     * Whether or not to overwrite the <code>build.xml</code> file.
      *
      * @parameter expression="${overwrite}" default-value="false"
      */
diff --git a/src/site/apt/examples/using.apt b/src/site/apt/examples/using.apt
index 430d356..d2af823 100644
--- a/src/site/apt/examples/using.apt
+++ b/src/site/apt/examples/using.apt
@@ -26,10 +26,10 @@
 
 Using generated Ant build files
 
- <<Note>>: You should update the <<<build.xml>>> and <<NOT>>
the <<<maven-build.xml>>>.
+ <<Note>>: If you want to add your own Ant targets, you should add them to <<<build.xml>>>
and <<NOT>> <<<maven-build.xml>>>.
 
- The <<<build.xml>>> uses the {{{http://ant.apache.org/manual/CoreTasks/import.html}import
task}} of Ant.
- So, you could overwrite generated targets in the <<<build.xml>>>. For
instance:
+ The <<<build.xml>>> file uses the {{{http://ant.apache.org/manual/CoreTasks/import.html}import
task}} of Ant.
+ So, you can override the generated targets in the <<<build.xml>>> file.
For instance:
 
 +-----+
 <?xml version="1.0" encoding="UTF-8"?>
@@ -55,7 +55,7 @@ Using generated Ant build files
   </target>
 
   <!-- ====================================================================== -->
-  <!-- Overwrite the jar target from maven-build.xml                          -->
+  <!-- Override the jar target from maven-build.xml                           -->
   <!-- ====================================================================== -->
 
   <target name="jar">
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index 07c8388..6459292 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -31,7 +31,7 @@ Usage
 
 * Generate Ant build files
 
- To generate files, you should execute the ant goal of the Ant Plugin, i.e.:
+ To generate files, you execute the <<<ant>>> goal of the Ant Plugin, i.e.:
 
 +-----+
 mvn ant:ant
@@ -41,14 +41,15 @@ mvn ant:ant
 
 +-----+
 yourProjectBaseDir
-  |-- build.xml
-  `-- maven-build.xml
-  `-- maven-build.properties
+|-- build.xml
+|-- maven-build.xml
+`-- maven-build.properties
 +-----+
 
 ** build.xml
 
- The <<<build.xml>>> is a generic Ant build file. It could be updated by
the user. Here is the out-of-box <<<build.xml>>>:
+ The <<<build.xml>>> file is a generic Ant build file. It can be updated
by the user.
+ Here is the out-of-box <<<build.xml>>>:
 
 +-----+
 <?xml version="1.0" encoding="UTF-8"?>
@@ -75,8 +76,9 @@ yourProjectBaseDir
 </project>
 +-----+
 
- <<Note>>: By default, the <<<build.xml>>> is not overwrited
when calling <<<mvn ant:ant>>>. If you want to overwrite it,
- you should execute the ant goal with the <<<overwrite>>> parameter, i.e.:
+ <<Note>>: By default, the <<<build.xml>>> file is not overwritten
when calling <<<mvn ant:ant>>>.
+ If you want to overwrite it,
+ you should execute the <<<ant>>> goal with the <<<overwrite>>>
parameter, i.e.:
 
 +-----+
 mvn ant:ant -Doverwrite=true
@@ -84,13 +86,17 @@ mvn ant:ant -Doverwrite=true
 
 ** maven-build.xml
 
- The <<<maven-build.xml>>> is an Ant build file for the Maven project.
It contains several targets to clean, compile,
- test, packaging the Ant project and the associated javadoc.
+ The <<<maven-build.xml>>> file is an Ant build file for your project.
It contains several targets to clean, compile,
+ test and package your project and also to create javadoc. To see which Ant targets are available
execute this command:
 
- <<Note>>: <<DO NOT EDIT maven-build.xml!>> It could be overwrite
when calling <<<mvn ant:ant>>>.
++-----+
+ant -projecthelp
++-----+
+
+ <<Note>>: <<DO NOT EDIT maven-build.xml!>> It will be overwritten
when calling <<<mvn ant:ant>>>.
 
 ** maven-build.properties
 
- The <<<maven-build.properties>>> contains several properties used by the
<<<maven-build.xml>>> build file.
+ The <<<maven-build.properties>>> file contains several properties used
by the <<<maven-build.xml>>> build file.
 
- <<Note>>: <<DO NOT EDIT maven-build.properties!>> It could be overwrite
when calling <<<mvn ant:ant>>>.
+ <<Note>>: <<DO NOT EDIT maven-build.properties!>> It will be overwritten
when calling <<<mvn ant:ant>>>.

-- 
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <commits@maven.apache.org>.

Mime
View raw message