From 3f2235cfd4a477298132295464f0f60ac23e427a Mon Sep 17 00:00:00 2001 From: Ekaterina Romanova Date: Thu, 8 Dec 2016 17:57:23 +0000 Subject: [PATCH] [DOXYGEN] Improved doxygen comments. Improved doxygen comments for __wmmintrin_pclmul.h and ammintrin.h intrinsics by taagging parameter names with \a doxygen command to display parameters in italics. Formatted comments to fit into 80 chars. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@289083 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Headers/__wmmintrin_pclmul.h | 12 +++--- lib/Headers/ammintrin.h | 63 ++++++++++++++++---------------- 2 files changed, 38 insertions(+), 37 deletions(-) diff --git a/lib/Headers/__wmmintrin_pclmul.h b/lib/Headers/__wmmintrin_pclmul.h index d4e073f406..235f978b06 100644 --- a/lib/Headers/__wmmintrin_pclmul.h +++ b/lib/Headers/__wmmintrin_pclmul.h @@ -43,12 +43,12 @@ /// \param __I /// An immediate value specifying which 64-bit values to select from the /// operands. -/// Bit 0 is used to select a value from operand __X, -/// and bit 4 is used to select a value from operand __Y: -/// Bit[0]=0 indicates that bits[63:0] of operand __X are used. -/// Bit[0]=1 indicates that bits[127:64] of operand __X are used. -/// Bit[4]=0 indicates that bits[63:0] of operand __Y are used. -/// Bit[4]=1 indicates that bits[127:64] of operand __Y are used. +/// Bit 0 is used to select a value from operand \a __X, and bit 4 is used +/// to select a value from operand \a __Y: +/// Bit[0]=0 indicates that bits[63:0] of operand \a __X are used. +/// Bit[0]=1 indicates that bits[127:64] of operand \a __X are used. +/// Bit[4]=0 indicates that bits[63:0] of operand \a __Y are used. +/// Bit[4]=1 indicates that bits[127:64] of operand \a __Y are used. /// \returns The 128-bit integer vector containing the result of the carry-less /// multiplication of the selected 64-bit values. #define _mm_clmulepi64_si128(__X, __Y, __I) \ diff --git a/lib/Headers/ammintrin.h b/lib/Headers/ammintrin.h index 885a1849e7..24deb86772 100644 --- a/lib/Headers/ammintrin.h +++ b/lib/Headers/ammintrin.h @@ -30,7 +30,7 @@ #define __DEFAULT_FN_ATTRS __attribute__((__always_inline__, __nodebug__, __target__("sse4a"))) /// \brief Extracts the specified bits from the lower 64 bits of the 128-bit -/// integer vector operand at the index idx and of the length len. +/// integer vector operand at the index \a idx and of the length \a len. /// /// \headerfile /// @@ -49,8 +49,8 @@ /// 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. +/// [63:0] of parameter \a 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) \ @@ -58,7 +58,8 @@ (char)(len), (char)(idx))) /// \brief Extracts the specified bits from the lower 64 bits of the 128-bit -/// integer vector operand at the index and of the length specified by __y. +/// integer vector operand at the index and of the length specified by +/// \a __y. /// /// \headerfile /// @@ -71,8 +72,8 @@ /// 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. +/// both zero, bits [63:0] of parameter \a __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 @@ -81,9 +82,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 +/// \a y into the lower 64 bits of the destination integer vector \a x at +/// the index \a idx and of the length \a len. /// /// \headerfile /// @@ -96,11 +97,11 @@ _mm_extract_si64(__m128i __x, __m128i __y) /// /// \param x /// The destination operand where bits will be inserted. The inserted bits -/// are defined by the length len and by the index idx specifying the least -/// significant bit. +/// are defined by the length \a len and by the index \a idx specifying the +/// least significant bit. /// \param y /// The source operand containing the bits to be extracted. The extracted -/// bits are the least significant bits of operand y of length len. +/// bits are the least significant bits of operand \a y of length \a len. /// \param len /// Bits [5:0] specify the length; the other bits are ignored. If bits [5:0] /// are zero, the length is interpreted as 64. @@ -108,20 +109,20 @@ _mm_extract_si64(__m128i __x, __m128i __y) /// 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. +/// [63:0] of parameter \a y are inserted into parameter \a 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. +/// destination operand \a x with the specified bitfields replaced by the +/// lower bits of source operand \a 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), \ (__v2di)(__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. +/// \a __y into the lower 64 bits of the destination integer vector \a __x +/// at the index and of the length specified by \a __y. /// /// \headerfile /// @@ -130,21 +131,21 @@ _mm_extract_si64(__m128i __x, __m128i __y) /// \param __x /// The destination operand where bits will be inserted. The inserted bits /// are defined by the length and by the index of the least significant bit -/// specified by operand __y. +/// specified by operand \a __y. /// \param __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. +/// bits are the least significant bits of operand \a __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 \a __y are +/// inserted into parameter \a __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. +/// destination operand \a __x with the specified bitfields replaced by the +/// lower bits of source operand \a __y. The upper 64 bits of the return +/// value are undefined. static __inline__ __m128i __DEFAULT_FN_ATTRS _mm_insert_si64(__m128i __x, __m128i __y) { -- 2.40.0