[Insight-developers] Questions about Doxygen Warnings

[David Cole]

You could document unnamed (itkNotUsed) params without using "@param"
-- just talk about them in the text instead. That would eliminate that
doxygen warning.


On Thu, Sep 15, 2011 at 1:04 PM, Williams, Norman K
<norman-k-williams at uiowa.edu> wrote:
> See here:
>
> http://www.cdash.org/CDash/viewBuildError.php?type=1&buildid=1533121
>
> 1. ImageRegionIterator.h and ImageRegionConstIterator.h both \document the
> same example.
>
> It seems to me that it SHOULD be documented both places.  Should this
> warning be suppressed? should one of the \document ImageRegionIterator.cxx
> be removed? Should ImageRegionConstIterator get its own example?
>
> 2. In the FEM headers there's a repeated issue with the
> itk::FEMLoadBase::SetSolution() method's documentation.  The problem is
> that for reasons I'm not entirely clear on, SetSolution is a dummy in
> FEMLoadBase, and to avoid warnings about the parameter being unused, the
> itkNotUsed macro is used in the declaration.  This keeps Doxygen from
> seeing the parameter.
>
> So either we get a compile time warning, or a Doxygen-generation time
> warning. Is it possible to get rid of both warnings at once?
>
> 3. same as #2 for itkFEMSolver.h
>
>
> Kent Williams norman-k-williams at uiowa.edu
>
>
>
>
>
>
> ________________________________
> Notice: This UI Health Care e-mail (including attachments) is covered by the Electronic Communications Privacy Act, 18 U.S.C. 2510-2521, is confidential and may be legally privileged.  If you are not the intended recipient, you are hereby notified that any retention, dissemination, distribution, or copying of this communication is strictly prohibited.  Please reply to the sender that you have received the message in error, then delete it.  Thank you.
> ________________________________
> _______________________________________________
> 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
>