Perhaps the point of how to organize a javadoc based plugin with non
standard doclet is worth of discussion on its own.

On Mon, 2003-08-25 at 03:56, [EMAIL PROTECTED] wrote:
> Ralph Apel <[EMAIL PROTECTED]> wrote on 23/08/2003 07:50:19 AM:
> 
> 
> > In have an initial version of a new
> > 
> > maven-dotuml-plugin
> > 
> > which generates UML Class Diagrams in .dot format, based on javadoc with
> > a custom Doclet.
> 
> What's .dot format?
> 
> Is it the same as http://www.spinellis.gr/sw/umlgraph/ and 
> http://www.research.att.com/sw/tools/graphviz/download.html ?
> 
> To be included in Maven, licensing needs to be compatible with the ASF 
> policies.
> 
Architectural alternatives:

1) Keep the doclet small, concentrated only on the strict javadoc-driven
task

1a) Bare bone plugin (config files only) with the equivalent of
maven.javadoc.docletpath pointing to an external dependency Doclet.jar

1b) Include doclet classes within the plugin.jar (legal issues). Have
the equivalent of maven.javadoc.docletpath point to the plugin.jar
itself.

2) Add one or more separate goals preparing the doclet output for
consumption?

2a) In the general case of non-html output, only generate an
intermediate format, loadable, renderable, otherwise consumable by
several alternative means, according to user preferences.

2b) In the general case of non-html output, even generate some common
final formats, already loaded, rendered or otherwise converted for
direct consumption by the user.

2c) Offer a bunch of convenient postprocessing goals to be activated
according to user preferences.

-----------------------------------------------------------------------
In the case of maven-doclet-plugin I will first start with the doclet's
UmlGraph.jar as an external dependency (still need to figure out how to
exactly, but will do).
Usage of the Graphviz.dot format seems to be a good way to keep it small
and flexible. (Goal: "dotuml:generate")

May be, in a second step, a Goal like "dotuml:render" may be added based
on http://jzgraph.sourceforge.net/ with layouting and default .png
rendering.

But shurely it would be more modular if organized as a separate maven
plugin, such as maven-jzgraph-plugin, in this assumed case.
------------------------------------------------------------------------

Any comments?



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to