Skip to Main Content
Feature Request FR-1852
Status ROADMAP

105 Voters

Allow APEX to generate PL/SQL documentation

michael.hichwa APEX Team
· Aug 26 2021

Idea Summary
APEX often makes use of PL/SQL APIs.  And APIs should be documented ideally in an open and standard way.

Use Case
Developer develops PL/SQL APIs.  Developer needs to document these APIs.  Developer uses APEX SQL Workshop to generate PL/SQL documentation.  Documentation can be provided as delivery of systems to clients or for internal organization use.

Preferred Solution (Optional)
Needs to be based on some popular standard including PLDOC or NaturalDoc.  Ideally we can support multiple standards.  Documentation could generate static HTML and or PDF documents.  The documentation would be for inclusion as part of a customer deliverable.  Additionally an APEX starter application could be provided as well that could provide developers easy access to documented PL/SQL APIs.  Each API would provide links to see earlier or subsequent versions.  Changes to APIs would be easily queried.   Beyond the scope of this request is extensible static code analysis, that is another “idea” for consideration.

This is currently on the roadmap for a future release of Oracle APEX.