|
PLDocer generates API Documentation from PL/SQL code. PLDocer parses the declarations
and documentation comments from one or more PL/SQL source files or sources stored
in the database. It also produces corresponding HTML pages describing packages,
procedures, functions, triggers, menu code, object libraries, and variables.
Additionally, an index and a list of obsolete code can be produced.
PLDocer uses javadoc like comment tags, produces a javadoc look and feel,
and provides for additional comment tags. It allows a user to document one
or more files or sources stored in the database. PLDocer is a command line
utility that supports the generation of PL/SQL source files which contain:
Oracle 7.x, 8.x, and 9.x stored packages, procedures, and functions; Oracle Forms 4.5,
5.0, 6.0, and 9.x including menus, plls, and object libraries; and Oracle Reports 2.5,
3.0, 6.0, and 9.x. Additionally PLDocer supports the generation of PL/SQL from the database
stored in procedures, functions, and packages.
Build custom templates to present documentation in a custom look and feel.
Multiple application/project support.
Advantages for using PLDocer:
- Producing an API will lend toward reuse of code. Provides developers with a place to see what code has already been developed before developing new functionality that may already exist.
- Since PLDocer is a command line utility, execution can be controlled through automated processes such as: batch, Version control systems (on check-in or check-out), or database triggers (oracle 8i and 9i only).
- Since PL/SQL documentation is stored in HTML files, all users with a browser can view the documentation.
- If your company already has an existing or future java project, developers will become familiar with javadoc documentation commenting.
- PLDocer is written in 100% pure Java, allowing PLDocer to run on many platforms.
- Promotes the use of code comments.
|