[PATCH] D17550: Adding doxygen comments to the LLVM intrinsics (part 6, popcntintrin.h)

[Romanova, Katya via cfe-commits]

Hi Dmitri,
Thank you for your reply. I have double-checked that compiling a test invoking an intrinsic that has C++ style doxygen comments in the corresponding header doesn't cause compile-time errors/warnings in 
-std=c89 (and in  gnu89, c99, gnu99, c11, gnu11) modes.

I will continue committing the rest of the x86 inrinsics header files with C++-style doxygen comments, unless there are any other objections.
Katya.



> -----Original Message-----
> From: Dmitri Gribenko [mailto:gribozavr at gmail.com]
> Sent: Tuesday, March 01, 2016 1:47 AM
> To: Romanova, Katya
> Cc: Eric Christopher;
> reviews+D17550+public+bc8ce213fd9db980 at reviews.llvm.org; Robinson,
> Paul; Bedwell, Greg; cfe-commits at lists.llvm.org
> Subject: Re: [PATCH] D17550: Adding doxygen comments to the LLVM
> intrinsics (part 6, popcntintrin.h)
> 
> On Mon, Feb 29, 2016 at 10:59 AM, Romanova, Katya
> <Katya_Romanova at playstation.sony.com> wrote:
> > Hi Dmitri,
> >
> > Could you please let us know your opinion about C++ vs C-style doxygen
> > comments. Read this thread for ‘pro’ and ‘con’ arguments about using
> > C++ headers. Will LLVM online documentation look proper if we decide
> > to use C-style headers? Which style do you personally prefer to see?
> 
> There are C comments that both Doxygen and Clang recognize well, equally
> well to C++ comments.
> 
> But I don't think that a change is necessary here.  The reason is that these
> are compiler-internal header files, so they will only be ever parsed by Clang.
> No matter which mode Clang is in, it supports //-style comments, either as a
> part of the language, or as an extension, I believe.
> 
> While it is true that a pure c89 compiler won't be able to parse these
> headers, we are not concerned about these builtin headers used by any
> compiler other than Clang.
> 
> Dmitri
> 
> --
> main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
> (j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/