geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ralph Apel <>
Subject RE: uml (was: documentation)
Date Sat, 16 Aug 2003 09:09:07 GMT
I have continued experimenting with the doclet idea from

With this doclet (or some evolved version of it) the essential design
information may be put into each source file in form of javadoc

In a separate javadoc process, with this doclet instead of the default
one, the desing information is converted into .dot graph specifications,
- may be by package
- may be by handier sets of related classes

Dot files are practically platform independent and may be easily
converted into a large variety of bitmap or vector formats. There are
even cgi-frameworks for doing this.

So the idea would be to generate the dots within the normal build
process (its fast) and leave the real visualization to each one.

The decisive question is whether we will be willing and able to get the
corresponding javadoc-comments into the sources. I will try to send a
more concrete (and small and compressed!!) example on some area I
haven't selected yet.

Certainly the usage of special doclets can be extended to generating XMI
files to be directly loaded into the different UML-Tools. Indeed I
expect some code there around doing this. Of course it might not be too
easy, because there are several specs and dialects of XMI (XML Metadata
Interchange) and the support of XMI by the different tools also varies

On Fri, 2003-08-15 at 15:31, Chieh-Min Wang wrote:
> Using whatever tools to work should be no problem.
> The key is that we have to decide a file format for all of us to use and
> upload
> thus people may share the file easier.
> Also we can start working on it as soon as we make the decision
> Chieh-Min Wang
> -------Original Message-------
> From:
> Date: Thursday, August 14, 2003 12:18:54 AM
> To:
> Subject: RE: uml (was: documentation)
> Fine for viewing, but if there are any (larger) diagrams that might need
> editing - particularly by others - in the future, JPG isn't exactly the
> happiest of formats to have them available in.
> Adrian

View raw message