You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2010/03/21 19:16:40 UTC
svn commit: r925849 - in
/maven/archetype/trunk/archetype-common/src/main/mdo: archetype-catalog.mdo
archetype-descriptor.mdo
Author: hboutemy
Date: Sun Mar 21 18:16:40 2010
New Revision: 925849
URL: http://svn.apache.org/viewvc?rev=925849&view=rev
Log:
added some documentation in the descriptors to have better code generated (java, xdoc and xsd)
Modified:
maven/archetype/trunk/archetype-common/src/main/mdo/archetype-catalog.mdo
maven/archetype/trunk/archetype-common/src/main/mdo/archetype-descriptor.mdo
Modified: maven/archetype/trunk/archetype-common/src/main/mdo/archetype-catalog.mdo
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-common/src/main/mdo/archetype-catalog.mdo?rev=925849&r1=925848&r2=925849&view=diff
==============================================================================
--- maven/archetype/trunk/archetype-common/src/main/mdo/archetype-catalog.mdo (original)
+++ maven/archetype/trunk/archetype-common/src/main/mdo/archetype-catalog.mdo Sun Mar 21 18:16:40 2010
@@ -24,9 +24,14 @@
<id>archetype-catalog</id>
<name>ArchetypeCatalog</name>
<description>
- These are standard catalog files which contain information about Archetypes so that users
+ <![CDATA[
+ <p>This is a reference for the Archetype Catalog descriptor.</p>
+ <p>These are standard catalog files which contain information about Archetypes so that users
can be presented with a list of archetypes from any number of catalogs to generate new
- projects.
+ projects.</p>
+ <p>An XSD is available at
+ <a href="http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd">http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd</a>.
+ </p>]]>
</description>
<defaults>
@@ -46,6 +51,7 @@
<type>Archetype</type>
<multiplicity>*</multiplicity>
</association>
+ <description>List of Acthetypes available in this catalog.</description>
</field>
</fields>
<codeSegments>
@@ -62,31 +68,38 @@
<class>
<name>Archetype</name>
+ <description>Informations to point to an Archetype referenced in the catalog.</description>
<fields>
<field>
<name>groupId</name>
<type>String</type>
<required>true</required>
+ <description>The groupId of the archetype.</description>
</field>
<field>
<name>artifactId</name>
<type>String</type>
<required>true</required>
+ <description>The artifactId of the archetype.</description>
</field>
<field>
<name>version</name>
<type>String</type>
<required>true</required>
+ <description><![CDATA[The version of the archetype. <code>RELEASE</code> is a valid version.]]></description>
</field>
<field>
<name>repository</name>
<type>String</type>
- <required>true</required>
+ <required>false</required>
+ <description>The repository where to find the archetype.
+ When omitted, the archetype is searched for in the repository where the catalog comes from.</description>
</field>
<field>
<name>description</name>
<type>String</type>
- <required>true</required>
+ <required>false</required>
+ <description>The description of the archetype.</description>
</field>
<field>
<name>goals</name>
Modified: maven/archetype/trunk/archetype-common/src/main/mdo/archetype-descriptor.mdo
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-common/src/main/mdo/archetype-descriptor.mdo?rev=925849&r1=925848&r2=925849&view=diff
==============================================================================
--- maven/archetype/trunk/archetype-common/src/main/mdo/archetype-descriptor.mdo (original)
+++ maven/archetype/trunk/archetype-common/src/main/mdo/archetype-descriptor.mdo Sun Mar 21 18:16:40 2010
@@ -23,6 +23,15 @@
xml.schemaLocation="http://maven.apache.org/xsd/archetype-descriptor-${version}.xsd">
<id>archetype-descriptor</id>
<name>ArchetypeDescriptor</name>
+ <description>
+ <![CDATA[
+ <p>This is a reference for the Archetype descriptor used to describe archetypes's metadata.</p>
+ <p>The metadata about an archetype is stored in the <code>archetype-metadata.xml</code> file located
+ in the <code>META-INF/maven</code> directory of its jar file.</p>
+ <p>An XSD is available at
+ <a href="http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd</a>.
+ </p>]]>
+ </description>
<defaults>
<default>
@@ -40,14 +49,17 @@
<name>name</name>
<type>String</type>
<required>true</required>
+ <description>Name of the Archetype, that will be displayed ti the user when choosing an archetype.</description>
</field>
<field xml.attribute="true">
<name>partial</name>
<type>boolean</type>
<required>false</required>
+ <description>Is this archetype representing a full Maven 2 project or only parts?</description>
</field>
<field>
<name>requiredProperties</name>
+ <description>List of required properties to generated a project from this archetype.</description>
<association>
<type>RequiredProperty</type>
<multiplicity>*</multiplicity>
@@ -64,16 +76,19 @@
<name>id</name>
<type>String</type>
<required>true</required>
+ <description>The module artifactId.</description>
</field>
<field xml.attribute="true">
<name>dir</name>
<type>String</type>
<required>true</required>
+ <description>The modules' directory.</description>
</field>
<field xml.attribute="true">
<name>name</name>
<type>String</type>
<required>true</required>
+ <description>The modules' name.</description>
</field>
</fields>
</class>
@@ -88,6 +103,7 @@
<multiplicity>*</multiplicity>
</association>
<required>true</required>
+ <description>File sets definition.</description>
</field>
<field>
<name>modules</name>
@@ -96,32 +112,42 @@
<multiplicity>*</multiplicity>
</association>
<required>false</required>
+ <description>Modules definition.</description>
</field>
</fields>
</class>
<class>
<name>FileSet</name>
+ <description>A fileset defines the way the project's files located in the jar file are used by the Archetype Plugin to generate a project.</description>
<fields>
<field xml.attribute="true">
<name>filtered</name>
<type>boolean</type>
<required>false</required>
+ <description>Filesets can be filtered, which means the selected files will be used as Velocity templates.
+ They can be non-filtered, which means the selected files will be copied without modification.</description>
</field>
<field xml.attribute="true">
<name>packaged</name>
<type>boolean</type>
<required>false</required>
+ <description>Filesets can be packaged, which means the selected files will be generated/copied in a directory
+ structure that is prepended by the package property. They can be non-packaged, which means that the selected
+ files will be generated/copied without that prepend.</description>
</field>
<field xml.attribute="true">
<name>encoding</name>
<type>String</type>
<required>false</required>
+ <description>Encoding to use when filtering content.</description>
</field>
<field>
<name>directory</name>
<type>String</type>
<required>true</required>
+ <description>The directory where the files will be searched for, which is also the directory where the
+ project's files will be generated.</description>
</field>
<field>
<name>includes</name>
@@ -130,6 +156,7 @@
<multiplicity>*</multiplicity>
</association>
<required>false</required>
+ <description>Inclusion definition "Ã la" Ant.</description>
</field>
<field>
<name>excludes</name>
@@ -138,6 +165,7 @@
<multiplicity>*</multiplicity>
</association>
<required>false</required>
+ <description>Exclusion definition "Ã la" Ant.</description>
</field>
</fields>
<codeSegments>
@@ -164,16 +192,19 @@
<class>
<name>RequiredProperty</name>
+ <description>Definition of a proerty required when generating a project from this archetype.</description>
<fields>
<field xml.attribute="true">
<name>key</name>
<type>String</type>
<required>true</required>
+ <description>Key value of the property.</description>
</field>
<field>
<name>defaultValue</name>
<type>String</type>
<required>false</required>
+ <description>Default value of the property.</description>
</field>
</fields>
</class>