Update of /cvsroot/xdoclet/xdoclet/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27670/xdocs
Modified Files:
maven-plugin.xml
Log Message:
Update docs for maven plugin a bit.
Index: maven-plugin.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/xdocs/maven-plugin.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** maven-plugin.xml 12 Nov 2003 01:02:51 -0000 1.6
--- maven-plugin.xml 3 Feb 2004 04:27:47 -0000 1.7
***************
*** 27,54 ****
<subsection name="How-to">
<p>
! 1. In order to use the XDoclet plug-in, you have to declare the
necessary XDoclet-module jar
! files in your project.xml. So if you want to use ejbdoclet with
jboss, you should do:
</p>
<source><![CDATA[
<dependencies>
<dependency>
! <id>xdoclet+ejb-module</id>
! <version>1.2b2</version>
</dependency>
<dependency>
! <id>xdoclet+jboss-module</id>
! <version>1.2b2</version>
</dependency>
<!-- This one is needed because jboss-module depends on it -->
<dependency>
! <id>xdoclet+jmx-module</id>
! <version>1.2b2</version>
</dependency>
<dependency>
! <id>ejb</id>
! <version>2.0</version>
</dependency>
</dependencies>]]></source>
--- 27,60 ----
<subsection name="How-to">
<p>
! 1. XDoclet has a lot of modules. So in order to keep the load
time optimized to individual
! installations, you have to declare the necessary XDoclet-module
jar
! files in your project.xml. Just include everything here as if
you would with the classpath
! in a build.xml for Ant. So if you want to use ejbdoclet with
jboss, you should do:
</p>
<source><![CDATA[
<dependencies>
<dependency>
! <groupId>xdoclet</groupId>
! <artifactId>xdoclet-ejb-module</artifactId>
! <version>1.2</version>
</dependency>
<dependency>
! <groupId>xdoclet</groupId>
! <artifactId>xdoclet-jboss-module</artifactId>
! <version>1.2</version>
</dependency>
<!-- This one is needed because jboss-module depends on it -->
<dependency>
! <groupId>xdoclet</groupId>
! <artifactId>xdoclet-jmx-module</artifactId>
! <version>1.2</version>
</dependency>
<dependency>
! <groupId>jboss</groupId>
! <artifactId>jboss-j2ee</artifactId>
! <version>3.2.1</version>
</dependency>
</dependencies>]]></source>
***************
*** 67,71 ****
<p>
3. Now how does XDoclet know you want to run remoteinterface
subtask or what is the remote interface class pattern?
! Well, you need to define some properties, but some properties
have defaults. For example, by default ejbdoclet has these defaults defined in its
plugin.properties file:
</p>
<source><![CDATA[
--- 73,78 ----
<p>
3. Now how does XDoclet know you want to run remoteinterface
subtask or what is the remote interface class pattern?
! Well, you need to define some properties, but some properties
have defaults. These defaults are important to understand,
! please go to the plugin.properties file and review them now.
For example, by default ejbdoclet has these defaults defined in its plugin.properties
file:
</p>
<source><![CDATA[
***************
*** 90,99 ****
<p>
So by default the destDir is target/xdoclet/ejbdoclet and all
classes ending with "Bean" are processed.
! The entitybmp, entitycmp, etc subtasks are run. Basically for
any task or subtask parameter you find
! in XDoclet documentation there's a counterpart in the maven
plug-in too. The destDir parameter of
ejbdoclet is named maven.xdoclet.ejbdoclet.destDir for example.
Any nested element with many
cardinality (you can nest many of them inside ejbdoclet for
example) and all subtasks are indexed.
So you reference entitypk subtask of ejbdoclet with
maven.xdoclet.ejbdoclet.entitypk.0 and if you
want to specify the pattern attribute of it you define it like
this: maven.xdoclet.ejbdoclet.entitypk.0.pattern={0}PK.
</p>
</subsection>
--- 97,110 ----
<p>
So by default the destDir is target/xdoclet/ejbdoclet and all
classes ending with "Bean" are processed.
! The entitybmp, entitycmp, etc subtasks are run, for instance
because the 'maven.xdoclet.ejbdoclet.entitybmp.0' is set to 'true'.
! Basically for any task or subtask parameter you find in XDoclet
documentation there's a counterpart in the
! maven plug-in too. But sometimes the capitalization is different
than you might expect. (Don't spend too much
! time trying to experiment with capitalization though, instead
open up the plugin.jelly file and review it there.) The destDir parameter of
ejbdoclet is named maven.xdoclet.ejbdoclet.destDir for example.
Any nested element with many
cardinality (you can nest many of them inside ejbdoclet for
example) and all subtasks are indexed.
So you reference entitypk subtask of ejbdoclet with
maven.xdoclet.ejbdoclet.entitypk.0 and if you
want to specify the pattern attribute of it you define it like
this: maven.xdoclet.ejbdoclet.entitypk.0.pattern={0}PK.
+ As you review the plugin.jelly file, you will see why there is
an index, the jelly file is actually a script, and it is using
+ the indexes for iterating over the number of items that you have
for your specific build.
</p>
</subsection>
-------------------------------------------------------
The SF.Net email is sponsored by EclipseCon 2004
Premiere Conference on Open Tools Development and Integration
See the breadth of Eclipse activity. February 3-5 in Anaheim, CA.
http://www.eclipsecon.org/osdn
_______________________________________________
xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
