Doxygen warnings for missing parameter comments

[GoogleCodeExporter]

Doxygen warnings have highlighted a bunch of slightly out of date comments in 
Recast and Detour.

In Recast this is largely because the ctx parameter is not commented. Also 
maxMergeRegionArea has been renamed(?) mergeRegionArea.

In Detour the layer parameter has been added but isn't commented.

See attached log for more info.

Original issue reported on code.google.com by cameron....@gmail.com on 7 May 2011 at 9:40

Attachments:

• recast.log

[GoogleCodeExporter]

I forgot to say the other warnings are about array lengths in parameter names, 
e.g. 
/// @param endPos[3] [in] End location.

Doxygen doesn't like that. I'd suggest putting the length in the comment 
description instead.

Original comment by cameron....@gmail.com on 7 May 2011 at 9:42

[GoogleCodeExporter]

I'll resolve these as part of the documentation effort, as each header file is 
updated.  So this issue will be fully resolved near the end of the effort.

Original comment by steve...@gmail.com on 16 Aug 2011 at 1:48

• Changed state: Accepted
• Added labels: Priority-Low, Type-Other
• Removed labels: Priority-Medium, Type-Defect

[GoogleCodeExporter]

All warnings that can be addressed without changing code have been eliminated.  
The only ones remaining are some warnings about documentation for parameters 
that don't exist.  These are due to some declarations that don't specify 
parameter names.

Original comment by steve...@gmail.com on 13 Sep 2011 at 11:44

• Changed state: Done