Having this as the document method autotext: /** * This is the brief for the $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$function $SymbolName$ * @param $MethodArgName$ * @return $SymbolType$ */
Produces this for this destructor in a class called NVirtualNumpad: /** * This is the brief for the public function ~NVirtualNumpad * @return */
The final return is missed out after the symbol type.
A better option would be to remove the return line if there is no return type (like in <con|de>structors.
BTW why aren't VAX using standard XML comments? Wouldn't it be cool if you type /// above the funciton name and it would add the comments just like C# does?
we use this in our group, but I had to write my own extension to do that. It would be nice have it done automatically.
As you can see I use DOxygen for my comments. I also program in Java which makes switching from one to the other.
While VAX doesn't give class comments, the fact that the document method is so strong I'll allow them that. Would be nice to finally kill off the macros though.
Generated documentation incorrect for constructors
Posted - Jun 12 2007 : 04:01:27 AM
