User: ibruell
Date: 01/10/01 13:54:42
Modified: src/xdocs/howto howtoejbdoclet.xml
Log:
Some changings in grammatics.
Revision Changes Path
1.2 +62 -57 manual/src/xdocs/howto/howtoejbdoclet.xml
Index: howtoejbdoclet.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/xdocs/howto/howtoejbdoclet.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- howtoejbdoclet.xml 2001/08/29 09:19:37 1.1
+++ howtoejbdoclet.xml 2001/10/01 20:54:42 1.2
@@ -1,9 +1,10 @@
<?xml version = "1.0" encoding = "UTF-8"?>
+<!-- $Id: howtoejbdoclet.xml,v 1.2 2001/10/01 20:54:42 ibruell Exp $ -->
<!-- brief howto for using ejbdoclet -->
<section id="howtoejbdoclet">
- <title>How to generate Beans with EJBDoclet (XDoclet)</title>
- <subtitle>In work(!)</subtitle>
+ <title>How to generate Enterprise Java Beans with EJBDoclet (XDoclet)</title>
+ <subtitle>Under construction(!)</subtitle>
<para>Author:
<author>
@@ -14,21 +15,21 @@
</para>
<para>
- EJBDoclet is a tool, that makes coding of Enterprise JavaBeans much easier. You
only
- have to code <emphasis>one</emphasis> file to generate automaticly the needed
- Interfaces and descriptor files. With the usage of <filename>ant</filename>
- and the <filename>verifier</filename> it is very easy to produce correct Beans.
+ EJBDoclet is a tool that facilitates coding Enterprise Java Beans. You only
+ have to code <emphasis>one</emphasis> file to generate automatically the needed
+ interfaces and descriptor files. By using <filename>ant</filename>
+ and the <filename>verifier</filename> it is very easy to produce correct beans.
</para>
<para>
- EJBDoclet is a OpenSource project initiated by Rickard Oberg which stays at
+ EJBDoclet is an OpenSource project started by Rickard Oberg and located at
<ulink url="http://sourceforge.net/projects/ejbdoclet";>
http://sourceforge.net/projects/ejbdoclet</ulink>.
</para>
<para>
- EJBDoclet has renamed to XDoclet and a new project with this name was initiated.
- For now no release with the new name is available, but all questions about
- EJBDoclet and in the future for XDoclet goes to the new mailing lists from
- XDoclet hosted at <ulink url="http://sourceforge.net/projects/xdoclet";>
+ EJBDoclet has been renamed XDoclet and a new project with this name has been
started.
+ XDoclet 1.0 was released in September 2001. Any questions about
+ EJBDoclet and XDoclet must go to the new XDoclet mailing lists
+ hosted at <ulink url="http://sourceforge.net/projects/xdoclet";>
http://sourceforge.net/projects/xdoclet</ulink>
</para>
@@ -36,13 +37,13 @@
<title>Requirements</title>
<para>
- You only need to download the ejbdoclet.jar and put it somwhere in you
classpath. I
- think the usage of ant is very recommend (and for now the only way to use
- ejbdoclet!).
+ You need to download the <filename>ejbdoclet.jar</filename> file and
+ put it somewhere in you classpath. I think that the use of Ant is highly
recommended
+ (and, for now, it is the only way to use EJBDoclet!).
</para>
<para>
- The tools.jar from the j2sdk is needed to call javadoc, so place it in the
- classpath, too.
+ The <filename>tools.jar</filename> file from the J2SDK is also needed to
+ call Javadoc, so place it in the classpath, too.
</para>
</section>
@@ -50,11 +51,11 @@
<title>Creating the Bean as a Template</title>
<para>
- EJBDoclet uses JavaDoc Tags and the JavaDoc mechanism to generate the needed
files
- out of the "template". Here is an example of an Entity Bean class section:
+ EJBDoclet uses Javadoc tags and the Javadoc mechanism to generate the needed
files
+ out of a <emphasis>template</emphasis>. Here there is an example of a section
for an
+ Entity Bean class:
<programlisting>
-
/**
* This is an account bean. It is an example of how to use the EJBDoclet tags.
*
@@ -89,39 +90,40 @@
<calloutlist>
<callout arearefs="ejbdoclet-entity-cmp">
<para>
- Here is specified that this would be an Entity Bean
+ Here is where it is specified that this is an Entity Bean
</para>
</callout>
<callout arearefs="ejbdoclet-finder">
<para>
- Defining the finder methods
+ Definitions of the finder methods
</para>
</callout>
<callout arearefs="ejbdoclet-envvar">
<para>
- Easy define envelope vars
+ Easy definition of environment variables
</para>
</callout>
<callout arearefs="ejbdoclet-ref">
<para>
- Define references to other beans
+ Definition of references to other beans
</para>
</callout>
<callout arearefs="ejbdoclet-jboss">
<para>
- With these tags you could specify JBoss specific parameters (see
EJBDoclet docu
- for more details about the tags).
+ With these tags you can define JBoss-specific parameters
+ (see the EJBDoclet documentation for more details about the tags).
</para>
</callout>
<callout arearefs="ejbdoclet-jaws">
<para>
- And here you could define JAWS specific parameters (see EJBDoclet docu
- for more details about the tags).
+ And here you can define JAWS-specific parameters
+ (see the EJBDoclet documentation for more details about the tags).
</para>
</callout>
</calloutlist>
- You can see it is very easy to create the Beanclass. The JBoss and JAWS
specific
- part should only be used, if the standard values of JBoss do not fit.
+
+ You can see that it is very easy to create the bean template. The JBoss- and
JAWS-specific
+ parts should only be used if the JBoss standard values do not fit.
</para>
<para>
Now you need to define the method level tags like this:
@@ -177,7 +179,7 @@
<calloutlist>
<callout arearefs="ejbdoclet-permission">
<para>
- With this tag permissions could be defined at method level
+ Permissions can be defined at the method level with this tag
</para>
</callout>
<callout arearefs="ejbdoclet-pk">
@@ -192,8 +194,8 @@
</callout>
<callout arearefs="ejbdoclet-persistent">
<para>
- And @ejb:persistent-field defines an attribute that should be stored
- persistent.
+ An @ejb:persistent-field defines an attribute that should be stored
+ persistently.
</para>
</callout>
</calloutlist>
@@ -204,16 +206,16 @@
<title>Calling EJBDoclet</title>
<para>
- For now there is no way to use EJBDoclet without ant, however.
+ For now there is no way to use EJBDoclet without Ant.
</para>
</section>
<section id="ejbdoclet-ant">
- <title>Using EJBDoclet with ant</title>
+ <title>Using EJBDoclet with Ant</title>
<para>
- To use ant you must download it from the <ulink
url="jakarta.apache.org">Apache
- Jakarta project</ulink>. For EJBDoclet only the ant.jar is needed.
+ To use Ant you must download it from the <ulink
url="http://jakarta.apache.org";>Apache
+ Jakarta project</ulink>. For EJBDoclet only the <filename>ant.jar</filename>
file is needed.
</para>
<para>
I prefer a project directory structure like the one JBoss uses:
@@ -238,13 +240,14 @@
. . . . +-CustomerBean.java
</programlisting>
- Here my ant script (build.xml) that generates the beans interfaces and the
descriptors
- and after that it compiles the java files and package them into a jar file:
+ Here it is my Ant script (<filename>build.xml</filename>) that first
+ generates the bean interfaces and the descriptor files
+ and then compiles the Java files and packages them into a JAR file:
<programlisting><![CDATA[
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
- $Revision: 1.1 $ $Date: 2001/08/29 09:19:37 $ $Author: user57 $
+ $Revision: 1.2 $ $Date: 2001/10/01 20:54:42 $ $Author: ibruell $
-->
<project name="test" default="main" basedir="../..">
@@ -418,37 +421,39 @@
]]></programlisting>
</para>
<para>
- I have splitted the generating beans and creating the application in different
- tasks. To generate the beans call "build buildbeans" and to create the
- application call "build".
+ I have split the generation of the beans and the creation of the application
in separate
+ tasks. To generate the beans, call <literal>build buildbeans</literal> and to
create the
+ application, call <literal>build</literal>.
</para>
<para>
- EJBDoclet throws some Exceptions at the first call, they could be ignored,
- however.
+ EJBDoclet throws some Exceptions the first time it is called, but they can be
ignored.
</para>
<para>
- The build.xml generates first PrimaryKey and DataObject classes, Home and
- Remote Interfaces and ejb-jar.xml, jboss.xml and jaws.xml descriptors. The
- java files are then compiled into the build/classes directory. After that the
- files would be archived in test.jar in dist/deploy, however. Now the jar file
- could be deployed in jboss.
+ The <filename>build.xml</filename> file generates first the PrimaryKey and
DataObject classes, Home and
+ Remote interfaces and the <filename>ejb-jar.xml</filename>,
+ <filename>jboss.xml</filename> and <filename>jaws.xml</filename> descriptors.
The
+ Java files are then compiled into the <filename>build/classes</filename>
directory. After that, the
+ files will be archived in <filename>test.jar</filename> in directory
+ <filename>dist/deploy</filename>. Now the JAR file
+ can be deployed in JBoss.
</para>
<para>
- If you are using ejbspec="2.0" or nothing (default is "2.0") than it is
- possible that jboss does not find the dtd's defined in the deployment
- descriptors just remove this lines or comment them out. For me I have changed
the
- templates from ejbdoclet so they do not generate these lines.
+ If you are either specifying <literal>ejbspec="2.0"</literal> or nothing
+ (the default is <literal>2.0</literal>), it is possible that JBoss will
+ not find the DTDs defined in the deployment descriptors; in that case,
+ just remove those lines or comment them out. For my own use, I have changed
the
+ EJBDoclet templates to avoid generating those lines.
</para>
</section>
- <section id="ejbdoclet-concluding"><title>Concluding</title>
+ <section id="ejbdoclet-concluding"><title>Conclusion</title>
<para>
- A brief explanation of all possible parameters and a complete example
- you can find in the ejbdoclet archive, that could be downloaded from
+ In the EJBDoclet archive that can downloaded from
<ulink url="http://sourceforge.net/projects/ejbdoclet";>
- http://sourceforge.net/projects/ejbdoclet</ulink>.
+ http://sourceforge.net/projects/ejbdoclet</ulink> there is a brief
+ explanation of all possible parameters and a complete example.
</para>
</section>
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/jboss-development
