plsqldoc isn't getting program unit comments

[Cornell]

I've a package which contains a function that has comments above it. I go to Tools / plsqldoc / Generate Document, and when I check the resulting page, the comments aren't there.

The code is:

/*
Compute the duration, in hours, from duration, units and training_type. Also sets some
defaults, if duration is null.

%return Duration in hours
%param DUR IN NUMBER Duration in UNITS
%param UNITS IN VARCHAR2 Units of time, such as MI(nutes, H(ours, D(ays, W(eeks, M(onths and Y(ears
%param TRAINING_TYPE IN VARCHAR2 Either WBT or ILT. Duration defaults depend upon Training Type
*/
FUNCTION COMPUTE_DURATION(DUR IN NUMBER, UNITS IN VARCHAR2, TRAINING_TYPE IN VARCHAR2) RETURN NUMBER
IS
etc.

The result is:

COMPUTE_DURATION
Function COMPUTE_DURATION(DUR IN NUMBER,
UNITS IN VARCHAR2,
TRAINING_TYPE IN VARCHAR2) RETURN NUMBER

None of the comments show up :-(

 

[Marco Kalter]

Perhaps you have enabled the "Strict comments" option? When enabled, only comments that start with /** will be used as documentation. This allows you to explicitly separate documentation comments from other comments.

 

[Cornell]

Mea Culpa...

Yes, I have strict comments selected, for the reasons you suggest.

But I read it as '/*', not '/**'.

Changed the starting comment to '/**' and it's working fine.

Thank Marco