[JBoss-dev] CVS update: manual/src/xdocs/howto howtoejbdoclet.xml
User: ibruell Date: 01/10/01 13:54:42 Modified:src/xdocs/howto howtoejbdoclet.xml Log: Some changings in grammatics. Revision ChangesPath 1.2 +62 -57manual/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.xml2001/08/29 09:19:37 1.1 +++ howtoejbdoclet.xml2001/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 - titleHow to generate Beans with EJBDoclet (XDoclet)/title - subtitleIn work(!)/subtitle + titleHow to generate Enterprise Java Beans with EJBDoclet (XDoclet)/title + subtitleUnder construction(!)/subtitle paraAuthor: author @@ -14,21 +15,21 @@ /para para -EJBDoclet is a tool, that makes coding of Enterprise JavaBeans much easier. You only -have to code emphasisone/emphasis file to generate automaticly the needed -Interfaces and descriptor files. With the usage of filenameant/filename -and the filenameverifier/filename it is very easy to produce correct Beans. +EJBDoclet is a tool that facilitates coding Enterprise Java Beans. You only +have to code emphasisone/emphasis file to generate automatically the needed +interfaces and descriptor files. By using filenameant/filename +and the filenameverifier/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 @@ titleRequirements/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 filenameejbdoclet.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 filenametools.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 @@ titleCreating 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 emphasistemplate/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 +
[JBoss-dev] CVS update: manual/src/docs howtoejbdoclet.xml
User: ibruell
Date: 01/07/23 11:38:40
Modified:src/docs howtoejbdoclet.xml
Log:
Remarks to the renaming of EJBDoclet to XDoclet.
Revision ChangesPath
1.4 +29 -4 manual/src/docs/howtoejbdoclet.xml
Index: howtoejbdoclet.xml
===
RCS file: /cvsroot/jboss/manual/src/docs/howtoejbdoclet.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- howtoejbdoclet.xml2001/07/13 16:07:13 1.3
+++ howtoejbdoclet.xml2001/07/23 18:38:40 1.4
@@ -2,7 +2,7 @@
!-- brief howto for using ejbdoclet --
section id=howtoejbdoclet
- titleHow to use EJBDoclet/title
+ titleHow to generate Beans with EJBDoclet (XDoclet)/title
subtitleIn work(!)/subtitle
paraAuthor:
@@ -21,8 +21,16 @@
/para
para
EJBDoclet is a OpenSource project initiated by Rickard Oberg which stays at
-ulink url=http://sf.net/projects/ejbdoclet;sourceforge.net/ulink.
+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;
+http://sourceforge.net/projects/xdoclet/ulink
+ /para
section id=ejbdoclet-requirements
titleRequirements/title
@@ -236,7 +244,7 @@
programlisting![CDATA[
?xml version=1.0 encoding=ISO-8859-1?
!--
- $Revision: 1.3 $ $Date: 2001/07/13 16:07:13 $ $Author: ibruell $
+ $Revision: 1.4 $ $Date: 2001/07/23 18:38:40 $ $Author: ibruell $
--
project name=test default=main basedir=../..
@@ -281,6 +289,7 @@
destdir=${src.dir}
packagenames=test
classpath=${classpath};${basedir}/lib/ejbdoclet.jar
+ ejbspec=1.1
excludedtags=@version,@author
dataobject/
remoteinterface/
@@ -409,12 +418,27 @@
]]/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.
+/para
+para
+ EJBDoclet throws some Exceptions at the first call, they could be ignored,
+ however.
+/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.
/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.
+/para
/section
@@ -423,7 +447,8 @@
para
A brief explanation of all possible parameters and a complete example
you can find in the ejbdoclet archive, that could be downloaded from
- ulink url=http://sf.net/projects/ejbdoclet;sourceforge/ulink.
+ ulink url=http://sourceforge.net/projects/ejbdoclet;
+ http://sourceforge.net/projects/ejbdoclet/ulink.
/para
/section
___
Jboss-development mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/jboss-development
[JBoss-dev] CVS update: manual/src/docs howtoejbdoclet.xml
User: ibruell
Date: 01/07/13 09:07:14
Modified:src/docs howtoejbdoclet.xml
Log:
Changed some id's to avoid conflicts. Added some comments.
Revision ChangesPath
1.3 +45 -24manual/src/docs/howtoejbdoclet.xml
Index: howtoejbdoclet.xml
===
RCS file: /cvsroot/jboss/manual/src/docs/howtoejbdoclet.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- howtoejbdoclet.xml2001/07/13 09:10:13 1.2
+++ howtoejbdoclet.xml2001/07/13 16:07:13 1.3
@@ -32,6 +32,10 @@
think the usage of ant is very recommend (and for now 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.
+/para
/section
section id=ejbdoclet-createingthebean
@@ -46,23 +50,23 @@
/**
* This is an account bean. It is an example of how to use the EJBDoclet tags.
*
- * @ejb:entity-cmp co id=entity-cmp/
+ * @ejb:entity-cmp co id=ejbdoclet-entity-cmp/
* @ejb:ejb-name bank/Account
* @ejb:jndi-name ejb/bank/Account
- * @ejb:finder Collection findAll() co id=finder/
+ * @ejb:finder Collection findAll() co id=ejbdoclet-finder/
* @ejb:finder Collection findByOwner(Customer owner)
* @ejb:finder Collection findLargeAccounts(int balance)
- * @ejb:env-entry foo 1234 java.lang.Integer co id=envvar/
- * @ejb:ejb-ref bank/Customer co id=ref/
+ * @ejb:env-entry foo 1234 java.lang.Integer co id=ejbdoclet-envvar/
+ * @ejb:ejb-ref bank/Customer co id=ejbdoclet-ref/
* @ejb:security-role-ref admin Administrator
* @ejb:permission Teller
* @ejb:transaction Required
* @ejb:use-soft-locking
*
- * JBoss specific co id=jboss/
+ * JBoss specific co id=ejbdoclet-jboss/
* @jboss:container-configuration Standard CMP EntityBean
*
- * JBoss/JAWS CMP specific co id=jawsco/
+ * JBoss/JAWS CMP specific co id=ejbdoclet-jaws/
* @jboss:table-name account
* @jboss:create-table true
* @jboss:remove-table true
@@ -75,41 +79,41 @@
{
/programlisting
calloutlist
-callout arearefs=entity-cmp
+callout arearefs=ejbdoclet-entity-cmp
para
Here is specified that this would be an Entity Bean
/para
/callout
-callout arearefs=finder
+callout arearefs=ejbdoclet-finder
para
Defining the finder methods
/para
/callout
-callout arearefs=envvar
+callout arearefs=ejbdoclet-envvar
para
Easy define envelope vars
/para
/callout
-callout arearefs=ref
+callout arearefs=ejbdoclet-ref
para
Define references to other beans
/para
/callout
-callout arearefs=jboss
+callout arearefs=ejbdoclet-jboss
para
With these tags you could specify JBoss specific parameters (see
EJBDoclet docu
for more details about the tags).
/para
/callout
-callout arearefs=jawsco
+callout arearefs=ejbdoclet-jaws
para
And here you could define JAWS specific parameters (see EJBDoclet docu
for more details about the tags).
/para
/callout
/calloutlist
- How 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 not fit.
+ 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.
/para
para
Now you need to define the method level tags like this:
@@ -117,7 +121,7 @@
/**
* Create account.
*
-* @ejb:permission Administrator co id=permission/
+* @ejb:permission Administrator co id=ejbdoclet-permission/
*/
public AccountPK ejbCreate(AccountData data)
throws CreateException
@@ -133,7 +137,7 @@
*
* This is not remote since the primary key can be extracted by other means.
*
-* @ejb:pk-field co id=pk/
+* @ejb:pk-field co id=ejbdoclet-pk/
* @ejb:persistent-field
*
* @jboss:column-name pk
@@ -149,8 +153,8 @@
/**
* Owner of this account.
*
-* @ejb:remote-method co id=remote/
-* @ejb:persistent-field co id=persistent/
+* @ejb:remote-method co id=ejbdoclet-remote/
+* @ejb:persistent-field co id=ejbdoclet-persistent/
* @ejb:permission Administrator
* @ejb:transaction Supports
*/
@@ -163,22 +167,22 @@
public abstract void
[JBoss-dev] CVS update: manual/src/docs howtoejbdoclet.xml jbossdocs.xml
User: ibruell
Date: 01/07/12 15:51:25
Modified:src/docs jbossdocs.xml
Added: src/docs howtoejbdoclet.xml
Log:
added my first snapshot of a sjbdoclet howto
Revision ChangesPath
1.21 +4 -2 manual/src/docs/jbossdocs.xml
Index: jbossdocs.xml
===
RCS file: /cvsroot/jboss/manual/src/docs/jbossdocs.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- jbossdocs.xml 2001/07/07 21:56:57 1.20
+++ jbossdocs.xml 2001/07/12 22:51:24 1.21
@@ -34,6 +34,7 @@
!ENTITY howtovisualagedebug.xml SYSTEM howtovisualagedebug.xml
!ENTITY howto_webcontainer.xml SYSTEM howto_webcontainer.xml
!ENTITY webconfig.xml SYSTEM webconfig.xml
+ !ENTITY howtoejbdoclet.xml SYSTEM howtoejbdoclet.xml
]
book
bookinfo
@@ -53,7 +54,7 @@
author
firstnameAaron/firstname
surnameMulder/surname
- /author
+ /author
email[EMAIL PROTECTED]/email
/para
jdbc-database.xml;
@@ -76,7 +77,7 @@
howtotimer.xml;
howtoj2eedeployer.xml;
howtojaas.xml;
-howtojavamail.xml;
+howtojavamail.xml;
howtojbuilderdebug.xml;
howtovisualagedebug.xml;
howtonetbeansdebug.xml;
@@ -88,5 +89,6 @@
howtoverifier.xml;
howtopetstore.xml;
howto_webcontainer.xml;
+howtoejbdoclet.xml;
/chapter
/book
1.1 manual/src/docs/howtoejbdoclet.xml
Index: howtoejbdoclet.xml
===
?xml version = 1.0 encoding = UTF-8?
!-- brief howto for using ejbdoclet --
section id=howtoejbdoclet
titleHow to use EJBDoclet/title
subtitleIn work(!)/subtitle
paraAuthor:
author
firstnameIngo/firstname
surnameBruell/surname
/author
email[EMAIL PROTECTED]/email
/para
para
EJBDoclet is a tool, that makes coding of Enterprise JavaBeans much easier. You
only
have to code emphasisone/emphasis file to generate automaticly the needed
Interfaces and descriptor files. With the usage of filenameant/filename
and the filenameverifier/filename it is very easy to produce correct Beans.
/para
para
EJBDoclet is a OpenSource project initiated by Rickard Oberg which stays at
ulink url=http://sf.net/projects/ejbdoclet;sourceforge.net/ulink.
/para
section id=ejbdoclet-requirements
titleRequirements/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!).
/para
/section
section id=ejbdoclet-createingthebean
titleCreating 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:
programlisting
/**
* This is an account bean. It is an example of how to use the EJBDoclet tags.
*
* @ejb:entity-cmp co id=entity-cmp/
* @ejb:ejb-name bank/Account
* @ejb:jndi-name ejb/bank/Account
* @ejb:finder Collection findAll() co id=finder/
* @ejb:finder Collection findByOwner(Customer owner)
* @ejb:finder Collection findLargeAccounts(int balance)
* @ejb:env-entry foo 1234 java.lang.Integer co id=envvar/
* @ejb:ejb-ref bank/Customer co id=ref/
* @ejb:security-role-ref admin Administrator
* @ejb:permission Teller
* @ejb:transaction Required
* @ejb:use-soft-locking
*
* JBoss specific co id=jboss/
* @jboss:container-configuration Standard CMP EntityBean
*
* JBoss/JAWS CMP specific co id=jaws/
* @jboss:table-name account
* @jboss:create-table true
* @jboss:remove-table true
* @jboss:tuned-updates true
* @jboss:read-only false
* @jboss:finder-query findLargeAccounts $1 gt; 1000
* @jboss:finder-order findLargeAccounts balance
*/
public abstract class AccountBean
{
/programlisting
calloutlist
callout arearefs=entity-cmp
para
Here is specified that this would be an Entity Bean
/para
/callout
callout arearefs=finder
para
Defining the finder methods
/para
/callout
callout arearefs=envvar
para
Easy define envelope vars
/para
/callout
callout arearefs=ref
para
Define references to other beans
/para
/callout
callout arearefs=jboss
para
With these tags you could specify JBoss specific parameters (see
EJBDoclet docu
for more details
