>>>>> "Bryan" == Bryan Field-Elliot <[EMAIL PROTECTED]> writes:
Bryan> I am struggling right now with how to properly and efficently document
Bryan> my Struts application for my JSP developer (who is by no means a Java
Bryan> expert). Specifically, I want to document each Action as well as each
Bryan> ActionForm that I code, including things like:
Bryan> 1. the pages I expect the user to have come from
Bryan> 2. the pages to which I might forward, or redirect, the user after
Bryan> completing the action
Bryan> 3. The beans I expect to be in place prior to submitting to my action
Bryan> 4. The beans I will set up with values for the resulting JSP page to
Bryan> work with
Bryan> 5. The errors (<html:errors>) I may set up
Bryan> And anything else that might be appropriate. I'd like to do so in a
Bryan> way that lets me rely on Javadoc, so that I can keep my documentation
Bryan> inside my code. Javadoc when used correctly will also let me do things
Bryan> like "see also" the Bean documentation (from the Action documentation).
Bryan> I am curious if anyone has developed a "template" action or bean,
Bryan> which makes best use of Javadoc and which I can cut-and-paste at the
Bryan> head of every one of my Action classes, etc?
It's not clear to me whether this will help you, but you might want to
read a current article on JavaWorld titled "Doclet your servlet!",
about writing a JavaDoc "doclet" to augment the generated
documentation for servlet classes.
--
===================================================================
David M. Karr ; w:(425)487-8312 ; TCSI & Best Consulting
[EMAIL PROTECTED] ; Java/Unix/XML/C++/X ; BrainBench CJ12P (#12004)
