User: vharcq
Date: 02/06/24 14:12:32
Modified: xdocs architecture.xml feedback.xml index.xml
Added: xdocs faq.xml todo.xml using.xml whoarewe.xml
Log:
More docs
Revision Changes Path
1.2 +1 -1 xdoclet/xdocs/architecture.xml
Index: architecture.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/xdocs/architecture.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- architecture.xml 21 Jun 2002 12:35:47 -0000 1.1
+++ architecture.xml 24 Jun 2002 21:12:30 -0000 1.2
@@ -2,7 +2,7 @@
<document>
<properties>
- <author email="[EMAIL PROTECTED]">Aslak Helles�y</author>
+ <author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
<title>Architecture</title>
</properties>
1.3 +6 -6 xdoclet/xdocs/feedback.xml
Index: feedback.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/xdocs/feedback.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -r1.2 -r1.3
--- feedback.xml 21 Jun 2002 12:35:47 -0000 1.2
+++ feedback.xml 24 Jun 2002 21:12:31 -0000 1.3
@@ -2,8 +2,8 @@
<document>
<properties>
- <author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
- <title>My Project</title>
+ <author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
+ <title>Feedback</title>
</properties>
<body>
@@ -29,7 +29,7 @@
</ul>
</p>
<p>
- <a href="http://sourceforge.net/mail/?group_id=31602";>XDoclet user mailing list
on SourceForge</a>
+ <a href="http://sourceforge.net/mail/?group_id=31602"; target="popup">XDoclet
user mailing list on SourceForge</a>
</p>
</section>
<section name="Bugs">
@@ -48,7 +48,7 @@
</ol>
</p>
<p>
- <a
href="http://sourceforge.net/tracker/?atid=402704&group_id=31602&func=browse";>XDoclet
bug tracker on SourceForge</a>
+ <a
href="http://sourceforge.net/tracker?atid=402704&group_id=31602&func=browse";
target="popup">XDoclet bug tracker on SourceForge</a>
</p>
</section>
<section name="Feature requests">
@@ -56,7 +56,7 @@
If you have a feature request bla bla
</p>
<p>
- <a
href="http://sourceforge.net/tracker/?atid=402707&group_id=31602&func=browse";>XDoclet
feature requests on SourceForge</a>
+ <a
href="http://sourceforge.net/tracker/?atid=402707&group_id=31602&func=browse";
target="popup">XDoclet feature requests on SourceForge</a>
</p>
</section>
<section name="Patches">
@@ -64,7 +64,7 @@
If you have a patch bla bla
</p>
<p>
- <a
href="http://sourceforge.net/tracker/?atid=402706&group_id=31602&func=browse";>XDoclet
patches on SourceForge</a>
+ <a
href="http://sourceforge.net/tracker/?atid=402706&group_id=31602&func=browse";
target="popup">XDoclet patches on SourceForge</a>
</p>
</section>
1.3 +4 -4 xdoclet/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -r1.2 -r1.3
--- index.xml 19 Jun 2002 21:45:53 -0000 1.2
+++ index.xml 24 Jun 2002 21:12:31 -0000 1.3
@@ -2,8 +2,8 @@
<document>
<properties>
- <author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
- <title>My Project</title>
+ <author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
+ <title>Index</title>
</properties>
<body>
@@ -23,7 +23,7 @@
</p>
<p>
The broader goal of XDoclet is to let you apply
- <a
href="http://www.martinfowler.com/articles/continuousIntegration.html";>Continuous
+ <a href="http://www.martinfowler.com/articles/continuousIntegration.html";
target="popup">Continuous
Integration</a> in component-oriented development. The idea is that the
developers can
work concentrate their editing on only one Java source file per component.
The component's meta data is included in the source file as special JavaDoc
tags, and XDoclet
@@ -49,7 +49,7 @@
</li>
</ol>
- XDoclet is meant to be used as part of the build process utilizing <a
href="http://jakarta.apache.org/ant/";>Ant</a>
+ XDoclet is meant to be used as part of the build process utilizing <a
href="http://jakarta.apache.org/ant/"; target="popup">Ant</a>
</p>
<p>
Although XDoclet originated as a tool for creating EJBs, it has evolved into
a general-purpose code
1.1 xdoclet/xdocs/faq.xml
Index: faq.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
<title>Index</title>
</properties>
<body>
<section name="XDoclet FAQ on JGuru">
<p>
XDoclet FAQ is maintained on <a
href="http://www.jguru.com/faq/printablefaq.jsp?topic=XDoclet"; target="popup">JGuru</a>
</p>
</section>
</body>
</document>
1.1 xdoclet/xdocs/todo.xml
Index: todo.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
<title>Index</title>
</properties>
<body>
<section name="Developement TODO List">
<p>
Here is the <a href="todo/index.html" target="popup">list of todo's</a> based on
@todo tags inside XDoclet sources.
</p>
</section>
</body>
</document>
1.1 xdoclet/xdocs/using.xml
Index: using.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
<title>Index</title>
</properties>
<body>
<section name="Software requirements">
<p>
<ul>
<li>It only runs on Java 2 JDKs, older JDKs are not supported.</li>
<li>Make sure tools.jar from JDK's lib directory is in your classpath.</li>
<li>Make sure JDK's bin directory is in path (needed for invoking
javadoc.exe).</li>
<li>Make sure you use Jakarta Ant v1.4.x, XDoclet does not run on older
ones.</li>
</ul>
</p>
</section>
<section name="Usage">
<p>
Using XDoclet is simple. Just as you write Javadoc tags for your
code (you do comment your code, don't you?), you now add XDoclet tags
too. These tags are used by XDoclet as providers of meta-data that is
then used to generate other files as required.
</p>
<p>
for a thorough example of how to use XDoclet, consult the <a
href="samples.html">samples</a>. However, this page should give you
enough of a start to XDoclet your code.
</p>
<p>
A typical XDoclet comment might look like this:
</p>
<source><![CDATA[/**
* This is an account bean. It is an example of how to use the
* EJBDoclet tags.
*
* @see Customer Accounts are owned by customers, and a customer can
* have many accounts.
*
* @ejb:bean name="bank/Account"
* type="CMP"
* jndi-name="ejb/bank/Account"
* primkey-field="id"
* @ejb:finder signature="Collection findAll()"
* unchecked="true"
* @ejb:interface remote-class="test.interfaces.Account"
*/]]></source>
<p>
There are three parts to that comment: The comment, the javadoc
tag, and the XDoclet tags. The first two are your standard tags.
Just because you are using XDoclet doesn't mean that you stop doing
normal documentation. The third part of the comment is that part that
we are interested in. An XDoclet tag is comprised of the following
parts:
</p>
<blockquote><code>@<i>namespace</i>:<i>tag-name</i>
<i>parameter-name</i>="<i>parameter value</i>"</code></blockquote>
<p>
Tags are grouped by namespaces, and have names that are unique
within that namespace. Tags can have zero or more parameters, which
are grouped in name="value" pairs. Looking at the above example, we
find the first tag is in the <i><code>ejb</code></i> namespace, and
is called <i><code>bean</code></i>. The <a
href="ejbdoclet.html#bean"><i><code>ejb:bean</code></i></a>
tag defines data relating to Enterprise Java Beans. Every EJB will
require a name, and it is specified here. The namespace is a mechanism for
making sure no name collision happens. Namespaces include ejb, web, jboss,
weblogic, struts and so on. So it's simply a way to group related tags. For details
on individual
tags, consult the <a href="ejbdoclet.html">ejbdoclet
documentation</a>.
</p>
<p>
Tag values can be specified as ant properties. For example:
</p>
<blockquote><code>@jboss:create-table
create="${jboss.create.table}"</code></blockquote>
<p>
Where the jboss.create.table is a property defined in the ant
project. For more information on ant properties consult the ant
documentation.
</p>
<p>Tags exist at both class and method level. As a general rule, if
information can be determined by the name or type of a class, then it
will be - and hence there will not be a requirement to specify that
information with a tag. An example of this is the
<i><code>type</code></i> parameter to the <i><code>ejb:bean</code></i>
tag example above. The type in this instance refers to the Entity
type (CMP or BMP), but if the class implemented the
<code>javax.ejb.SessionBean</code> interface the type would be
Stateful or Stateless.</p>
<p>To start using XDoclet you must first determine what it is you wish
to use it for. The two most popular usages are <a
href="ejbdoclet.html">EJBDoclet</a> and <a
href="webdoclet.html">WebDoclet</a>. Generally you should define the XDoclet
task for Ant, setup the configuration parameter. Here is an example:</p>
<source><![CDATA[<target name="ejbdoclet"
depends="prepare">
<taskdef name="ejbdoclet"
classname="xdoclet.modules.ejb.EjbDocletTask"
classpath="${xdoclet.jar.path};${log4j.jar.path};${ant.jar.path}" />
<tstamp>
<format property="TODAY" pattern="d-MM-yy" />
</tstamp>
<ejbdoclet
sourcepath="${java.dir}"
destdir="${generated.java.dir}"
classpathref="project.class.path"
excludedtags="@version,@author"
addedtags="@xdoclet-generated at ${TODAY}"
ejbspec="2.0"
force="${xdoclet.force}">
<fileset dir="${java.dir}">
<include name="**/*Bean.java" />
</fileset>
<dataobject/>
<remoteinterface/>
<localinterface/>
<homeinterface/>
<localhomeinterface/>
<entitypk/>
<entitycmp/>
<deploymentdescriptor destdir="${build.dir}/ejb/META-INF"/>
<jboss version="2.4" xmlencoding="UTF-8"
typemapping="Hypersonic SQL" datasource="java:/DefaultDS"
destdir="${build.dir}/ejb/META-INF"/>
</ejbdoclet>
</target>]]></source>
<source><![CDATA[<target name="compile"
depends="ejbdoclet">
<!-- Compile EJBs -->
<javac srcdir="${java.dir};${generated.java.dir}"
destdir="${build.dir}/ejb"
includes="test/ejb/*.java,test/interfaces/*.java">
</target>]]></source>
<p>
As it's seen, compile target depends on ejbdoclet target. This means that
before compiling anything all home/local/remote interfaces, primary key and
data-object (also known as Value Objects) are generated, plus deployment
descriptors. The first thing you have to do is define ejbdoclet task for Ant. To
do so you use taskdef, where you specify xdoclet.modules.ejb.EjbDocletTask as the
class
implementing ejbdoclet task. Note that classpath parameter has xdoclet.jar,
log4j.jar and ant.jar (Ant 1.4 or higher) in it. These 3 jars are all needed.</p>
<p>Next you declare ejbdoclet task, with a set of configuration parameters and
nested elements. For example, destdir specifies where to put generated files. As
you can see there's an inheritance mechanisms also, you can override this
destfir parameter for each nested element (or as we call it sub-task).
<deploymentdescriptor/>
does exactly that to put the generated ejb-jar.xml file somewhere else than
where generated java sources for home/remote/pk/etc are placed. For a complete
list of configurable parameters consult the documentation for the task and for
each sub-task.
</p>
<p>
By default each task has some built-in sub-tasks. Some of them are mandatory
really, for example <remoteinterface/> and <localinterface/>, can you
imagine an
EJB without a remote or local (EJb 2.0 only) interface? Some other tasks may be
optional, for example <jboss/> is optional if you're not using jBoss
application
server.
</p>
<p>
There's even a third form of sub-tasks: <template/>. This is useful for
cases
where you want to design your own template file and generate a customized file.
So, you need a simple way to let xdoclet use your template file. Here is an
example:
</p>
<source><![CDATA[<taskdef name="templatedoclet"
classname="xdoclet.DocletTask"
classpath="${xdoclet.jar.path};${log4j.jar.path};${ant.jar.path}" />
<templatedoclet sourcepath="${java.dir}"
destdir="${generated.java.dir}" classpathref="project.class.path"
excludedtags="@version,@author" >
<fileset dir="${java.dir}">
<include name="**/*Bean.java" />
</fileset>
<template templateFile="/mytemplate.j"
destinationfile="hhhh.txt"></template>
</templatedoclet>]]></source>
<p>So you put a <template/> element in the task, specify the path to your
template file and output file name (which will we stored in the directory
specified in destdir parameter). This is very useful for those creative people
who want to easily take advantage of XDoclet's framework-like capabilities and
define their own set of @tags and templates generating something from those
@tags. For more information on how to write template see
<a href="template-how-to.html">Template How-To</a>.</p>
<p>So whenever you do a build, ejbdoclet (or whatever other task) is run and you
have always up-to-date files generated by xdoclet.</p>
<p>A checklist of things you will need to do to get XDoclet running
is:</p>
<ul>
<li>Modify (creating if required) your build.xml script (see <a
href="http://jakarta.apache.org/ant"; target="ant">ant</a> for details).</li>
<li>Add <a href="templates.html"
onclick="top.navFrame.location='templates_toc.html'">XDoclet
tags</a> to your source code.</li>
<li>Stop worrying about all that boring code you use to have to
write! XDoclet does it for you now.</li>
</ul>
<p>The <a
href="whoarewe.html#mailing-lists">mailing lists</a> provide a wealth
of knowledge, and the developers are lurking on the xdoclet-user list,
so feel free to ask questions, make suggestions, or just generally
discuss XDoclet.</p>
</section>
</body>
</document>
1.1 xdoclet/xdocs/whoarewe.xml
Index: whoarewe.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Aslak Hellesoy</author>
<title>Index</title>
</properties>
<body>
<section name="Who are we?">
<p>Special credit goes to Rickard Oberg who started the original EJBDoclet
project.</p>
<p>All contributions are welcome, and may be discussed and posted on the mailing
lists. The final decision of what becomes part of the official distribution is
made by a group of Committers.</p>
</section>
<section name="Active Committers">
<ul>
<li><b>Andreas "Mad" Schaefer</b>
(<a
href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a>)</li>
<li><b>Ara Abrahamian</b>
(<a
href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a>)</li>
<li><b>Aslak Hellesoy</b>
(<a
href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a>)</li>
<li><b>Dmitri Colebatch</b>
(<a href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a>)</li>
<li><b>Rickard Oberg</b>
(<a
href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a>)</li>
<li><b>Vincent Harcq</b>
(<a
href="mailto:[EMAIL PROTECTED]";>[EMAIL PROTECTED]</a>)</li>
</ul>
</section>
<section name="Contributors">
<ul>
<li>Andrew Stevens</li>
<li>Bart Guijt</li>
<li>Christoph Sturm</li>
<li>Dan Schaffer</li>
<li>Daniel O'Connor</li>
<li>Dave Smith</li>
<li>David Budworth</li>
<li>David Jencks</li>
<li>Dion Almaer</li>
<li>Erik Hatcher</li>
<li>Hani Suleiman</li>
<li>Jerome Bernard</li>
<li>Keith Chew</li>
<li>Konstantin Pribluda</li>
<li>Marcus Brito</li>
<li>Mathias Bogaert</li>
<li>Mike Cannon-Brookes</li>
<li>Mike Williams</li>
<li>Minh Kama Yie</li>
<li>Patrick Lightbody</li>
<li>Steve Magoun</li>
</ul>
</section>
</body>
</document>
-------------------------------------------------------
Sponsored by:
ThinkGeek at http://www.ThinkGeek.com/
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
