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: Jens Alfke <email@hidden>
- Date: Mon, 04 Feb 2013 11:16:22 -0800
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.
—Jens |
_______________________________________________
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