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

[Katya Romanova]

Hi Dmitri,

One of my colleagues has a Mac, so we have looked up how the documentation for ammintrin.h is rendered the XCode today.

Good news: Regular instrinsics definitions are displayed correctly, though some small changes might be needed to make rendering of the documentation better. I don’t personally like this “code snippet” produced by this comment

/// \code 
/// This intrinsic corresponds to the \c VADDPD instruction.
/// \endcode

I don't care for the gray box surrounding this text, identifying it as a code snippet. I don't find it particularly pretty, though I could live with that. Do you have better ideas? 
What I definitely don't like is \c command that you asked me to add some time back. It definitely looks weird in XCode.  It's interpreted literally, not like a command.  I will try to attach a screenshot with generated XCode documentation for one of the intrinsics to Phabricator, so you would know what I'm talking about. If it won't work, I will send you a personal email with the screenshot. Again, thank you so much for reviewing and making helpful comments!

Bad news: Macros are not getting rendered in XCode at all. To say more, unrelated to the intrinsics headers, I wasn't even able to display documentation for the simplest macro that adds two numbers together. Do you know if we could work around it?


http://reviews.llvm.org/D8762

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