PL/SQLDoc schedule?

Ed Delaney

Member²
Can you share your schedule for an update pl/sqldoc plugin?

We're still working around a few issues with pl/sql doc. In particular we have to put a blank line after the end of the fist fomal comment block /***/ in the package header doc section or that section is not recognized. I'm also finding if I document a procedure with formal comment block /** */ and follow with a -- comment line, it does not see the comment block even if I have the pl/doc settings set to only recognize formal comments. Thanks.
 
Can you send me an example of these 2 problems to make sure that they have or will be fixed? We'll release a new plsqldoc patch release shortly.
 
This first one fails to generate the package header doc, as well as the doc for function_test2.

CREATE OR REPLACE PACKAGE efdtest AS
/**
* This is a test of formal comments with NO BLANK LINE FOLLOWING
*/
dummy_variable NUMBER;
/** this is function doc for Function_test with FUNCTION immediately following
*/
FUNCTION Function_test1 RETURN NUMBER;
/** this is function doc for Function_test with a -- comment line following
*/
--
FUNCTION Function_test2 RETURN NUMBER;
END efdtest;

CREATE OR REPLACE PACKAGE BODY efdtest IS
FUNCTION Function_test1 RETURN number IS
BEGIN
RETURN(1);
END;
FUNCTION Function_test2 RETURN number IS
BEGIN
RETURN(1);
END;
BEGIN
null;
END efdtest;

This next one has a blank line after the first */, so the header doc is generated, and the -- comment line in function_test2 is removed, so both functions document correctly.

CREATE OR REPLACE PACKAGE efdtest AS
/**
* This is a test of formal comments with NO BLANK LINE FOLLOWING
*/

dummy_variable NUMBER;
/** this is function doc for Function_test with FUNCTION immediately following
*/
FUNCTION Function_test1 RETURN NUMBER;
/** this is function doc for Function_test with a -- comment line following
*/
FUNCTION Function_test2 RETURN NUMBER;
END efdtest;

thanks
 
Back
Top