Search the web
Sign In
New User? Sign Up
toad · Self Help List for TOAD Development Users
? Already a member? Sign in to Yahoo!

Yahoo! Groups Tips

Did you know...
Real people. Real stories. See how Yahoo! Groups impacts members worldwide.

Best of Y! Groups

   Check them out and nominate your group.
Having problems with message search? Fill out this form to ensure your group is one of the first to be migrated to the new message search system.

Messages

  Messages Help
Advanced
PLDOC?   Message List  
Reply | Forward Message #44811 of 49356 |
RE: [toad] PLDOC?

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.com [mailto:toad@yahoogroups.com] On Behalf Of Gerald Novak
Sent: Thursday, November 20, 2008 2:36 PM
To: 'toad@yahoogroups.com'
Subject: RE: [toad] PLDOC?

Paul -
What do you use instead...suggestions?
 
Best,
Jerry
 


From: toad@yahoogroups.com [mailto:toad@yahoogroups.com] On Behalf Of Paul Dziemiela
Sent: Thursday, November 20, 2008 2:14 PM
To: 'toad@yahoogroups.com'
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.com [mailto:toad@yahoogroups.com] On Behalf Of Wendy Penfold
Sent: Thursday, November 20, 2008 2:03 PM
To: ToadList
Subject: [toad] PLDOC?

Hi, Do many people use PLDOC for package documentation?  We have Oracle and Banner software and they both use PLDOC.  For a 'would be nice' suggestion, in the editor etc, Toad shows red lines between procedures and functions in a package, but the PLDOC comments get included with the previous procedure, which is a little confusing--see below.  It would be nice if Toad would recognize the PLDOC comments and include them in the block with the related procedure.






______________________________________________________________________
This email was scanned by MessageLabs
_____________________________________________________________________


______________________________________________________________________
This inbound email was scanned by MessageLabs
_____________________________________________________________________

______________________________________________________________________
This email was scanned by MessageLabs
_____________________________________________________________________


Fri Nov 21, 2008 11:47 am

pdziemiela@...
Send Email Send Email

Attachment
moz-screenshot-48.jpg
Type:
image/jpeg
Forward
Message #44811 of 49356 |
Expand Messages Author Sort by Date

Hi, Do many people use PLDOC for package documentation? We have Oracle and Banner software and they both use PLDOC. For a 'would be nice' suggestion, in the...
Wendy Penfold
wpenfold@...
Send Email
Nov 20, 2008
7:21 pm

I wonder if anyone handles their comments differently. It just seems natural that the high-level comments for a function precede the function itself. RAS ... ...
Simoneau, Roger
rsimonea@...
Send Email
Nov 20, 2008
8:26 pm

I agree Roger. That is what we do within a package. This was discussed a number of months ago. I believe the issue was with the parser having to back up...
Reed, David A.
dareed51
Offline Send Email
Nov 20, 2008
10:30 pm

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...
Paul Dziemiela
pdziemiela@...
Send Email
Nov 20, 2008
8:29 pm

Paul - What do you use instead...suggestions? Best, Jerry ________________________________ From: toad@yahoogroups.com [mailto:toad@yahoogroups.com] On Behalf...
Gerald Novak
geraldnovak
Offline Send Email
Nov 20, 2008
8:36 pm

Why not use Toad? The HTML Schema Doc can be set just to do code :) ________________________________ From: toad@yahoogroups.com [mailto:toad@yahoogroups.com]...
Bert Scalzo
bert.scalzo
Offline Send Email
Nov 20, 2008
8:44 pm

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...
Paul Dziemiela
pdziemiela@...
Send Email
Nov 21, 2008
1:12 pm

Good feedback - I'm going to defer to John (who owns Schema Doc generator) - I know you can modify the CSS (but I'm an HTML idiot). But good ideas - maybe John...
Bert Scalzo
bert.scalzo
Offline Send Email
Nov 21, 2008
1:17 pm

... Attached is the format I use. It's mainly used for ORAPig, which generates Python interfaces for packages. I don't like all that @param business... it's...
Mark Harrison
marhar62
Offline Send Email
Nov 20, 2008
10:30 pm
Advanced

Copyright © 2009 Yahoo! Inc. All rights reserved.
Privacy Policy - Terms of Service - Guidelines - Help