maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject maven git commit: added default values in fields documentation
Date Sat, 05 Sep 2015 17:02:56 GMT
Repository: maven
Updated Branches:
  refs/heads/master f0cc5e8af -> e85e8cc98


added default values in fields documentation

Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/e85e8cc9
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/e85e8cc9
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/e85e8cc9

Branch: refs/heads/master
Commit: e85e8cc9818d8554437bf96f1de690622c18741c
Parents: f0cc5e8
Author: Hervé Boutemy <hboutemy@apache.org>
Authored: Sat Sep 5 19:02:46 2015 +0200
Committer: Hervé Boutemy <hboutemy@apache.org>
Committed: Sat Sep 5 19:02:46 2015 +0200

----------------------------------------------------------------------
 maven-model/src/main/mdo/maven.mdo | 56 +++++++++++++++++++++++----------
 1 file changed, 40 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/maven/blob/e85e8cc9/maven-model/src/main/mdo/maven.mdo
----------------------------------------------------------------------
diff --git a/maven-model/src/main/mdo/maven.mdo b/maven-model/src/main/mdo/maven.mdo
index 2821ea6..b74a38c 100644
--- a/maven-model/src/main/mdo/maven.mdo
+++ b/maven-model/src/main/mdo/maven.mdo
@@ -868,9 +868,12 @@
         <field>
           <name>resources</name>
           <version>3.0.0+</version>
-          <description>This element describes all of the classpath resources such as
properties
+          <description><![CDATA[
+            This element describes all of the classpath resources such as properties
             files associated with a project. These resources are often included in the final
-            package.</description>
+            package.
+            The default value is <code>src/main/resources</code>.]]>
+          </description>
           <association>
             <type>Resource</type>
             <multiplicity>*</multiplicity>
@@ -879,8 +882,11 @@
         <field>
           <name>testResources</name>
           <version>4.0.0+</version>
-          <description>This element describes all of the classpath resources such as
properties
-            files associated with a project's unit tests.</description>
+          <description><![CDATA[
+            This element describes all of the classpath resources such as properties
+            files associated with a project's unit tests.
+            The default value is <code>src/test/resources</code>.]]>
+          </description>
           <association>
             <type>Resource</type>
             <multiplicity>*</multiplicity>
@@ -889,7 +895,10 @@
         <field>
           <name>directory</name>
           <version>4.0.0+</version>
-          <description>The directory where all files generated by the build are placed.</description>
+          <description><![CDATA[
+            The directory where all files generated by the build are placed.
+            The default value is <code>target</code>.]]>
+          </description>
           <type>String</type>
         </field>
         <field>
@@ -922,6 +931,7 @@
       <description>
         <![CDATA[
         The <code>&lt;build&gt;</code> element contains informations
required to build the project.
+        Default values are defined in Super POM.
         ]]>
       </description>
       <fields>
@@ -937,19 +947,25 @@
           <name>sourceDirectory</name>
           <version>3.0.0+</version>
           <required>true</required>
-          <description>This element specifies a directory containing the source of
the project. The
-            generated build system will compile the source in this directory when the project
is
-            built. The path given is relative to the project descriptor.</description>
+          <description><![CDATA[
+            This element specifies a directory containing the source of the project. The
+            generated build system will compile the sources from this directory when the
project is
+            built. The path given is relative to the project descriptor.
+            The default value is <code>src/main/java</code>.]]>
+          </description>
           <type>String</type>
         </field>
         <field>
           <name>scriptSourceDirectory</name>
           <version>4.0.0+</version>
           <required>true</required>
-          <description>This element specifies a directory containing the script sources
of the
+          <description><![CDATA[
+            This element specifies a directory containing the script sources of the
             project. This directory is meant to be different from the sourceDirectory, in
that its
             contents will be copied to the output directory in most cases (since scripts
are
-            interpreted rather than compiled).</description>
+            interpreted rather than compiled).
+            The default value is <code>src/main/scripts</code>.]]>
+          </description>
           <type>String</type>
         </field>
         <field>
@@ -965,9 +981,12 @@
           <name>testSourceDirectory</name>
           <version>4.0.0+</version>
           <required>true</required>
-          <description>This element specifies a directory containing the unit test
source of the
+          <description><![CDATA[
+            This element specifies a directory containing the unit test source of the
             project. The generated build system will compile these directories when the project
is
-            being tested. The path given is relative to the project descriptor.</description>
+            being tested. The path given is relative to the project descriptor.
+            The default value is <code>src/test/java</code>.]]>
+          </description>
           <type>String</type>
         </field>
         <field>
@@ -1019,13 +1038,19 @@
         <field>
           <name>outputDirectory</name>
           <version>4.0.0+</version>
-          <description>The directory where compiled application classes are placed.</description>
+          <description><![CDATA[
+            The directory where compiled application classes are placed.
+            The default value is <code>target/classes</code>.]]>
+          </description>
           <type>String</type>
         </field>
         <field>
           <name>testOutputDirectory</name>
           <version>4.0.0+</version>
-          <description>The directory where compiled test classes are placed.</description>
+          <description><![CDATA[
+            The directory where compiled test classes are placed.
+            The default value is <code>target/test-classes</code>.]]>
+          </description>
           <type>String</type>
         </field>
         <field>
@@ -2978,8 +3003,7 @@
           <description>
             <![CDATA[
             Where to store all of the generated reports. The default is
-            <code>${project.build.directory}/site</code>
-            .
+            <code>${project.build.directory}/site</code>.
             ]]>
           </description>
           <!-- TODO: why isn't default set here? -->


Mime
View raw message