Steve Brewin wrote:
Something like that, yes. I've been playing around with xdocs today, and this is what you would get: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?
(from RemoteDelivery)
/**
* Receives a MessageContainer from JamesSpoolManager and takes care of delivery
* the message to remote hosts. If for some reason mail can't be delivered
* store it in the "outgoing" Repository and set an Alarm. After the next "delayTime" the
* Alarm will wake the servlet that will try to send it again. After "maxRetries"
* the mail will be considered undeliverable and will be returned to sender.
*
* TO DO (in priority):
[snip]
*
* @mailetdoc Manages delivery of messages to recipients on remote SMTP hosts.
*
* @mailetdoc.param
* name="outgoing"
* required="true"
* description="The URL for the repository that will hold messages being
* processed by the RemoteDelivery Mailet."
*
* @mailetdoc.param
* name="delayTime"
* description="a non-negative Long value that is the time in milliseconds
* between redelivery attempts for a particular mail. Defaults to six hours."
*
[snip]
*
* @version CVS $Revision: 1.33.4.21 $ $Date: 2004/05/02 06:08:37 $
*/
public class RemoteDelivery extends GenericMailet implements Runnable {
[snipperdesnip]
}I have a template that transforms this to xdoc format as expected. It works quite well already!
It's a bit tedious to copy the original xdocs file back to the xdoclet template, but it may be worth the trouble.
Cheers,
Hes.
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
