kromanova created this revision.
Herald added a subscriber: cfe-commits.
Below are a few doxygen intrisics documentation changes requested by our
documentation team:
(1) I added some \see cross-references to a few select intrinsics that are
related (and have the same or very similar semantics).
https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsee
If someone's version of doxygen doesn't support \see directive, please speak
up! We will try to come up with a different solution.
bmiintrin.h
__bextr_u32 and _bextr_u32
__bextr_u64 and _bextr_u64
lzcntintrin.h:
__lzcnt32 and _lzcnt_u32
__lzcnt64 and _lzcnt_u64
(2) pmmintrin.h, smmintrin.h, xmmintrin.h have very few minor formatting
changes. They make rendering of our intrinsics documentation better. I don't
foresee these changes affect anyone's documentation negatively.
Repository:
rC Clang
https://reviews.llvm.org/D47175
Files:
lib/Headers/bmiintrin.h
lib/Headers/lzcntintrin.h
lib/Headers/pmmintrin.h
lib/Headers/smmintrin.h
lib/Headers/xmmintrin.h
Index: lib/Headers/xmmintrin.h
===
--- lib/Headers/xmmintrin.h
+++ lib/Headers/xmmintrin.h
@@ -2495,10 +2495,14 @@
///
///For example, the following expression checks if an overflow exception has
///occurred:
+///\code
/// ( _mm_getcsr() & _MM_EXCEPT_OVERFLOW )
+///\endcode
///
///The following expression gets the current rounding mode:
+///\code
/// _MM_GET_ROUNDING_MODE()
+///\endcode
///
/// \headerfile
///
Index: lib/Headers/smmintrin.h
===
--- lib/Headers/smmintrin.h
+++ lib/Headers/smmintrin.h
@@ -493,7 +493,7 @@
/// \param __V2
///A 128-bit vector of [16 x i8].
/// \param __M
-///A 128-bit vector operand, with mask bits 127, 119, 111 ... 7 specifying
+///A 128-bit vector operand, with mask bits 127, 119, 111...7 specifying
///how the values are to be copied. The position of the mask bit corresponds
///to the most significant bit of a copied value. When a mask bit is 0, the
///corresponding 8-bit element in operand \a __V1 is copied to the same
@@ -1277,8 +1277,8 @@
/// This intrinsic corresponds to the VPMOVSXBD / PMOVSXBD instruction.
///
/// \param __V
-///A 128-bit vector of [16 x i8]. The lower four 8-bit elements are sign-
-///extended to 32-bit values.
+///A 128-bit vector of [16 x i8]. The lower four 8-bit elements are
+///sign-extended to 32-bit values.
/// \returns A 128-bit vector of [4 x i32] containing the sign-extended values.
static __inline__ __m128i __DEFAULT_FN_ATTRS
_mm_cvtepi8_epi32(__m128i __V)
@@ -1298,8 +1298,8 @@
/// This intrinsic corresponds to the VPMOVSXBQ / PMOVSXBQ instruction.
///
/// \param __V
-///A 128-bit vector of [16 x i8]. The lower two 8-bit elements are sign-
-///extended to 64-bit values.
+///A 128-bit vector of [16 x i8]. The lower two 8-bit elements are
+///sign-extended to 64-bit values.
/// \returns A 128-bit vector of [2 x i64] containing the sign-extended values.
static __inline__ __m128i __DEFAULT_FN_ATTRS
_mm_cvtepi8_epi64(__m128i __V)
@@ -1319,8 +1319,8 @@
/// This intrinsic corresponds to the VPMOVSXWD / PMOVSXWD instruction.
///
/// \param __V
-///A 128-bit vector of [8 x i16]. The lower four 16-bit elements are sign-
-///extended to 32-bit values.
+///A 128-bit vector of [8 x i16]. The lower four 16-bit elements are
+///sign-extended to 32-bit values.
/// \returns A 128-bit vector of [4 x i32] containing the sign-extended values.
static __inline__ __m128i __DEFAULT_FN_ATTRS
_mm_cvtepi16_epi32(__m128i __V)
@@ -1338,8 +1338,8 @@
/// This intrinsic corresponds to the VPMOVSXWQ / PMOVSXWQ instruction.
///
/// \param __V
-///A 128-bit vector of [8 x i16]. The lower two 16-bit elements are sign-
-///extended to 64-bit values.
+///A 128-bit vector of [8 x i16]. The lower two 16-bit elements are
+/// sign-extended to 64-bit values.
/// \returns A 128-bit vector of [2 x i64] containing the sign-extended values.
static __inline__ __m128i __DEFAULT_FN_ATTRS
_mm_cvtepi16_epi64(__m128i __V)
@@ -1357,8 +1357,8 @@
/// This intrinsic corresponds to the VPMOVSXDQ / PMOVSXDQ instruction.
///
/// \param __V
-///A 128-bit vector of [4 x i32]. The lower two 32-bit elements are sign-
-///extended to 64-bit values.
+///A 128-bit vector of [4 x i32]. The lower two 32-bit elements are
+///sign-extended to 64-bit values.
/// \returns A 128-bit vector of [2 x i64] containing the sign-extended values.
static __inline__ __m128i __DEFAULT_FN_ATTRS
_mm_cvtepi32_epi64(__m128i __V)
@@ -1377,8 +1377,8 @@
/// This intrinsic corresponds to the VPMOVZXBW / PMOVZXBW instruction.
///
/// \param __V
-///A 128-bit vector of [16 x i8]. The lower eight 8-bit elements are zero-
-///extended to 16-bit values.
+///A 128-bit
