RE: javadoc style comments and processing

[NSmith@xxxxxxxxxxx]

I'd love to see it, Tony.  I've also been looking for some sort of
cataloging utility for procedures.  Has anyone developed anything like that?

> -----Original Message-----
> From: Tony Goodwin [SMTP:tony.goodwin@dact.demon.co.uk]
> Sent: Monday, April 02, 2001 4:55 PM
> To:   RPG400-L (E-mail)
> Subject:      javadoc style comments and processing
> 
> 
> I noted some time back that someone wondered if there was
> a tool to extract the interface from a service program to
> produce javadoc style documentation.
> 
> I saw no replies (other than barbara's whos the best person to add it to
> the RPG compiler!!)
> 
> Anyway I am not promising same, but have come to problem
> from another direction. I have created two tools to save
> development and documentation time.
> 
> No 1. Adds comments to service programs in structured fashion
> in essence to create a standard template. The tool creates
> something like the following, from the original source
> (the function declaration) to create the @params and @returns
> etc.
> 
> /**--------------------------------------------------------
>  * XXXXX Add DESCRIPTION HERE
>  * @author XXXXXX
>  * @version X.X
>  * @param Lib
>  * @param File
>  * @param Mbr
>  * @param Field
>  * @param RRN
>  * @returns XXXX add RETURN DESC HERE
>  *-------------------------------------------------------*/
>   *--------------------------------------------------------
>  p AHI_display     b                   Export
>   *--------------------------------------------------------
>  D AHI_display     PI             1S
>  D  Lib                          10A   Options(*Omit)
>  D  File                         10A   Value
>  D  Mbr                          10A   Options(*Omit)
>  D  Field                        10A   Value
>  D  RRN                          10P 0 Value
> 
> No 2 tool, takes the new service program source and parses
> for javadoc style comments /** .... */ and creates HTML
> source giving (a) summary list of functions in module and
> references to detailed comment (the above bit)
> 
> Anyway after all that, I want to know if anyone would like
> a handle on source for this. Its not in java (ILE RPG) -
> I toyed with the javadoc code for the parsing, but decided
> with licensing etc - wasn't worth the effort
> 
> I can either post here (dont think thats a good idea) or
> I'll answer each privately, or post someplace common if they
> will take it!! (dont we all get paranoid about our code
> in case someone else doesn't like your style ?)
> 
> Tony
> 
> 
> -------------------------------------------
> Tony Goodwin
> Dact Ltd.
> 07775 918903
> mailto:tony.goodwin@dacttechnologies.com
> 
> +---
> | This is the RPG/400 Mailing List!
> | To submit a new message, send your mail to RPG400-L@midrange.com.
> | To subscribe to this list send email to RPG400-L-SUB@midrange.com.
> | To unsubscribe from this list send email to RPG400-L-UNSUB@midrange.com.
> | Questions should be directed to the list owner/operator:
> david@midrange.com
> +---


************************************************************************************************************************************************************************************************************
This message originates from Lincare Holdings Inc. It contains information 
which maybe confidential or privileged and is intended only for the individual 
or entity named above.
It is prohibited for anyone else to disclose, copy, distribute or use the 
contents of this message. 
All personal messages express views solely of the sender, which are not to be 
attributed to Lincare Holdings Inc., and may not be copied or distributed 
without this disclaimer. 
If you received this message in error, please notify us immediately at 
MailAdmin@lincare.com or (800) 284-2006.
************************************************************************************************************************************************************************************************************
+---
| This is the RPG/400 Mailing List!
| To submit a new message, send your mail to RPG400-L@midrange.com.
| To subscribe to this list send email to RPG400-L-SUB@midrange.com.
| To unsubscribe from this list send email to RPG400-L-UNSUB@midrange.com.
| Questions should be directed to the list owner/operator: david@midrange.com
+---