Re: JavaDoc for PL/SQL

Don't know of an existing tool that does this. Seems like a good idea for those shops with large PL/SQL scripts.

We've replicated JavaDoc for Java (with source browser extensions) using DMS, our generalized compiler technology. See http://www.semdesigns.com/Products/Formatters/JavaHTMLizer.html. This harder than it looks; you basically have to be able to parse the language of interest and resolve name references. We could do this for PL/SQL if it were commercially interesting. It would be probably especially nice if it cross-indexed SQL calls with references to the DDL
defining the tables involved.

--
Ira D. Baxter, Ph.D., CTO   512-250-1018
Semantic Designs, Inc.      www.semdesigns.com

"Tim Cross" <tcross_at_pobox.une.edu.au> wrote in message
news:87adk2392f.fsf_at_blind-bat.une.edu.au...


>

> I was just wondering if there is any tool out there which can work in


> a similar way to the javadoc program for PL/SQL.

>

> I was thinking that a similar tool to javadoc which was able to go

> through the all_source/user_sources table and retrieve comments with

> certain tags to generate html documentation on

> functions/procedures/packages which you have written. The tool could

> be implemented as PL/SQL Server Pages or java servlets and provide web

> based documentation on the locally produced pl/sql code.

>

> It seems this would not be a particularly hard thing to implement and

> could be a useful way of providing up-to-date documentation relating

> to locally written pl/sql. Rather than just rush off an try to

> implement it, I thought I'd first see if anyone has already done

> something similar and second get some feedback regarding what others

> thought of the idea.

>

> Any comments?

>

> Tim

>