[vtk-developers] Clang: Unknown command tag name warning

[David E DeMarle]

This is what I think is happening:
* libxml2 uses gtk-doc instead of doxygen.
* our third party warnings prevention (VTK_THIRD_PARTY_WARNING_SUPPRESS
from CMake/vtkThirdParty.cmake) is preventing warnings from the compilation
of the libxml2 itself.
* your clang dashboard is the first one to try -Wdocumentation, which
chases the header from IO/Infovis/vtkXMLTreeReader.cxx (which isn't
suppressed) into libxml/include/hash.h .

I think the right thing to do is to add a global suppression for this case.
Pushing a patch to gerrit now.
Sean can you try it on one of the affected builds and see if it works?




David E DeMarle
Kitware, Inc.
R&D Engineer
21 Corporate Drive
Clifton Park, NY 12065-8662
Phone: 518-881-4909


On Wed, May 22, 2013 at 1:09 PM, Sean McBride <sean at rogue-research.com>wrote:

> On Mon, 20 May 2013 10:06:34 -0400, Bill Lorensen said:
>
> >I have tried to fix these warnings:
> >http://open.cdash.org/viewBuildError.php?type=1&buildid=2910415
> >
> >@relates and \relates are proper doxygen comments. It is possible that
> this
> >is a bogus warning?
>
> So there are a bunch more warnings from the ThirdParty libxml2, ex:
>
> /Users/builder/external/VTK-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/hash.h:92:4:
> warning: unknown command tag name 'data'; did you mean 'date'?
> [-Wdocumentation]
>  * @data:  extra scannner data
>    ^~~~~
>
> The code is:
>
> /**
>  * xmlHashScannerFull:
>  * @payload:  the data in the hash
>  * @data:  extra scannner data
>  * @name:  the name associated
>  * @name2:  the second name associated
>  * @name3:  the third name associated
>  *
>  * Callback when scanning data in a hash with the full scanner.
>  */
> typedef void (*xmlHashScannerFull)(void *payload, void *data,
>                                    const xmlChar *name, const xmlChar
> *name2,
>                                    const xmlChar *name3);
>
> Any doxygen experts out there?  I thought you needed use @param, like so:
>
>  @param data : extra scannner data
>
> In any case, isn't there a mechanism to suppress warnings from 3rd party
> code on the dashboard?  I'd hate to disable -Wdocumentation everywhere in
> VTK because of this.
>
> Cheers,
>
> --
> ____________________________________________________________
> Sean McBride, B. Eng                 sean at rogue-research.com
> Rogue Research                        www.rogue-research.com
> Mac Software Developer              Montréal, Québec, Canada
>
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/vtk-developers/attachments/20130604/aaf3433c/attachment.html>