From a22abdd763de730e3eddd7b1ebd5367634e4e7a8 Mon Sep 17 00:00:00 2001 From: Ekaterina Romanova Date: Wed, 27 Apr 2016 07:14:02 +0000 Subject: [PATCH] Updated doxygen comments for intrinsics. (1) Removed \code.. \endcode tags around the instruction name. This matches the doxygen format for all other intrinsics. (2) Did a better formatting for the comments (to fit into 80 columns more compactly). git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@267676 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Headers/ammintrin.h | 81 +++++++++++++++++------------------------ 1 file changed, 33 insertions(+), 48 deletions(-) diff --git a/lib/Headers/ammintrin.h b/lib/Headers/ammintrin.h index 4880fd7eba..8985bb404f 100644 --- a/lib/Headers/ammintrin.h +++ b/lib/Headers/ammintrin.h @@ -38,9 +38,7 @@ /// __m128i _mm_extracti_si64(__m128i x, const int len, const int idx); /// \endcode /// -/// \code /// This intrinsic corresponds to the \c EXTRQ instruction. -/// \endcode /// /// \param x /// The value from which bits are extracted. @@ -49,10 +47,10 @@ /// are zero, the length is interpreted as 64. /// \param idx /// Bits [5:0] specify the index of the least significant bit; the other -/// bits are ignored. If the sum of the index and length is greater than -/// 64, the result is undefined. If the length and index are both zero, -/// bits [63:0] of parameter x are extracted. If the length is zero -/// but the index is non-zero, the result is undefined. +/// bits are ignored. If the sum of the index and length is greater than 64, +/// the result is undefined. If the length and index are both zero, bits +/// [63:0] of parameter x are extracted. If the length is zero but the index +/// is non-zero, the result is undefined. /// \returns A 128-bit integer vector whose lower 64 bits contain the bits /// extracted from the source operand. #define _mm_extracti_si64(x, len, idx) \ @@ -64,20 +62,17 @@ /// /// \headerfile /// -/// \code /// This intrinsic corresponds to the \c EXTRQ instruction. -/// \endcode /// /// \param __x /// The value from which bits are extracted. /// \param __y -/// Specifies the index of the least significant bit at [13:8] -/// and the length at [5:0]; all other bits are ignored. -/// If bits [5:0] are zero, the length is interpreted as 64. -/// If the sum of the index and length is greater than 64, the result is -/// undefined. If the length and index are both zero, bits [63:0] of -/// parameter __x are extracted. If the length is zero but the index is -/// non-zero, the result is undefined. +/// Specifies the index of the least significant bit at [13:8] and the +/// length at [5:0]; all other bits are ignored. If bits [5:0] are zero, the +/// length is interpreted as 64. If the sum of the index and length is +/// greater than 64, the result is undefined. If the length and index are +/// both zero, bits [63:0] of parameter __x are extracted. If the length is +/// zero but the index is non-zero, the result is undefined. /// \returns A 128-bit vector whose lower 64 bits contain the bits extracted /// from the source operand. static __inline__ __m128i __DEFAULT_FN_ATTRS @@ -86,9 +81,9 @@ _mm_extract_si64(__m128i __x, __m128i __y) return (__m128i)__builtin_ia32_extrq((__v2di)__x, (__v16qi)__y); } -/// \brief Inserts bits of a specified length from the source integer vector -/// y into the lower 64 bits of the destination integer vector x at the -/// index idx and of the length len. +/// \brief Inserts bits of a specified length from the source integer vector y +/// into the lower 64 bits of the destination integer vector x at the index +/// idx and of the length len. /// /// \headerfile /// @@ -97,9 +92,7 @@ _mm_extract_si64(__m128i __x, __m128i __y) /// const int idx); /// \endcode /// -/// \code /// This intrinsic corresponds to the \c INSERTQ instruction. -/// \endcode /// /// \param x /// The destination operand where bits will be inserted. The inserted bits @@ -113,14 +106,14 @@ _mm_extract_si64(__m128i __x, __m128i __y) /// are zero, the length is interpreted as 64. /// \param idx /// Bits [5:0] specify the index of the least significant bit; the other -/// bits are ignored. If the sum of the index and length is greater than -/// 64, the result is undefined. If the length and index are both zero, -/// bits [63:0] of parameter y are inserted into parameter x. If the -/// length is zero but the index is non-zero, the result is undefined. -/// \returns A 128-bit integer vector containing the original lower 64-bits -/// of destination operand x with the specified bitfields replaced by the -/// lower bits of source operand y. The upper 64 bits of the return value -/// are undefined. +/// bits are ignored. If the sum of the index and length is greater than 64, +/// the result is undefined. If the length and index are both zero, bits +/// [63:0] of parameter y are inserted into parameter x. If the length is +/// zero but the index is non-zero, the result is undefined. +/// \returns A 128-bit integer vector containing the original lower 64-bits of +/// destination operand x with the specified bitfields replaced by the lower +/// bits of source operand y. The upper 64 bits of the return value are +/// undefined. #define _mm_inserti_si64(x, y, len, idx) \ ((__m128i)__builtin_ia32_insertqi((__v2di)(__m128i)(x), \ @@ -128,14 +121,12 @@ _mm_extract_si64(__m128i __x, __m128i __y) (char)(len), (char)(idx))) /// \brief Inserts bits of a specified length from the source integer vector -/// __y into the lower 64 bits of the destination integer vector __x at -/// the index and of the length specified by __y. +/// __y into the lower 64 bits of the destination integer vector __x at the +/// index and of the length specified by __y. /// /// \headerfile /// -/// \code /// This intrinsic corresponds to the \c INSERTQ instruction. -/// \endcode /// /// \param __x /// The destination operand where bits will be inserted. The inserted bits @@ -145,14 +136,14 @@ _mm_extract_si64(__m128i __x, __m128i __y) /// The source operand containing the bits to be extracted. The extracted /// bits are the least significant bits of operand __y with length specified /// by bits [69:64]. These are inserted into the destination at the index -/// specified by bits [77:72]; all other bits are ignored. -/// If bits [69:64] are zero, the length is interpreted as 64. -/// If the sum of the index and length is greater than 64, the result is -/// undefined. If the length and index are both zero, bits [63:0] of -/// parameter __y are inserted into parameter __x. If the length -/// is zero but the index is non-zero, the result is undefined. -/// \returns A 128-bit integer vector containing the original lower 64-bits -/// of destination operand __x with the specified bitfields replaced by the +/// specified by bits [77:72]; all other bits are ignored. If bits [69:64] +/// are zero, the length is interpreted as 64. If the sum of the index and +/// length is greater than 64, the result is undefined. If the length and +/// index are both zero, bits [63:0] of parameter __y are inserted into +/// parameter __x. If the length is zero but the index is non-zero, the +/// result is undefined. +/// \returns A 128-bit integer vector containing the original lower 64-bits of +/// destination operand __x with the specified bitfields replaced by the /// lower bits of source operand __y. The upper 64 bits of the return value /// are undefined. @@ -168,15 +159,12 @@ _mm_insert_si64(__m128i __x, __m128i __y) /// /// \headerfile /// -/// \code /// This intrinsic corresponds to the \c MOVNTSD instruction. -/// \endcode /// /// \param __p /// The 64-bit memory location used to store the register value. /// \param __a -/// The 64-bit double-precision floating-point register value to -/// be stored. +/// The 64-bit double-precision floating-point register value to be stored. static __inline__ void __DEFAULT_FN_ATTRS _mm_stream_sd(double *__p, __m128d __a) { @@ -189,15 +177,12 @@ _mm_stream_sd(double *__p, __m128d __a) /// /// \headerfile /// -/// \code /// This intrinsic corresponds to the \c MOVNTSS instruction. -/// \endcode /// /// \param __p /// The 32-bit memory location used to store the register value. /// \param __a -/// The 32-bit single-precision floating-point register value to -/// be stored. +/// The 32-bit single-precision floating-point register value to be stored. static __inline__ void __DEFAULT_FN_ATTRS _mm_stream_ss(float *__p, __m128 __a) { -- 2.40.0