Re: Apple LLVM 4.2 (part of Xcode 4.6) checks doxygen comments
Re: Apple LLVM 4.2 (part of Xcode 4.6) checks doxygen comments
- Subject: Re: Apple LLVM 4.2 (part of Xcode 4.6) checks doxygen comments
- From: Sean McBride <email@hidden>
- Date: Mon, 04 Feb 2013 15:10:35 -0500
- Organization: Rogue Research Inc.
On Mon, 4 Feb 2013 11:16:22 -0800, Jens Alfke said:
>
>On Jan 29, 2013, at 1:29 PM, Marshall Clow <email@hidden> wrote:
>
>> If you are commenting your code with doxygen - style comments, (and
>using Xcode 4.6) you should consider adding '-Wdocumentation" to your
>compiler options.
>> When this is enabled, clang will check your doxygen comments and make
>sure that they match the code that they refer to.
>
>This is nice (and it caught several glitches in my doc-comments), but it
>will cause the target to fail to compile in Xcode 4.5 or earlier. I had
>thought Clang would just ignore an unknown warning flag, but no, it’s a
>fatal compile error. :(
>
>I had to back out this change in my project, as I don’t want to break
>Xcode 4.5 compatibility just for the sake of doc-comment checking.
I had a similar problem. I wanted to suppress some -Wdocumentation warnings from 3rd party headers I include, so wrapped my #include in:
#pragma clang diagnostic ignored "-Wdocumentation"
But alas that statement also results in a warning with older clangs. :(
Cheers,
--
____________________________________________________________
Sean McBride, B. Eng email@hidden
Rogue Research www.rogue-research.com
Mac Software Developer Montréal, Québec, Canada
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden