Scott, Before you go down the javadoc path check out fusedoc. Comments are stored in an xml structure at the top of the code page, you basically have the function of the system, the inputs and outputs, version history etc in a simple xml structure. (Note that they do have some stupid stuff in there, to say a variable is required you write optional="no" when the rest of the computing world would write required=yes)
Structure showing parameters: http://fusedoc.josephdevore.com/fusedoc_a.txt Example: http://www.meta-magic.com/cgi-bin/fusewiki?FuseDoc Lee Borkman has written a nice autodoc system that uses fusedocs, see http://www.bjork.net/index.cfm?fuseaction=content.display&page=AutoDocs S. IMPORTANT NOTICE: This e-mail and any attachment to it is intended only to be read or used by the named addressee. It is confidential and may contain legally privileged information. No confidentiality or privilege is waived or lost by any mistaken transmission to you. If you receive this e-mail in error, please immediately delete it from your system and notify the sender. You must not disclose, copy or use any part of this e-mail if you are not the intended recipient. The RTA is not responsible for any unauthorised alterations to this e-mail or attachment to it. --- You are currently subscribed to cfaussie as: [email protected] To unsubscribe send a blank email to [EMAIL PROTECTED] MX Downunder AsiaPac DevCon - http://mxdu.com/
