plsqldoc & Package Bodies documentation

[Axel Romahn]

Currently I'm trying out PL/SQL Developer (v6.0.5)and plsqldoc as an alternative of our internal standard PL/SQL-Editor-Tool. So far so good..but what I miss is the feature to generate the documentation of a package body (I've read the topic from April 2003 with the same issue).

In the meantime is this feature on your todo-list? It would be very, very nice and helpful for us ... (maybe as an option in the preferences "Generate private documentation"?)

Axel
---
Axel Romahn
Software Engineer
Gruner+Jahr AG & Co KG

 

[ScottMattes]

I don't understand, when I right click on a package and select 'generate documentation' and then right click and select 'view doc' I see it.

 

[Axel Romahn]

If I do so, then what I see is the generated documentation of the (public) package specification. But what I need is a documentation of the private part - the package body.

An right clicking on "Package Bodies" I haven't any 'Generate documentation' item in the context menu ....

Axel

 

[D.]

Why would you want "Public" documentation on a "Private" package body ? Seems crazy to me! The only documentation you need should be in the specification, as only this needs published. Anyone wanting the body docs would probably want to see the code anyway, so just read the comments in there.

Just my tuppence worth.

D.

 

[Axel Romahn]

I want both. An external (and public) documentation of my public interface and an internal documentation for helping other developers to navigate through the source code.

Things I like to do, e.g.:

• print out the generated documentation as quick reference.
• a web-based documentation of the complete source code.

I agree with you, that the only documentation for "the public" should be the documentation of the specification. But what about large packages? Wouldn't it be easier for other developers to have a smart-looking, clickable documentation of the package body (optional with a reference back to the procedure in source code)?

 

[Marco Kalter]

We'll have a plsqldoc 1.2 version available shortly, which has the ability to generate documentation from package bodies and type bodies. It should be released early next week. I can send you a pre-release if you want.

 

[Axel Romahn]

Great! And yes, please send me the pre-release, so that I can impress my boss and my colleagues.

Thx, Axel.

 

[Marco Kalter]

You can download a plsqldoc 1.2 pre-release version here .

If anyone else wants to try it, please note that this is a pre-beta release, and that you should backup your existing documentation directories before installing it.

The new features in this build are:

• Package body and Type body documentation support added
• Index is now always available in a separate frame
• Support for the % sign as the tag character (e.g. %param) to prevent SQL*Plus issues with the # and @ character
• Custom tag configuration added