PLSQLDOC globals

[Jeff Ward]

I have a number of global record and table types in my package spec. How can I document these in plsqldoc. For example

gRec1 Rec1_REC_TYPE ; -- Global record based on Rec1_REC_TYPE

gTab1 Tab1_TAB_TYPE ; -- Global table based on Tab1_REC_TYPE

etc.

 

[Marco Kalter]

The variables will be included in the documentation as specified, with the comment as descrption. I assume this doesn't work for you?

 

[Jeff Ward]

No its not working.

Normal types, function parameters etc. are being documented fine, I assume these are not because there is no keyword i.e. TYPE, PROCEDURE etc. to be picked up?

I guess what is needed is a global section, similar to the way constants are documented?

 

[Marco Kalter]

It should be working, and it works okay when I try it. Can you send me the complete package specification by e-mail?

 

[Jeff Ward]

Sorted this now, my fault!

I seperate my comments etc. with a line of ----- to try and make it more readable but in this case I had two lines of ----- and this obviouslly confused it!

 

[Marco Kalter]

I see, that would indeed explain it. Maybe plsqldoc should ignore comment that consists merely of hyphens.

 

[Jeff Ward]

No problem - It does already, originally my code sections were seperated with comments such as this :-

--=========================================
-- Global variable to do something
--=========================================
gVar01 Tab01_TAB_TYPE ;

but this was putting the === into the documentation and looked ugly.

I experimented and tried this:-

-------------------------------------------
-- Global variable to do something
-------------------------------------------
gVar01 Tab01_TAB_TYPE ;

Then the ---- lines are not shown in the documentation, which is what I want and looks OK.

For some reasone it was not working when I tried this:-

-------------------------------------------
-------------------------------------------
-- Global variable to do something
-------------------------------------------
-------------------------------------------
gVar01 Tab01_TAB_TYPE ;

But I cant recreate this problem now!!