Hi folks,
Well, the TOAD HTML Schema Doc report is useful but the output doesn't "look like" the java doc standard. PLDOC gets pretty close(r). We also do Python documentation via epydoc. So ideally all these documentation libraries should have a similar look and feel - i.e. javadoc - as the consumers of the documentation include CMMI auditors. And programmers who switch back and forth between Python and PL/SQL (painful) should use the same documentation comments.
Are there any tricks with CSS and HTML Schema Doc that can do this? Another thing I noticed is that HTML Schema Doc doesn't really treat TYPE objects as code base objects (same as PLDOC I guess). If I create a OO Type Object with lots of method code, ideally I want to see that code similar to code I'd store in a package. I.e. the TYPE is on the same logical level as packages, functions and procedures.
Also while I am ranting a bit. The MDSYS.SDO_GEOMETRY object is almost always just coded as SDO_GEOMETRY. The Oracle public synonym that does the mapping is protected by the system so its a given. I noticed that the TOAD parser get confused in several places and ends up displaying the object as belonging to the current schema. This happens in the HTML Schema Doc as well as in the Schema Browser. So I think its in the parser. TOAD doesn't seem to get confused when the object belongs to SYS. I wonder if thats not a quick fix.
So the answer is I don't have anything better than PLDOC at the moment. I am probably going to need to mock up some my object type code by hand for the next audit :(
It would be great if I could get halfway there with a TOAD HTML schema doc page. If anyone has some nifty CSS files that would help, please post them.
Cheers,
Paul
From: toad@yahoogroups.com [mailto:toad@yahoogroups.com] On Behalf Of Bert Scalzo
Sent: Thursday, November 20, 2008 3:45 PM
To: toad@yahoogroups.com
Subject: RE: [toad] PLDOC?
Why not use Toad? The HTML Schema Doc can be set just to do code :)
From: toad@yahoogroups.
Sent: Thursday, November 20, 2008 2:36 PM
To: 'toad@yahoogroups.
Subject: RE: [toad] PLDOC?
Paul -
What do you use instead...suggestions?
Best,
Jerry
From: toad@yahoogroups.
Sent: Thursday, November 20, 2008 2:14 PM
To: 'toad@yahoogroups.
Subject: RE: [toad] PLDOC?
Hello,
I use it and I think pldoc is great but its rather died on the vine. The project has been dormant since 2006. Its inability to document types is rather distressing. We need a Java person to jump in and take over.
Cheers,
Paul
From: toad@yahoogroups.
Sent: Thursday, November 20, 2008 2:03 PM
To: ToadList
Subject: [toad] PLDOC?
____________
This email was scanned by MessageLabs
____________
______________________________________________________________________
This inbound email was scanned by MessageLabs
_____________________________________________________________________
______________________________________________________________________
This email was scanned by MessageLabs
_____________________________________________________________________