Aslak
My 2c worth on the documentation.
I didn't have much problem with Ant. The biggest problem for me was exactly what javadoc/xdoclet tags to put into the source file, and where.
Example
1. Should cmp field tags be placed with the class member variable or the associated get and/or set method.
2. Is a stateless session bean marked Stateless or Stateless-Session or what? It's not immediately clear from the documentation.
I am still using EJB1.1 and all the examples seemed to be EJB2.0
So it would be nice to have the following how to's which explain what tags to put where for the following, with a brief example, and what output is generated where for each tag. So place tag X will generate a method in remote interface Y, and an entry in ejb-jar.xml and jboss.xml blah blah. Now some will be pretty obvious, some not
1. How to define as container managed field (EJB 1.1)
2. How to define finders
3. How to define remote methods
4. How to define security
5. How to define transactions
6. How to define Stateful session beans
7. How to define Stateless session beans
8. How to define CMP
9. How to define BMP
Andrew
-----Original Message-----
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]]
Sent: Thursday, January 24, 2002 10:01 AM
To: Nortje Andrew
Cc: '[EMAIL PROTECTED]'
Subject: Re: [Xdoclet-user] Documentation
You're right Andrew. We also have to WTFM ;-)
I think Ara made an attempt to set up an FAQ on jguru.com. How's that
going Ara?
The xtags subproject will describe the tags in one or more xml files.
These xml files will be used to generate documentation (among other
things).
Perhaps you have some tips about what you'd like to see in the Howto? -
I mean, it's not always obvious to us developers what is not-so-obvious
to ordinary users. We'd like to hear your suggestions. How about this:
1) Setting up your Ant build script
2) Writing a simple EJB
3) Building the EJB
4) Deploying the EJB
5) Testing the EJB
Basically everything is in the docs/examples, but I agree with you that
there is no clear description of the process (what steps to follow in
what order).
Would this be helpful for newbies?
-Aslak
----- Original Message -----
From: "Nortje, Andrew" <[EMAIL PROTECTED]>
Date: Thursday, January 24, 2002 2:37 pm
Subject: [Xdoclet-user] Documentation
>
> XDoclet Developers
>
> I know this is open source but I think a LITTLE more work on the
> documentation will go a LONG way to making this product more
> usable. I like
> it, I use it, but man it's tough to figure things out.
>
> Some simple "How to's" would be great.
>
> RTFM can't work here
>
>
