plsqldoc - multiline comments

[shunte]

I'm setting up templates for use by the development team, these templates include plsqldoc tags.

Part of the process is generating example documentation with the tags insitu so I can give specific examples to the developers.

Many of the function/procedure headers have revision history with multiline "comments".

Generating and reviewing documents I see exhibits like this :

:cr. REVISIONS::cr. DATE AUTHOR DESCRIPTION:cr. ---------- ---------------:cr. 03/05/2012 SXH Example yadda yadda..

I've tried with and without , the above is with, and the same run-on line is obtained

If I look at any of the source tables in Oracle and see the code as I'd expect, comments are multi-line

i.e. in user_source the line breaks are as expected

How is plsqldoc obtaining and interpreting the source text?

I thought maybe I was seeing Unix/PC formatting issue but that does not appear to be the case, I've compiled with the source saved in both flavors and the same result is obtained

 

[Marco Kalter]

Can you show an example of such a function/procedure header?

 

[shunte]

the revision section is an example, when plsqldoc generated those 5 lines get rolled into one

/****************************************************************************************
PROCEDURE: TOTALSUM

PUBLISHED: PUBLIC

PURPOSE: Develops simple summed statistics
(TOTAL PAGE VIEWS, TOTAL HOURS VIEWED, ACTIVE NETSESSIONS, REQUESTS,
TOTAL DRM LICENSES, TOTAL MILLION PLAY ATTEMPTS)

@param p_query_template Query template name from STAT_QUERY_TEMPLATE
@param p_flag_col Flag column in data table to join in MQT.
@param p_data_table Data table containing records which MQT is retrieving.
@param p_data_col Data columns used in MQT for statistics calculation.
@param p_hits_col Hits column used in MQT for statistics calculation.

REVISIONS:
DATE AUTHOR DESCRIPTION
---------- --------------- -----------------------------------
2013/02/28 SXH CR2028349 zero order statistics
02/28/2013 PBJ Added logic for CR 1987867
2013/02/06 SXH Minor code cleanup
2013/02/06 SXH CR 2027971, 2028358 - additional instrumentation
2012/09/09 MDP Initial Comment setup
****************************************************************************************/