[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#330794, @silvas wrote:

> This may sound stupid, but: can you benchmark the time it takes to build some project (that actually uses intrinsics in most translation units, e.g. a game) with the headers w/ and w/o the doxygen comments to check that all the extra comment skipping doesn't affect compilation time? I.e. run your script to add the comments for "all" the intrinsic headers (similar to what you expect the final state to be after all these patches) and test the build time of a game (and compare with the unmodified headers).


This makes sense. I can do this, though it might take a couple of days, since I don't have a setup for a game build.
I suspect that that we shouldn't use an application/game that is using precompiled headers. Any other limitation should be imposed on the beanchmark?

> 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.
(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.


Repository:
  rL LLVM

http://reviews.llvm.org/D15999