plsqldoc

[D.]

Is there any way to execute plsqldoc generation from outside the IDE ?

We would like to use the plsqldoc interface, but not all developers have migrated on to using the IDE as of yet. We have put standards in place for comment tags, but until the generator is run against the code from PLSQL Developer, there is no way (that I can see) for the developer to verify that the documentation will display correctly. OK, so a DBA can run the generator against any code not already documented periodically, but it may be too late by the time the DBA gets round to it.

Would be nice if there was an interface into using the plsqldoc plugin, say from the command line, that could be run by anyone - or from within SQL*Plus (even better).

Any ideas ? Or is this an enhancement request ?

 

[Marco Kalter]

You cannot run the plsqldoc Plug-In outside the PL/SQL Developer IDE. We don't have any short-term plans for this.

You can perform batch execution from the command-line within the Command Window though.

 

[Bo Pedersen]

It would be nice, if PL/SQL Developer automatically could execute a script when started from the OS command line with a file and complete after execution.

This would allow the before mentioned plsql documentation to be genereated from the OS command line. Likewise with reports etc.

This functionality would allow an integration of these facilities into an automatic build procedure. So when generating a new build, one can be certain that the plsql documentation is up to date instead of relaying on each individual developer has remembered to regenerate the documentation. Our goal is that a build shall require as few manual step as possible. A manual step in repetive tasks increase the risk of human errors.

Bo Pedersen

 

[Marco Kalter]

This is in fact planned for 6.0.

 

[ScottMattes]

Speaking of which, how is it looking for release?

I feel like I did just before Christmas as a child (well, I haven't grown up much since then).

 

[Marco Kalter]

We'll have a beta this month, and a production release will follow shortly after, depending on beta feedback.

 

[mike_2005]

Is this "execute a script on startup" implemented now? If so, is there some documentation on how to use it?

I too am wanting to run the plsqldoc generation from an automated build script.

 

[Marco Kalter]

To automate the generation of plsqldoc documentation, you can create a Command File that calls the plsqldoc generator. For example:

plugin plsqldoc generate department
plugin plsqldoc generate dept emp
exit application

The first command generates the documentation for the "department" package, and the second for the "dept" and "emp" tables. The 3rd command (exit application) will exit PL/SQL Developer.

This script can run in the Command Window, and you can call PL/SQL Developer to log on, run the script and exit:

plsqldev.exe userid=scott/tiger commandfile=gendoc.sql

I hope this helps.