diff options
author | Ekaterina Romanova <katya_romanova@playstation.sony.com> | 2016-12-27 00:49:38 +0000 |
---|---|---|
committer | Ekaterina Romanova <katya_romanova@playstation.sony.com> | 2016-12-27 00:49:38 +0000 |
commit | dffe45b3e6553b2ab09ad05a82000a33d3a0d964 (patch) | |
tree | d8d80c5183eae933fed502167e1ab0683c121e0b /clang/lib/Headers/pmmintrin.h | |
parent | 88c4ffb4e06f96dbefc71e6b98ae2718e6e4e2ee (diff) | |
download | bcm5719-llvm-dffe45b3e6553b2ab09ad05a82000a33d3a0d964.tar.gz bcm5719-llvm-dffe45b3e6553b2ab09ad05a82000a33d3a0d964.zip |
[DOXYGEN] Improved doxygen comments for x86 intrinsics.
Improved doxygen comments for the following intrinsics headers: __wmmintrin_pclmul.h, bmiintrin.h, emmintrin.h, f16cintrin.h, immintrin.h, mmintrin.h, pmmintrin.h, tmmintrin.h
Added \n commands to insert a line breaks where necessary, since one long line of documentation is nearly unreadable.
Formatted comments to fit into 80 chars.
In some cases added \a command in front of the parameter names to display them in italics.
llvm-svn: 290561
Diffstat (limited to 'clang/lib/Headers/pmmintrin.h')
-rw-r--r-- | clang/lib/Headers/pmmintrin.h | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/clang/lib/Headers/pmmintrin.h b/clang/lib/Headers/pmmintrin.h index 5f201fb53bd..d4f6487af17 100644 --- a/clang/lib/Headers/pmmintrin.h +++ b/clang/lib/Headers/pmmintrin.h @@ -115,18 +115,18 @@ _mm_hsub_ps(__m128 __a, __m128 __b) /// \brief Moves and duplicates high-order (odd-indexed) values from a 128-bit /// vector of [4 x float] to float values stored in a 128-bit vector of -/// [4 x float]. -/// Bits [127:96] of the source are written to bits [127:96] and [95:64] of -/// the destination. -/// Bits [63:32] of the source are written to bits [63:32] and [31:0] of the -/// destination. +/// [4 x float]. /// /// \headerfile <x86intrin.h> /// /// This intrinsic corresponds to the <c> VMOVSHDUP </c> instruction. /// /// \param __a -/// A 128-bit vector of [4 x float]. +/// A 128-bit vector of [4 x float]. \n +/// Bits [127:96] of the source are written to bits [127:96] and [95:64] of +/// the destination. \n +/// Bits [63:32] of the source are written to bits [63:32] and [31:0] of the +/// destination. /// \returns A 128-bit vector of [4 x float] containing the moved and duplicated /// values. static __inline__ __m128 __DEFAULT_FN_ATTRS @@ -135,20 +135,19 @@ _mm_movehdup_ps(__m128 __a) return __builtin_shufflevector((__v4sf)__a, (__v4sf)__a, 1, 1, 3, 3); } -/// \brief Duplicates low-order (even-indexed) values from a 128-bit -/// vector of [4 x float] to float values stored in a 128-bit vector of -/// [4 x float]. -/// Bits [95:64] of the source are written to bits [127:96] and [95:64] of -/// the destination. -/// Bits [31:0] of the source are written to bits [63:32] and [31:0] of the -/// destination. +/// \brief Duplicates low-order (even-indexed) values from a 128-bit vector of +/// [4 x float] to float values stored in a 128-bit vector of [4 x float]. /// /// \headerfile <x86intrin.h> /// /// This intrinsic corresponds to the <c> VMOVSLDUP </c> instruction. /// /// \param __a -/// A 128-bit vector of [4 x float]. +/// A 128-bit vector of [4 x float] \n +/// Bits [95:64] of the source are written to bits [127:96] and [95:64] of +/// the destination. \n +/// Bits [31:0] of the source are written to bits [63:32] and [31:0] of the +/// destination. /// \returns A 128-bit vector of [4 x float] containing the moved and duplicated /// values. static __inline__ __m128 __DEFAULT_FN_ATTRS |