Generating documentation for this package specification is not correct - it will ignore all contents after a second line comment is found in combination with the
tags and custom plsqldoc tags...
Try it to see what I mean.
This section is wrong:
I included a full example with and without custom tags. Also I defined #! as a line prefix, so it doesn't show up in the documentation. We use special tags like --! / #! to identify code sections we are going to remove when shipping a next full release of our product.
Full spec:
Code:
Try it to see what I mean.
This section is wrong:
Code:
%History
<code>
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text.
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text. This line should show up in the
#! documentation but it is not.
#! 01/01/01 XX NNNNNN This line should show up in the documentation but
#! it is not.
This line should show up also...
</code>
Full spec:
Code:
CREATE OR REPLACE PACKAGE test
/**
This is test comment
<code>
-- 01/01/01 XX NNNNNN This is a test comment test with multiple lines
-- of text.
-- 01/01/01 XX NNNNNN This is a test comment test with multiple lines
-- of text. This is a test comment test with
-- multiple lines of text.
-- 01/01/01 XX NNNNNN This is a test comment test with multiple lines
-- of text.
</code>
<code>
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text.
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text. This is a test comment test with
#! multiple lines of text.
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text.
</code>
%Usage
<code>
-- 01/01/01 XX NNNNNN This is a test comment test with multiple lines
-- of text.
-- 01/01/01 XX NNNNNN This is a test comment test with multiple lines
-- of text. This is a test comment test with
-- multiple lines of text.
-- 01/01/01 XX NNNNNN This is a test comment test with multiple lines
-- of text.
</code>
%History
<code>
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text.
#! 01/01/01 XX NNNNNN This is a test comment test with multiple lines
#! of text. This line should show up in the
#! documentation but it is not.
#! 01/01/01 XX NNNNNN This line should show up in the documentation but
#! it is not.
This line should show up also...
</code>
*/
IS
/**
test text
*/
PROCEDURE test_1;
END;