Changing JavaDoc class function description

[Martijn van der Kooij]

Hi, currently I use Javadoc style comments. For each class function the following comment lines are generated:

Code: [Select]

/**
* @param aPathName
* @param index
*
*/

I would like it to be something like:

Code: [Select]

/**
* <function name>
* <detailed description>
* @brief  <short description>
* @param  <parameter description>
* @param  <parameter description >
* @see    <related function>
* @return <return value description>
*/

Does somebody know's how I could generate such comments? Or How I can alter the way JAVADOC_COMMENT works?

[Eve]

You can't modify the way JAVADOC_COMMENT works, but there are two ways I can think of to do what you want.

The firstly you can create a custom template for the parameters so that you can list over them.  The rest of the information there is available at the operation notes template. The list would look something like this.
%list="Parameter__JDoc" @indent=" * " @separator="\n"%[/code]

Alternatively you could use the FIND, MID, LEFT etc macros to pull apart the result of JAVADOC_COMMENT and insert the parts that you want.

With a bit of playing around you should be able to generate comments in the way you want.

Simon