You are viewing a plain text version of this content. The canonical link for it is here.
Posted to m2-dev@maven.apache.org by br...@apache.org on 2004/12/17 14:15:31 UTC
cvs commit: maven-components/maven-model maven.mdo
brett 2004/12/17 05:15:31
Modified: maven-model maven.mdo
Log:
add CDATAs to description
Revision Changes Path
1.64 +215 -212 maven-components/maven-model/maven.mdo
Index: maven.mdo
===================================================================
RCS file: /home/cvs/maven-components/maven-model/maven.mdo,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -r1.63 -r1.64
--- maven.mdo 3 Oct 2004 19:25:15 -0000 1.63
+++ maven.mdo 17 Dec 2004 13:15:30 -0000 1.64
@@ -15,11 +15,14 @@
|
| o annotation mechanism so that changes to the model can be accurately tracked.
|
+ | o need to clean up all the descriptions, matching anything to the current project-descriptor.xml file and
+ | improving on that
+ |
-->
<model>
<id>maven</id>
<name>Maven</name>
- <description>Maven's model for Java project.</description>
+ <description><![CDATA[Maven's model for Java project.]]></description>
<defaults>
<default>
<key>package</key>
@@ -34,17 +37,17 @@
<field>
<name>extend</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
The location of the parent project, if one exists. Values from the parent project will be
the default for this project if they are left unspecified.
The path may be absolute, or relative to the current project.xml file.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>parent</name>
<version>4.0.0</version>
- <description>Specified which project to extend.</description>
+ <description><![CDATA[Specified which project to extend.]]></description>
<association>
<type>Parent</type>
</association>
@@ -54,7 +57,7 @@
<name>modelVersion</name>
<version>4.0.0</version>
<required>true</required>
- <description>The version of this model you are using.</description>
+ <description><![CDATA[The version of this model you are using.]]></description>
<type>String</type>
</field>
<field>
@@ -67,29 +70,29 @@
<name>id</name>
<version>3.0.0</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The id of the project.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>groupId</name>
<version>3.0.0+</version>
<required>true</required>
- <description>The primary grouping for your project.</description>
+ <description><![CDATA[The primary grouping for your project.]]></description>
<type>String</type>
</field>
<field>
<name>artifactId</name>
<version>3.0.0+</version>
<required>true</required>
- <description>The identifier used when generating the artifact for your project.</description>
+ <description><![CDATA[The identifier used when generating the artifact for your project.]]></description>
<type>String</type>
</field>
<field>
<name>type</name>
<version>4.0.0</version>
- <description>The type of artifact this project produces.</description>
+ <description><![CDATA[The type of artifact this project produces.]]></description>
<type>String</type>
<defaultValue>jar</defaultValue>
</field>
@@ -97,7 +100,7 @@
<name>name</name>
<version>3.0.0+</version>
<required>true</required>
- <description>Human readable name of the project.</description>
+ <description><![CDATA[Human readable name of the project.]]></description>
<type>String</type>
</field>
<field>
@@ -110,50 +113,50 @@
<name>version</name>
<version>4.0.0</version>
<required>true</required>
- <description>The current version of the project.</description>
+ <description><![CDATA[The current version of the project.]]></description>
<type>String</type>
</field>
<field>
<name>shortDescription</name>
<version>3.0.0+</version>
- <description>An abbreviated description of the project.</description>
+ <description><![CDATA[An abbreviated description of the project.]]></description>
<type>String</type>
</field>
<field>
<name>description</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
A detailed description of the project. This element is
usually specified as CDATA to enable the use of HTML tags
within the description. This description is used to
generate the
<a href="plugins/site/index.html">front page</a>
of the project's web site.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0+</version>
- <description>The URL where the project can be found.</description>
+ <description><![CDATA[The URL where the project can be found.]]></description>
<type>String</type>
</field>
<field>
<name>logo</name>
<version>3.0.0+</version>
- <description>The logo for the project.</description>
+ <description><![CDATA[The logo for the project.]]></description>
<type>String</type>
</field>
<field>
<name>issueTrackingUrl</name>
<version>3.0.0</version>
- <description>The URL where the issue tracking system used by the project can be found.</description>
+ <description><![CDATA[The URL where the issue tracking system used by the project can be found.]]></description>
<type>String</type>
</field>
<field>
<name>issueManagement</name>
<version>4.0.0</version>
- <description>The project's issue management information.</description>
+ <description><![CDATA[The project's issue management information.]]></description>
<association>
<type>IssueManagement</type>
</association>
@@ -161,7 +164,7 @@
<field>
<name>ciManagement</name>
<version>4.0.0</version>
- <description>The project's continuous integration management information.</description>
+ <description><![CDATA[The project's continuous integration management information.]]></description>
<association>
<type>CiManagement</type>
</association>
@@ -170,45 +173,45 @@
<name>inceptionYear</name>
<version>3.0.0+</version>
<required>true</required>
- <description>The year the project started.</description>
+ <description><![CDATA[The year the project started.]]></description>
<type>String</type>
</field>
<field>
<name>gumpRepositoryId</name>
<version>3.0.0</version>
- <description>Hint for the gump continuous integration build system.</description>
+ <description><![CDATA[Hint for the gump continuous integration build system.]]></description>
<type>String</type>
</field>
<field>
<name>siteAddress</name>
<version>3.0.0</version>
- <description>The FQDN of the host where the project's site is uploaded.</description>
+ <description><![CDATA[The FQDN of the host where the project's site is uploaded.]]></description>
<type>String</type>
</field>
<field>
<name>siteDirectory</name>
<version>3.0.0</version>
- <description>The directory on the site host where site documentation is placed when the site is uploaded.</description>
+ <description><![CDATA[The directory on the site host where site documentation is placed when the site is uploaded.]]></description>
<type>String</type>
</field>
<field>
<name>distributionSite</name>
<version>3.0.0</version>
- <description>The FQDN of the host where the project's artifacts are uploaded.</description>
+ <description><![CDATA[The FQDN of the host where the project's artifacts are uploaded.]]></description>
<type>String</type>
<comment>This naming is inconsistent and distribution should occur from a repository structure.</comment>
</field>
<field>
<name>distributionDirectory</name>
<version>3.0.0</version>
- <description>The directory on the distribution host where artifacts are placed when uploaded.</description>
+ <description><![CDATA[The directory on the distribution host where artifacts are placed when uploaded.]]></description>
<type>String</type>
<comment>This naming is inconsistent and distribution should occur from a repository structure.</comment>
</field>
<field>
<name>repositories</name>
<version>4.0.0</version>
- <description>The lists of the remote repositories</description>
+ <description><![CDATA[The lists of the remote repositories]]></description>
<association>
<type>Repository</type>
<multiplicity>*</multiplicity>
@@ -217,7 +220,7 @@
<field>
<name>pluginRepositories</name>
<version>4.0.0</version>
- <description>The lists of the remote repositories for discovering plugins</description>
+ <description><![CDATA[The lists of the remote repositories for discovering plugins]]></description>
<association>
<type>Repository</type>
<multiplicity>*</multiplicity>
@@ -227,7 +230,7 @@
<field>
<name>plugins</name>
<version>4.0.0</version>
- <description>Plugin declarations and configuration.</description>
+ <description><![CDATA[Plugin declarations and configuration.]]></description>
<association>
<type>Plugin</type>
<multiplicity>*</multiplicity>
@@ -236,7 +239,7 @@
<field>
<name>mailingLists</name>
<version>3.0.0+</version>
- <description>The mailing lists for the project.</description>
+ <description><![CDATA[The mailing lists for the project.]]></description>
<association>
<type>MailingList</type>
<multiplicity>*</multiplicity>
@@ -245,13 +248,13 @@
<field>
<name>developers</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes all of the developers associated with a
project. Each developer is described by a
<code>developer</code> element, which is then described by
additional elements (described below). The auto-generated site
documentation references this information.
- </description>
+ ]]></description>
<association>
<type>Developer</type>
<multiplicity>*</multiplicity>
@@ -260,13 +263,13 @@
<field>
<name>contributors</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes all of the contributors associated with a
project who are not developers. Each contributor is described by a
<code>contributor</code> element, which is then describe by additional
elements (described below). The auto-generated site documentation
references this information.
- </description>
+ ]]></description>
<association>
<type>Contributor</type>
<multiplicity>*</multiplicity>
@@ -275,12 +278,12 @@
<field>
<name>dependencies</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes all of the dependencies associated with a
project. Each dependency is described by a
<code>dependency</code> element, which is then described by
additional elements (described below).
- </description>
+ ]]></description>
<association>
<type>Dependency</type>
<multiplicity>*</multiplicity>
@@ -290,12 +293,12 @@
<field>
<name>overrides</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
This element describes all of the dependency overrides for a
project. Each dependency is described by a
<code>override</code> element, which is then described by
additional elements (described below).
- </description>
+ ]]></description>
<association>
<type>Override</type>
<multiplicity>*</multiplicity>
@@ -304,13 +307,13 @@
<field>
<name>licenses</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes all of the licenses for this project. Each license is described by a
<code>license</code> element, which is then describe by additional
elements (described below). The auto-generated site documentation
references this information. Projects should only list the license(s) that
applies to the project and not the licenses that apply to dependencies.
- </description>
+ ]]></description>
<association>
<type>License</type>
<multiplicity>*</multiplicity>
@@ -319,7 +322,7 @@
<field>
<name>versions</name>
<version>3.0.0</version>
- <description>The released versions of the project.</description>
+ <description><![CDATA[The released versions of the project.]]></description>
<association>
<type>Version</type>
<multiplicity>*</multiplicity>
@@ -328,7 +331,7 @@
<field>
<name>branches</name>
<version>3.0.0</version>
- <description>The SCM branches create for the project.</description>
+ <description><![CDATA[The SCM branches create for the project.]]></description>
<association>
<type>Branch</type>
<multiplicity>*</multiplicity>
@@ -337,7 +340,7 @@
<field>
<name>packageGroups</name>
<version>3.0.0+</version>
- <description>Package groups required for complete javadocs.</description>
+ <description><![CDATA[Package groups required for complete javadocs.]]></description>
<association>
<type>PackageGroup</type>
<multiplicity>*</multiplicity>
@@ -346,14 +349,14 @@
<field>
<name>reports</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element includes the specification of reports to be
included in a Maven-generated site. These reports will be run
when a user executes
<code>maven site</code>. All of the
reports will be included in the navigation bar for browsing in
the order they are specified.
- </description>
+ ]]></description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
@@ -362,7 +365,7 @@
<field>
<name>scm</name>
<version>4.0.0</version>
- <description>Specification for the SCM use by the project.</description>
+ <description><![CDATA[Specification for the SCM use by the project.]]></description>
<association>
<type>Scm</type>
</association>
@@ -370,7 +373,7 @@
<field>
<name>repository</name>
<version>3.0.0</version>
- <description>Specification for the SCM use by the project.</description>
+ <description><![CDATA[Specification for the SCM use by the project.]]></description>
<association>
<type>Repository</type>
</association>
@@ -380,7 +383,7 @@
<name>build</name>
<version>3.0.0+</version>
<required>true</required>
- <description>Information required to build the project.</description>
+ <description><![CDATA[Information required to build the project.]]></description>
<association>
<type>Build</type>
</association>
@@ -388,11 +391,11 @@
<field>
<name>organization</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes various attributes of the organziation to
which the project belongs. These attributes are utilized when
documentation is created (for copyright notices and links).
- </description>
+ ]]></description>
<association>
<type>Organization</type>
</association>
@@ -400,7 +403,7 @@
<field>
<name>distributionManagement</name>
<version>4.0.0</version>
- <description>Distribution information for a project.</description>
+ <description><![CDATA[Distribution information for a project.]]></description>
<association>
<type>DistributionManagement</type>
</association>
@@ -409,7 +412,7 @@
<name>local</name>
<version>4.0.0</version>
<required>false</required>
- <description>Local configuration information.</description>
+ <description><![CDATA[Local configuration information.]]></description>
<association>
<type>Local</type>
</association>
@@ -419,10 +422,10 @@
<field>
<name>properties</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
Properties about the project. This allows you to configure your project and the
plugins it uses.
- </description>
+ ]]></description>
<type>Properties</type>
<association xml.mapStyle="inline">
<type>String</type>
@@ -432,7 +435,7 @@
<field>
<name>preGoals</name>
<version>4.0.0</version>
- <description>Set of decorator(s) injected before the target goal(s).</description>
+ <description><![CDATA[Set of decorator(s) injected before the target goal(s).]]></description>
<association>
<type>PreGoal</type>
<multiplicity>*</multiplicity>
@@ -441,7 +444,7 @@
<field>
<name>postGoals</name>
<version>4.0.0</version>
- <description>Set of decorator(s) injected after the target goal(s).</description>
+ <description><![CDATA[Set of decorator(s) injected after the target goal(s).]]></description>
<association>
<type>PostGoal</type>
<multiplicity>*</multiplicity>
@@ -506,41 +509,41 @@
<class>
<name>Branch</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes each of the branches of the
project. Each branch is described by a
<code>tag</code>
element
- </description>
+ ]]></description>
<fields>
<field>
<name>tag</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The branch tag in the version control system
(e.g. cvs) used by the project for the source
code associated with this branch of the
project.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>description</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
A description of the branch and its strategy.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>lastMergeTag</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
This is the tag in the version control system that was last used
to merge from the branch to the current codebase. Future merges
should merge only the changes from this tag to the next.
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -552,14 +555,14 @@
<field>
<name>nagEmailAddress</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
An address to which notifications regarding the status of builds
for this project can be sent. This is intended for use by tools
which do unattended builds, for example those providing for
continuous integration. Currently this is used by the
<a href="build-file.html#maven:gump-descriptor">maven:gump-descriptor</a>
target.
- </description>
+ ]]></description>
<type>String</type>
<comment>This should be moved out of the build section. Vestigal for use with Gump.</comment>
</field>
@@ -567,31 +570,31 @@
<name>sourceDirectory</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <description><![CDATA[
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>
<type>String</type>
</field>
<field>
<name>unitTestSourceDirectory</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <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 unit tests must use the JUnit test framework.
The path given is relative to the project descriptor.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>aspectSourceDirectory</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element specifies a directory containing Aspect
sources of the project. The generated build system will
compile the Aspects in this directory when the project is
@@ -599,30 +602,30 @@
<a
href="plugins/aspectj/goals.html">Aspectj goals</a> document).
The path given is relative to the project descriptor.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>integrationUnitTestSourceDirectory</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element specifies a directory containing integration test
sources of the project.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>sourceModifications</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <description><![CDATA[
This element describes all of the sourceModifications associated with a
project. Each source modification is described by a
<code>sourceModification</code> element, which is then described by
additional elements (described below). These modifications are used
to exclude or include various source depending on the environment
the build is running in.
- </description>
+ ]]></description>
<association>
<type>SourceModification</type>
<multiplicity>*</multiplicity>
@@ -632,7 +635,7 @@
<name>unitTest</name>
<version>3.0.0+</version>
<required>true</required>
- <description>This element specifies unit tests associated with the project.</description>
+ <description><![CDATA[This element specifies unit tests associated with the project.]]></description>
<defaultValue>new UnitTest()</defaultValue>
<association>
<type>UnitTest</type>
@@ -641,13 +644,13 @@
<field>
<name>resources</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes all of the resources associated with a project or unit tests.
Each resource is described by a resource element, which is then described by additional
elements (described
<a href="#resource">below</a>). These resources are used to
complete the jar file or to run unit test.
- </description>
+ ]]></description>
<association>
<type>Resource</type>
<multiplicity>*</multiplicity>
@@ -656,35 +659,35 @@
<field>
<name>directory</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The directory where all generated by the build is placed.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>output</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The directory where compiled application classes are placed.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>finalName</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The filename (including an extension, but with no path information) that the produced artifact
will be called. The default value is artifactId-version.extension (where extension is derived from
type).
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>testOutput</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The directory where compiled test classes are placed.
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -696,19 +699,19 @@
<field>
<name>system</name>
<version>4.0.0</version>
- <description>The name of the continuous integration system i.e. Bugzilla</description>
+ <description><![CDATA[The name of the continuous integration system i.e. Bugzilla]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>4.0.0</version>
- <description>Url for the continuous integration system use by the project.</description>
+ <description><![CDATA[Url for the continuous integration system use by the project.]]></description>
<type>String</type>
</field>
<field>
<name>nagEmailAddress</name>
<version>4.0.0</version>
- <description>Email address for the party to be notified on unsuccessful builds.</description>
+ <description><![CDATA[Email address for the party to be notified on unsuccessful builds.]]></description>
<type>String</type>
</field>
</fields>
@@ -720,36 +723,36 @@
<field>
<name>name</name>
<version>3.0.0+</version>
- <description>The full name of the contributor.</description>
+ <description><![CDATA[The full name of the contributor.]]></description>
<type>String</type>
</field>
<field>
<name>email</name>
<version>3.0.0+</version>
- <description>The email address of the contributor.</description>
+ <description><![CDATA[The email address of the contributor.]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0+</version>
- <description>The URL for the homepage of the contributor.</description>
+ <description><![CDATA[The URL for the homepage of the contributor.]]></description>
<type>String</type>
</field>
<field>
<name>organization</name>
<version>3.0.0+</version>
- <description>The organization to which the contributor belongs.</description>
+ <description><![CDATA[The organization to which the contributor belongs.]]></description>
<type>String</type>
</field>
<field>
<name>roles</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
The roles the contributor plays in the project. Each role is
describe by a
<code>role</code> element, the body of which is a
role name.
- </description>
+ ]]></description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
@@ -758,9 +761,9 @@
<field>
<name>timezone</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
The timezone the contributor is in. This is a number in the range -14 to 14.
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -773,85 +776,85 @@
<name>id</name>
<version>3.0.0</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The id of the project.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>groupId</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The project group that produced the dependency, e.g.
<code>geronimo</code>.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>artifactId</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The unique id for an artifact produced by the project group, e.g.
<code>germonimo-jms</code>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>version</name>
<version>3.0.0+</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The version of the dependency., e.g.
<code>3.2.1</code>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This url will be provided to the user if the jar file cannot be downloaded
from the central repository.
- </description>
+ ]]></description>
<type>String</type>
<comment>The URL should really be gleaned from a shared database of dependency information.</comment>
</field>
<field>
<name>jar</name>
<version>3.0.0</version>
- <description>Literal name of the artifact.</description>
+ <description><![CDATA[Literal name of the artifact.]]></description>
<type>String</type>
</field>
<field>
<name>artifact</name>
<version>4.0.0+</version>
- <description>Literal name of the artifact</description>
+ <description><![CDATA[Literal name of the artifact]]></description>
<type>String</type>
</field>
<field>
<name>type</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
Other known recognised dependency types are:
<code>ejb</code> and
<code>plugin</code>.
- </description>
+ ]]></description>
<type>String</type>
<defaultValue>jar</defaultValue>
</field>
<field>
<name>properties</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
Properties about the dependency. Various plugins allow you to
<code>mark</code> dependencies with properties. For example the
<a href="plugins/war/index.html">war</a> plugin looks for a
<code>war.bundle</code> property, and if found will include the dependency
in
<code>WEB-INF/lib</code>. For example syntax, check the war plugin docs.
- </description>
+ ]]></description>
<type>Properties</type>
<association xml.mapStyle="inline">
<type>String</type>
@@ -956,30 +959,30 @@
<name>groupId</name>
<version>4.0.0</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The project group that produced the dependency, e.g.
<code>geronimo</code>.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>artifactId</name>
<version>4.0.0</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The unique id for an artifact produced by the project group, e.g.
<code>germonimo-jms</code>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>type</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Other known recognised dependency types are:
<code>ejb</code> and
<code>plugin</code>.
- </description>
+ ]]></description>
<type>String</type>
<defaultValue>jar</defaultValue>
</field>
@@ -988,20 +991,20 @@
<name>version</name>
<version>4.0.0</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The version of the dependency., e.g.
<code>3.2.1</code>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>file</name>
<version>4.0.0</version>
<required>true</required>
- <description>
+ <description><![CDATA[
The filename of the dependency that will be used to override the one from the repository, e.g.
<code>lib/non-distributable-code-1.3.jar</code>
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -1014,7 +1017,7 @@
<field>
<name>id</name>
<version>3.0.0+</version>
- <description>The username of the developer.</description>
+ <description><![CDATA[The username of the developer.]]></description>
<type>String</type>
</field>
</fields>
@@ -1026,13 +1029,13 @@
<field>
<name>system</name>
<version>4.0.0</version>
- <description>The name of the issue management system i.e. Bugzilla</description>
+ <description><![CDATA[The name of the issue management system i.e. Bugzilla]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>4.0.0</version>
- <description>Url for the issue management system use by the project.</description>
+ <description><![CDATA[Url for the issue management system use by the project.]]></description>
<type>String</type>
</field>
</fields>
@@ -1040,21 +1043,21 @@
<class>
<name>DistributionManagement</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
This elements describes all that pertains to distribution for a project.
- </description>
+ ]]></description>
<fields>
<field>
<name>repository</name>
<version>4.0.0</version>
- <description>Information needed for deploying to remote repository artifacts generated by the project</description>
+ <description><![CDATA[Information needed for deploying to remote repository artifacts generated by the project]]></description>
<association>
<type>Repository</type>
</association>
</field>
<field>
<name>site</name>
- <description>Information needed for deploying website files of the project.</description>
+ <description><![CDATA[Information needed for deploying website files of the project.]]></description>
<version>4.0.0</version>
<association>
<type>Site</type>
@@ -1069,19 +1072,19 @@
<field>
<name>name</name>
<version>3.0.0+</version>
- <description>The full legal name of the license.</description>
+ <description><![CDATA[The full legal name of the license.]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0+</version>
- <description>The official url for the license text.</description>
+ <description><![CDATA[The official url for the license text.]]></description>
<type>String</type>
</field>
<field>
<name>distribution</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
The primary method by which this project may be distributed.
<dl>
<dt>repo</dt>
@@ -1089,13 +1092,13 @@
<dt>manual</dt>
<dd>user must manually download and install the dependency.</dd>
</dl>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>comments</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<type>String</type>
</field>
</fields>
@@ -1103,64 +1106,64 @@
<class>
<name>MailingList</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
This element describes all of the mailing lists associated with
a project. Each mailing list is described by a
<code>mailingList</code> element, which is then described by
additional elements (described below). The auto-generated site
documentation references this information.
- </description>
+ ]]></description>
<fields>
<field>
<name>name</name>
<version>3.0.0+</version>
- <description>The name of the mailing list.</description>
+ <description><![CDATA[The name of the mailing list.]]></description>
<type>String</type>
</field>
<field>
<name>subscribe</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
The email address or link that can be used to subscribe to the mailing list.
If this is an email address, a
<code>mailto:</code> link will automatically be created when
the documentation is created.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>unsubscribe</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
The email address or link that can be used to unsubscribe to
the mailing list. If this is an email address, a
<code>mailto:</code> link will automatically be created
when the documentation is created.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>post</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The email address or link that can be used to post to
the mailing list. If this is an email address, a
<code>mailto:</code> link will automatically be created
when the documentation is created.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>archive</name>
<version>3.0.0+</version>
- <description>The link to a URL where you can browse the archive.</description>
+ <description><![CDATA[The link to a URL where you can browse the archive.]]></description>
<type>String</type>
<comment>This should probably be removed from 4.0.0 before alpha-1</comment>
</field>
<field>
<name>archives</name>
<version>4.0.0</version>
- <description>The link to a URL where you can browse the archive.</description>
+ <description><![CDATA[The link to a URL where you can browse the archive.]]></description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
@@ -1181,19 +1184,19 @@
<field>
<name>name</name>
<version>3.0.0+</version>
- <description>The full name of the organization.</description>
+ <description><![CDATA[The full name of the organization.]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0+</version>
- <description>The URL to the organization's home page.</description>
+ <description><![CDATA[The URL to the organization's home page.]]></description>
<type>String</type>
</field>
<field>
<name>logo</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
The URL to the organization's logo image. This can be an URL relative
to the base directory of the generated web site,
(e.g.,
@@ -1201,7 +1204,7 @@
(e.g.,
<code>http://my.corp/logo.png</code>). This value is used
when generating the project documentation.
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -1213,13 +1216,13 @@
<field>
<name>title</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<type>String</type>
</field>
<field>
<name>packages</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<type>String</type>
</field>
</fields>
@@ -1231,7 +1234,7 @@
<field>
<name>includes</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
@@ -1240,7 +1243,7 @@
<field>
<name>excludes</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
@@ -1292,19 +1295,19 @@
<field>
<name>artifactId</name>
<version>4.0.0</version>
- <description>The artifact id of the project to extend.</description>
+ <description><![CDATA[The artifact id of the project to extend.]]></description>
<type>String</type>
</field>
<field>
<name>groupId</name>
<version>4.0.0</version>
- <description>The group id of the project to extend.</description>
+ <description><![CDATA[The group id of the project to extend.]]></description>
<type>String</type>
</field>
<field>
<name>version</name>
<version>4.0.0</version>
- <description>The versi>on of the project to extend.</description>
+ <description><![CDATA[The versi>on of the project to extend.]]></description>
<type>String</type>
</field>
</fields>
@@ -1316,29 +1319,29 @@
<field>
<name>connection</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
The source configuration management system URL
that describes the repository and how to connect to the
repository. This is used by Maven when
<a
href="plugins/dist/index.html">building versions</a>
from specific ID.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>developerConnection</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
Just like connection, but for developers, i.e. this scm connection
will not be read only.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>3.0.0</version>
- <description>The URL to the project's browsable CVS repository.</description>
+ <description><![CDATA[The URL to the project's browsable CVS repository.]]></description>
<type>String</type>
</field>
</fields>
@@ -1350,35 +1353,35 @@
<field>
<name>connection</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The source configuration management system URL
that describes the repository and how to connect to the
repository. This is used by Maven when
<a
href="plugins/dist/index.html">building versions</a>
from specific ID.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>developerConnection</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Just like connection, but for developers, i.e. this scm connection
will not be read only.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>4.0.0</version>
- <description>The URL to the project's browsable CVS repository.</description>
+ <description><![CDATA[The URL to the project's browsable CVS repository.]]></description>
<type>String</type>
</field>
<field>
<name>branches</name>
<version>4.0.0</version>
- <description>The SCM branches that are currently active for the project. These should only be those forked from the current branch or trunk that are intended to be used.</description>
+ <description><![CDATA[The SCM branches that are currently active for the project. These should only be those forked from the current branch or trunk that are intended to be used.]]></description>
<association>
<type>String</type>
<multiplicity>*</multiplicity>
@@ -1394,28 +1397,28 @@
<field>
<name>directory</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
Describe the directory where the resource is stored.
The path may be absolute, or relative to the project.xml file.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>targetPath</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
Describe the resource target path. For example, if you want that resource
appear into a specific package (
<code>org.apache.maven.messages</code>), you must specify this
element with this value :
<code>org/apache/maven/messages</code>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>filtering</name>
<version>3.0.0+</version>
- <description>Describe if resources are filtered or not.</description>
+ <description><![CDATA[Describe if resources are filtered or not.]]></description>
<type>boolean</type>
<defaultValue>false</defaultValue>
</field>
@@ -1429,19 +1432,19 @@
<field>
<name>className</name>
<version>3.0.0+</version>
- <description>
+ <description><![CDATA[
If the class with this name can
<strong>not</strong> be
loaded, then the includes and excludes specified below
will be applied to the contents of the
<a href="#sourceDirectory">sourceDirectory</a>
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>property</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<type>String</type>
</field>
</fields>
@@ -1454,7 +1457,7 @@
<field>
<name>resources</name>
<version>3.0.0+</version>
- <description>the description</description>
+ <description><![CDATA[the description]]></description>
<association>
<type>Resource</type>
<multiplicity>*</multiplicity>
@@ -1465,44 +1468,44 @@
<class>
<name>Version</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
This element describes each of the previous versions of the
project. Each version is described by a
<code>version</code>
element
- </description>
+ ]]></description>
<fields>
<field>
<name>name</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
The external version number under which this release was distributed. Examples include:
<code>1.0</code>,
<code>1.1-alpha1</code>,
<code>1.2-beta</code>,
<code>1.3.2</code> etc.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>tag</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
The name given in the version control system (e.g. cvs) used by the project for the source
code associated with this version of the project.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>id</name>
<version>3.0.0</version>
- <description>
+ <description><![CDATA[
A unique identifier for a version. This ID is
used to specify the version that
<a href="plugins/dist/index.html">
<code>maven:dist</code>
</a> builds.
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -1511,33 +1514,33 @@
<class>
<name>Repository</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Repository contains the information needed
for establishing connections with remote repoistory
- </description>
+ ]]></description>
<fields>
<field>
<name>id</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
A unique identifier for a repository.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>name</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Human readable name of the repository
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The url of of the repository
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -1566,33 +1569,33 @@
<class>
<name>Site</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Site contains the information needed
for deploying websites.
- </description>
+ ]]></description>
<fields>
<field>
<name>id</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
A unique identifier for a deployment locataion.
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>name</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Human readable name of the deployment location
- </description>
+ ]]></description>
<type>String</type>
</field>
<field>
<name>url</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The url of of the location where website is deployed
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -1604,15 +1607,15 @@
<field>
<name>name</name>
<version>4.0.0</version>
- <description>The target goal which should be decorated.</description>
+ <description><![CDATA[The target goal which should be decorated.]]></description>
<type>String</type>
</field>
<field>
<name>attain</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The goal which should be injected into the execution chain.
- </description>
+ ]]></description>
<type>String</type>
</field>
</fields>
@@ -1676,7 +1679,7 @@
<name>version</name>
<version>4.0.0</version>
<required>true</required>
- <description>The version of the plugin to be used.</description>
+ <description><![CDATA[The version of the plugin to be used.]]></description>
<type>String</type>
</field>
<field>
@@ -1722,29 +1725,29 @@
<class>
<name>Local</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Local contains the information that is specific to the user's
local environment. This would only be expected in a user or site pom,
not a project POM.
- </description>
+ ]]></description>
<fields>
<!-- @todo should local repository actually be part of the <repositories/> element, or be of repository type? -->
<field>
<name>repository</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
The local repository that contains downloaded artifacts.
- </description>
+ ]]></description>
<type>String</type>
<!-- @todo systemProperty tag (maven.repo.local value) should be supported by modello -->
</field>
<field>
<name>online</name>
<version>4.0.0</version>
- <description>
+ <description><![CDATA[
Whether to run the build online. If not, no remote repositories are consulted for plugins or dependencies
and this configuration may be used by other plugins requiring online access.
- </description>
+ ]]></description>
<type>boolean</type>
<defaultValue>true</defaultValue>
<!-- @todo systemProperty tag (maven.online value) should be supported by modello -->