plsqldoc - how to document package body?

Brujo_ADR

Member
first than all (excuse my english) :D
second, hi everybody :)

:confused:
aim using this plug-in (plsqldoc) without problems to document package especification, but, when I try document a package body can't see the comments used by the programmers, how to get this comments?

Greetings.
 
I assume you are using plsqldoc version 1.2, and that you are explicitly selecting the package body to generate the documentation?

If so, can you send me such a package body?
 
Originally posted by Marco Kalter:
I assume you are using plsqldoc version 1.2, and that you are explicitly selecting the package body to generate the documentation?

If so, can you send me such a package body?
hi Marco, aim try the last version on pl/sql developer with the last plsqldoc. May be my explication is not so good. Let's try a example:

create or replace package PK_TEST is

-- 1) PL PR_TEST SPECIFICATION
PROCEDURE PR_TEST;

end PK_TEST;
/
create or replace package body PK_TEST is

-- 2) PL PR_TEST BODY
PROCEDURE PR_TEST
AS
BEGIN
-- comment3
NULL;
-- comment4
-- comment5
END PR_TEST;

end PK_TEST;
/

When generate document can see, comment 1 & 2 but 3,4 & 5 no.
Question: how to get the comment's 3,4 & 5 with the tool "plsqldoc"???? or is not possible?
 
This is not possible. Only the first comment block before or after the declaration of an element is included in the documentation for that element. Comments inside the PL/SQL code is regarded as internal code documentation.
 
Back
Top