[PATCH] Adding doxygen comments to the LLVM intrinsics (part 1, ammintrin.h)

[Katya Romanova]

Thanks for the review Dmitri! My concern is that this header file is only the tip of the iceberg. We still have 800 more intrinsic comments to go. Hopefully, there will be someone else who could help with the reviews. I'm afraid to burden you.

> > You realize that once you commit these comments to header files, other people can (and would) edit them in a way that might be incompatible with your documentation guidelines, right?

> 


Yep. That's the goal. We will have a post-run formatting script that will take care of all incompatibilities. The only hope is that all format-related incompatibilities will be consistent in the future. If format changes happens, we will have to adjust our post-running script to continue generate the documentation that we want. I know that it will be probably quite hard to enforce the consistency for intrinsics comments (unless -Wdocumentation could do it automatically :) ). When we are merging with upstream, we will review all doxygen comments changes and hopefully catch all the entries with the invalid format (because either our script will complain or the diff for our documentation will look suspicious). Also, I hope that all content related changes in ToT will be for the best. If not, again, hopefully our tech writers will catch the problems during review and we will fix or report them.

I will rebase and commit. I will start preparing the review for the second small header tomorrow.


http://reviews.llvm.org/D8762

EMAIL PREFERENCES
  http://reviews.llvm.org/settings/panel/emailpreferences/