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

Sean McBride sean at rogue-research.com
Wed May 22 13:09:02 EDT 2013


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





More information about the vtk-developers mailing list