[Insight-developers] KWStyle errors about '\class'

[Luis Ibanez]

Hi Arnaud,

Why are we removing the "\class" from these files ?

Is it to exclude them from showing up in the Doxygen page ?

If so, why not do that by using the "EXCLUDE" field in
lines 660-665 of the file

       ITK/Utilities/Doxygen/doxygen.config.in

?

-----

For the record,
the error that KWStyle produces is generated in
line 207 of kwsCheckComments.cxx in the KWStyle code.

There is not a Feature flag associated specifically with
checking for "\class", but you could disable the full check
for comments in these files by doing:

diff --git a/Testing/Data b/Testing/Data
index 2b02dd2..9e3b3ef 160000
--- a/Testing/Data
+++ b/Testing/Data
@@ -1 +1 @@
-Subproject commit 2b02dd22524fda6e4062d6db08c24abd64313228
+Subproject commit 9e3b3ef32e5fcae1dc54d80534c8dab24248a9d6
diff --git a/Utilities/KWStyle/ITKOverwrite.txt
b/Utilities/KWStyle/ITKOverwrite.txt
index 67e4840..9174fe0 100644
--- a/Utilities/KWStyle/ITKOverwrite.txt
+++ b/Utilities/KWStyle/ITKOverwrite.txt
@@ -99,6 +99,16 @@ itkNumericTraitsFixedArrayPixel.h InternalVariables Disable
 itkNumericTraitsRGBPixel.h InternalVariables Disable
 itkNumericTraitsRGBAPixel.h InternalVariables Disable
 itkNumericTraits.cxx Typedefs Disable
+itkNumericTraitsArrayPixel.h Comments Disable
+itkNumericTraitsPointPixel.h Comments Disable
+itkNumericTraitsCovariantVectorPixel.h Comments Disable
+itkNumericTraitsTensorPixel.h Comments Disable
+itkNumericTraitsVectorPixel.h Comments Disable
+itkNumericTraitsDiffusionTensor3DPixel.h Comments Disable
+itkNumericTraitsFixedArrayPixel.h Comments Disable
+itkNumericTraitsRGBPixel.h Comments Disable
+itkNumericTraitsRGBAPixel.h Comments Disable
+itkNumericTraits.cxx Comments Disable
 itkObjectFactoryBase.cxx Namespace Disable
 itkSecondaryNodeList.h InternalVariables Disable
 itkSimplexMeshGeometry.h InternalVariables Disable


That said,
It looks like we are propagating code changes
for something that should have been a Doxygen
configuration change instead.


        Luis


-------------------------------------------------
On Thu, May 12, 2011 at 2:38 PM, Arnaud GELAS
<arnaud_gelas at hms.harvard.edu> wrote:
> Hi all,
>
> Last week, I have sent an email about potential KWStyle errors when removing
> the doxygen command \class in NumericTraits classes...
> I did not get any answer by that time (how to disable this condition check
> on these files).
>
> I have submitted a patch on gerrit:
>    http://review.source.kitware.com/#change,1603
>
> KWStyleCodeTest passed on Kitware's robot:
>    http://www.cdash.org/CDash/viewTest.php?onlyfailed&buildid=1104270
>
> Reviewers checked it, and this change was merged...
>
> Looking at the dashboard, it appears to me that this test is actually
> failing...
>    http://www.cdash.org/CDash/testDetails.php?test=96034164&build=1120218
>
> Would it be possible to disable this condition on these files???
>
> Thanks,
> Arnaud
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://kitware.com/products/protraining.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-developers
>