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

Katya Romanova Katya_Romanova at playstation.sony.com
Tue Jun 2 15:23:28 PDT 2015


> > Why is this paragraph surrounded by \code? It is text, not program code.

> 


I'm not sure if you remember it, but in the first draft of the doxygen comments format I had
/// \code 
/// INSTRUCTION_NAME
/// \endcode 
So in the first draft revision it was a program code.

In the review, you asked me to add "This intrinsic corresponds to the \c <INSTRUCTION_NAME> instruction" wording, which I did.
It's easy enough to change \code command into something else (what command does Clang supports and wants to see here?) or revert "This intrinsic corresponds to the \c .. instruction". Let me know what is preferable.
change back.


http://reviews.llvm.org/D8762

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






More information about the cfe-commits mailing list