Update of /cvsroot/xdoclet/xdoclet/xdocs
In directory sc8-pr-cvs1:/tmp/cvs-serv19239/xdoclet/xdocs
Modified Files:
navigation.xml
Added Files:
maven-plugin.xml
Log Message:
o Updated build to produce jar files with proper version names.
o For the sake of reduced confusion, all modules and xjavadoc's version number is the
same as xdoclet.
o Improved the Maven XDoclet plugin. It now produces a jar file to drop into
$MAVEN/plugins.
o Included the unicode version of xjavadoc in the general build process.
--- NEW FILE: maven-plugin.xml ---
<?xml version="1.0"?>
<document>
<properties>
<title>Maven XDoclet Plug-in</title>
<author email="[EMAIL PROTECTED]">Ara Abrahamian</author>
</properties>
<body>
<section name="Maven XDoclet Plug-in">
<p>
<a href="http://jakarta.apache.org/maven/";>Maven</a> is an increasingly
popular build tool,
and XDoclet maintains its own Maven plugin. This plugin is located in the same
folder
as the other xdoclet jar files, and is named
maven-xdoclet-plugin-<version>.jar. Just drop
it in your $MAVEN_HOME/plugins directory and you're ready to go. You might
have to delete
your $MAVEN_HOME/plugins/*.cache files and previous un-zipped xdoclet plugins
to be able
to get it to work properly.
</p>
<p>
The Maven XDoclet plug-in supports all standard tasks and subtasks of XDoclet.
</p>
<subsection name="How-to">
<p>
1. In order to use the XDoclet plugin, 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.2</version>
</dependency>
<dependency>
<id>xdoclet+jboss-module</id>
<version>1.2</version>
</dependency>
<dependency>
<id>ejb</id>
<version>2.0</version>
</dependency>
</dependencies>]]></source>
<p>
2. If you want xdoclet to run automatically before the compile step you
should define a maven.xml file
like this:
</p>
<source><![CDATA[
<project>
<preGoal name="java:compile">
<attainGoal name="xdoclet:ejbdoclet"/>
</preGoal>
</project>]]></source>
<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[
#ejbdoclet default properties
maven.xdoclet.ejbdoclet.destDir=${maven.build.dir}/xdoclet/ejbdoclet
maven.xdoclet.ejbdoclet.fileset.0=true
maven.xdoclet.ejbdoclet.fileset.0.include=**/*Bean.java
maven.xdoclet.ejbdoclet.deploymentdescriptor.0=true
maven.xdoclet.ejbdoclet.deploymentdescriptor.0.destDir=${maven.build.dir}/xdoclet/ejb/META-INF
maven.xdoclet.ejbdoclet.entitybmp.0=true
maven.xdoclet.ejbdoclet.entitycmp.0=true
maven.xdoclet.ejbdoclet.entitypk.0=true
maven.xdoclet.ejbdoclet.homeinterface.0=true
maven.xdoclet.ejbdoclet.localhomeinterface.0=true
maven.xdoclet.ejbdoclet.localinterface.0=true
maven.xdoclet.ejbdoclet.remoteinterface.0=true
maven.xdoclet.ejbdoclet.session.0=true
maven.xdoclet.ejbdoclet.utilobject.0=true]]></source>
<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 plugin 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>
</section>
</body>
</document>
Index: navigation.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/xdocs/navigation.xml,v
retrieving revision 1.21
retrieving revision 1.22
diff -C2 -r1.21 -r1.22
*** navigation.xml 1 Dec 2002 13:13:10 -0000 1.21
--- navigation.xml 9 Dec 2002 23:19:56 -0000 1.22
***************
*** 53,56 ****
--- 53,57 ----
</menu>
<menu name="Advanced">
+ <item name="Maven Plugin" href="/maven-plugin.html"/>
<item name="Merge Points" href="/merge.html"/>
<item name="IDE Integration" href="/ide/index.html"/>
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
