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

[Dmitri Gribenko]

================
Comment at: ammintrin.h:44
@@ +43,3 @@
+/// \code 
+/// This intrinsics corresponds to \c EXTRQ instruction.
+/// \endcode 
----------------
This *intrinsic* (here and everywhere).

================
Comment at: ammintrin.h:50
@@ +49,3 @@
+/// \param len
+///    Specifies the length at [5:0].
+/// \param idx
----------------
It would help to explicitly say something about other bits: are they ignored, or are they required to be zero?

Also, the word 'length' does not have the right connotation, I think.  'Bits [5:0] specify the number of bits to extract, other bits are ignored' -- I think something like this would be much better.


================
Comment at: ammintrin.h:102
@@ +101,3 @@
+/// \param len
+///    Immediate specifying the length at [5:0].
+/// \param idx
----------------
'Immediate' does not mean much at the C level.  Should it be a literal?  A constant expression?

http://reviews.llvm.org/D8762

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