Documenting the private procedures of a package with plsqldoc

Bergeroy

Member²
Hi,

With javadoc, we can document every method of a class, private or public.

With plsqldoc, for a package, we are only able to document and publish in HTML the public part of a package. That is useful for the users of the package but not for the maintainers.

Yes, we are able to comment the private part (body) of the package but not to generate that documentation in HTML.

Is this something already somewhere on a wishlist ?

Thank you
 
This is indeed on the list of enhancement requests. There will be some restrictions, because to determine whether a program unit is private or public, the plsqldoc tool needs to know the contents of the package specification. Alternatively you could declare elements as private or public in the documentation comments.

------------------
Marco Kalter
Allround Automations
 
Back
Top