[Insight-developers] NumericTraits need Doxgen

[Cory Quammen]

Brad,

Arnaud will revert this commit. I've added you as a reviewer for a new
patch where only the specializations are excluded.

http://review.source.kitware.com/#change,1291

Thanks,
Cory

On Wed, Mar 30, 2011 at 4:36 PM, Bradley Lowekamp
<blowekamp at mail.nih.gov> wrote:
> Arnaund,
> I see a recent commit which exclude all NumericTraits from the Doxgen.
> Now that we have partial specialization for the numeric traits there is
> quite a reasonable number of them. Given how useful they are and how most
> people should use them more frequently it would be quite a shame for them
> not to be documented with doxygen. It would be bad for them to remain a
> hidden feature to some users.
> If that is not acceptable at least we should have the templated version
> documented, and the specializations excluded. You can use the Doxgen "\cond"
> and "\endcond" with a pseudo define, which is not really defined. I did it
> here in SimpleITK:
> https://github.com/SimpleITK/SimpleITK/blob/master/Code/Common/sitkEnableIf.h
> where SPECIALIZATION_IMPLEMENTATION is not defined for documentation.
> Brad
>
>
> ========================================================
>
> Bradley Lowekamp
>
> Lockheed Martin Contractor for
>
> Office of High Performance Computing and Communications
>
> National Library of Medicine
>
> blowekamp at mail.nih.gov
>
>
> _______________________________________________
> 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
>
>



-- 
Cory Quammen
Computer Integrated Systems for Microscopy and Manipulation (CISMM)
Department of Computer Science
University of North Carolina at Chapel Hill
http://www.cs.unc.edu/~cquammen