Hes Siemelink wrote:

> I would like to play around with xdoclet to generate the
> documentation.
> Using xdoclet would make it a lot easier to keep source &
> documentation
> in sync. (provided that code branch & site branch are in
> sync, that is)
>
> What are your thoughts on this?

I'm no expert, but if you mean for Mailets and Matchers extracting the class
level Javadoc comments and transforming them to .xdocs I'm not sure this
would work as they are. We have two different audiences, the user 'how to
use this' audience which the .xdocs present and the developer 'how this
works' audience which the Javadocs present. I guess that we could introduce
xdoclets tags to indicate the target audience for the subset of the Javadoc
which is oriented towards each audience. Then each contributor would have to
learn our ways, which might be as simple as a <userdoc> tag surrounding what
should be published as .xdocs.

Maybe you are alluding to something smarter?

--  Steve


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

Reply via email to