[PATCH] D15999: Adding doxygen comments to the LLVM intrinsics (part 2, _wmmintrin_pclmul.h)

[Katya Romanova via cfe-commits]

kromanova added a comment.

In http://reviews.llvm.org/D15999#331649, @silvas wrote:

> In http://reviews.llvm.org/D15999#331512, @kromanova wrote:
>
> > In http://reviews.llvm.org/D15999#330794, @silvas wrote:
> >
> > > Also, can you post a patch that changes "all" the headers to have doxygen comments like you intend, so that others can test and verify?
> >
> >
> > Yes, I'll do this. However, there are a couple of things that the people should be aware:
> >  (a) *only* intrinsics that are supported on PS4 will have doxygen comments. PS4 documentation is parsed to generate these comments, and it doesn't document the intrinsics that are not supported on PS4.
>
>
> If we don't have coverage of every intrinsic, we will need to add documentation for Clang developers about the comment format so that future intrinsics (and intrinsics not covered) can be documented.


That was the plan... The consistency of the doxygen documentation will be especially important for the individuals/companies that decide to generate their up-to-date intrinsics guide based on the latest Clang headers. One doesn't want to see differently formatted intrinsics guide.

> 

> 

> > (b) the doxygen comments for the rest (not submitted upstream) headers files might have some problems (typos, incorrect parameter types, bugs in the description, etc). The tool that generates the comments might have some glitches too. Most of this things get fixed after the manual review that I do before I submit the Phabricator code review. So, please don't assume that this is the final version of the header files with doxygen comments.

> 

> 

> Sure. Makes sense.





Repository:
  rL LLVM

http://reviews.llvm.org/D15999