[Insight-developers] kwstyle - doxygen - partial template specialization

[Arnaud GELAS]

Hi all,

It took me a while to figure out to remove such a kind of warning in 
doxygen (for partial template specialization), and to make it appear 
correctly in doxygen:

/home/ajg23/DOCUMENTATION/ITK_Static_Release/ITK/Modules/Core/Common/include/itkNumericTraitsCovariantVectorPixel.h:26: 
warning: the name `CovariantVector' supplied as the argument of the 
\class, \struct, \union, or \include command is not an input file
/home/ajg23/DOCUMENTATION/ITK_Static_Release/ITK/Modules/Core/Common/include/itkNumericTraitsDiffusionTensor3DPixel.h:28: 
warning: the name `DiffusionTensor3D' supplied as the argument of the 
\class, \struct, \union, or \include command is not an input file


Right now all specialization documentation appear in NumericTraits, see 
http://www.itk.org/Doxygen/html/classitk_1_1NumericTraits.html

To solve this problem, we *MUST *remove /\class/ in all these files and 
document each template parameter via /\tparam/. Then it works fine!

However KWStyle enforce all class to have /\class/...

After running some experiments, it appears that /\class/ is not 
mandatory for any class; doxygen will automatically generate the class 
documentation even if there is no \class marker.

So would it be possible to relax this constraint in KWStyle in order to 
improve doxygen documentation?

Thanks,
Arnaud
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.itk.org/mailman/private/insight-developers/attachments/20110506/0322e6e9/attachment.htm>