I use TogetherJ to generate documentation. I uses a JavaDoc tag format and adds
tags for deployment properties like transaction attributes. It's also
customizable.
TogetherJ is EJB savvy so that you can filter diagrams for EJB interfaces and
implementations. I have diagrams which only show the interfaces and exception,
hiding the implementations and other classes. Then I can generate documentation
for only those diagrams giving a very clean result. Better yet, it creates
hyperlinked UML diagrams. This makes it easy to see your class relationships. I
include sequence diagrams for statefull beans which indicate typical usage.
--Victor Langelo
Wong Kok Wai wrote:
> Hi,
>
> I'm readying a product for public release that is make up of EJB
> components. I'm looking for best practises and/or "design patterns" in
> documentation of EJB so that the EJB can be easily used by other ISV for
> implementing web apps for example. Currently, my team is using the
> standard JavaDoc doclet for generating the API reference. Somehow, this
> is not appropriate IMHO. For example, for a third party ISV that uses my
> company's EJB, they are mostly interested in the home and remote
> interfaces. But the doclet generates the HTML for all classes and this
> leads to cluttering. In addition, info like JNDI name for each EJB, type
> of EJB, transaction attributes, resource ref, security attributes, etc.,
> can only be found by looking in the XML deployment descriptor. Is there
> a better way? Anyone like to share their way of documenting EJB?
>
> TIA!
===========================================================================
To unsubscribe, send email to [EMAIL PROTECTED] and include in the body
of the message "signoff EJB-INTEREST". For general help, send email to
[EMAIL PROTECTED] and include in the body of the message "help".
