plsqldoc comment handling

fraenkg

Member³
Hi,

we use 'old fashion style' documentation of package func/proc's with sql comments like:

function T_TestFunc ( -- this is for test only
-- ===========================================
/* Description:
some description
*/
-- ===========================================
fpnParam1 in TAB.COL1%type, -- int;decription
fpsParam2 in TAB.COL2%type, -- varchar(20);
) return pls_integer -- 0=o.k. else errno
;
-- ===========================================

until plsqldoc 1.4. the comments are includet in doc output. But v1.4.0 only show empty rows for the header and also no comment for parameter.

Is their a new switch enabling output of comments?

thx
fraenk
 
2. we use packages (func/proc) and also views to encapsulate db- structures. The developer outside the db (e.g. develope business logic for application server) only know provided package functions and views (if their is no function returning result set). So the documentation for views does not need to show the implementation text. But it would be nice to have the option to extract default value and description of used columns from the tables behinde the view.

thanks again
frank
 
All comment is stipped from the specification. Maybe we can create an option for this. I have added this to the list of enhancement requests.
 
Back
Top