[PATCH] D41523: xmmintrin.h documentation fixes and updates

Katya Romanova via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Jan 8 23:54:00 PST 2018


kromanova added a comment.

In https://reviews.llvm.org/D41523#968776, @craig.topper wrote:

> The builtins are tested in tests like test/CodeGen/sse-builtins.c,


Thank you!

I wonder if -Wdocumentation is working... 
I have enabled it for a few tests, like avx-builtins.c, sse-builtins.c and re-run the tests; everything was fine, no errors.

I was suspicious that -Wdocumentation might not be catching the errors and intentionally broke a few doxygen comments in avxintrin.h header for  _mm256_add_pd and _mm256_add_ps (these intrinsics were the first ones used in avx-builtins.c) by mismatching the parameter names in the doxygen comments and in definitions, by removing doxygen comments section describing the parameter names and eventually by removing the entire doxygen comment for these intrinsics. However, -Wdocumentation -Werror haven't reported any errors.

Am I missing something? What kind of "documentation" problems -Wocumentation option catches?


https://reviews.llvm.org/D41523





More information about the cfe-commits mailing list