Re: JavaDoc for PL/SQL
Date: Thu, 28 Nov 2002 10:22:15 +0100
Message-ID: <3de5e060$0$145$edfadb0f_at_dread14.news.tele.dk>
Hi Tim.
In January 2003 we will release the first beta version of our tool that does just that and much more -- it also documents all the other Oracle objects such tables, views, indexes, queues, queue tables, materialized views, sequences, and jobs, and it also documents dependencies (using/used by). The documentation is generated to a repository based on which you can create your own PL/SQL Server Pages (using Oracle's or ChangeGroup's PL/SQL Server Pages). A standard set Javadoc-like PSPs are included but you can create your own, eg for handling RTF or PDF for printed documentation.
For more information, please refer to ChangeGroup Open System Documentary at http://www.changegroup.biz/en/cgosd.psp. Please contact us if you would like to join the beta program.
HTH. Finn Ellebaek
-- --------------------------------------------------------------------------- Finn Ellebaek Nielsen ChangeGroup ApS Product Manager, Principal Consultant, Partner Kronprinsessegade 54, 4. E-mail: finn.ellebaek.nielsen_at_changegroup.dk DK-1306 Koebenhavn K Mobile: +45 20 32 49 25 Denmark Phone: +45 33 32 77 78 http://www.changegroup.dk --------------------------------------------------------------------------- "Where do you want to GPF today?" "Tim Cross" <tcross_at_pobox.une.edu.au> wrote in message news:87adk2392f.fsf_at_blind-bat.une.edu.au...Received on Thu Nov 28 2002 - 10:22:15 CET
>
> 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
>