From: Ekaterina Romanova Date: Fri, 16 Feb 2018 03:11:35 +0000 (+0000) Subject: [DOXYGEN] There was a request in the review D41507 to change the notation for hex... X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=024df33b40d92eb8a3a9259fbd31415f86167b0c;p=clang [DOXYGEN] There was a request in the review D41507 to change the notation for hex numbers in doxygen documentation from <...>h to 0x<...>. Both of these notations were used in x86 intrinsics documentation. I promised to change them to 0x<...> for consistency. Differential Revision: https://reviews.llvm.org/D41888 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@325312 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/lib/Headers/emmintrin.h b/lib/Headers/emmintrin.h index b332eeec20..9302321612 100644 --- a/lib/Headers/emmintrin.h +++ b/lib/Headers/emmintrin.h @@ -422,8 +422,8 @@ _mm_xor_pd(__m128d __a, __m128d __b) } /// \brief Compares each of the corresponding double-precision values of the -/// 128-bit vectors of [2 x double] for equality. Each comparison yields 0h -/// for false, FFFFFFFFFFFFFFFFh for true. +/// 128-bit vectors of [2 x double] for equality. Each comparison yields 0x0 +/// for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -443,7 +443,7 @@ _mm_cmpeq_pd(__m128d __a, __m128d __b) /// \brief Compares each of the corresponding double-precision values of the /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are less than those in the second operand. Each comparison -/// yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -464,7 +464,7 @@ _mm_cmplt_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are less than or equal to those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -485,7 +485,7 @@ _mm_cmple_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are greater than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -506,7 +506,7 @@ _mm_cmpgt_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are greater than or equal to those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -528,8 +528,8 @@ _mm_cmpge_pd(__m128d __a, __m128d __b) /// operand are ordered with respect to those in the second operand. /// /// A pair of double-precision values are "ordered" with respect to each -/// other if neither value is a NaN. Each comparison yields 0h for false, -/// FFFFFFFFFFFFFFFFh for true. +/// other if neither value is a NaN. Each comparison yields 0x0 for false, +/// 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -551,8 +551,8 @@ _mm_cmpord_pd(__m128d __a, __m128d __b) /// operand are unordered with respect to those in the second operand. /// /// A pair of double-precision values are "unordered" with respect to each -/// other if one or both values are NaN. Each comparison yields 0h for false, -/// FFFFFFFFFFFFFFFFh for true. +/// other if one or both values are NaN. Each comparison yields 0x0 for +/// false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -574,7 +574,7 @@ _mm_cmpunord_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are unequal to those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -595,7 +595,7 @@ _mm_cmpneq_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are not less than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -616,7 +616,7 @@ _mm_cmpnlt_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are not less than or equal to those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -637,7 +637,7 @@ _mm_cmpnle_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are not greater than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -658,7 +658,7 @@ _mm_cmpngt_pd(__m128d __a, __m128d __b) /// 128-bit vectors of [2 x double] to determine if the values in the first /// operand are not greater than or equal to those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -678,7 +678,7 @@ _mm_cmpnge_pd(__m128d __a, __m128d __b) /// \brief Compares the lower double-precision floating-point values in each of /// the two 128-bit floating-point vectors of [2 x double] for equality. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -703,7 +703,7 @@ _mm_cmpeq_sd(__m128d __a, __m128d __b) /// the value in the first parameter is less than the corresponding value in /// the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -728,7 +728,7 @@ _mm_cmplt_sd(__m128d __a, __m128d __b) /// the value in the first parameter is less than or equal to the /// corresponding value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -753,7 +753,7 @@ _mm_cmple_sd(__m128d __a, __m128d __b) /// the value in the first parameter is greater than the corresponding value /// in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -779,7 +779,7 @@ _mm_cmpgt_sd(__m128d __a, __m128d __b) /// the value in the first parameter is greater than or equal to the /// corresponding value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -805,8 +805,8 @@ _mm_cmpge_sd(__m128d __a, __m128d __b) /// the value in the first parameter is "ordered" with respect to the /// corresponding value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. A pair of -/// double-precision values are "ordered" with respect to each other if +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. A pair +/// of double-precision values are "ordered" with respect to each other if /// neither value is a NaN. /// /// \headerfile @@ -832,9 +832,9 @@ _mm_cmpord_sd(__m128d __a, __m128d __b) /// the value in the first parameter is "unordered" with respect to the /// corresponding value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. A pair of -/// double-precision values are "unordered" with respect to each other if one -/// or both values are NaN. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. A pair +/// of double-precision values are "unordered" with respect to each other if +/// one or both values are NaN. /// /// \headerfile /// @@ -860,7 +860,7 @@ _mm_cmpunord_sd(__m128d __a, __m128d __b) /// the value in the first parameter is unequal to the corresponding value in /// the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -885,7 +885,7 @@ _mm_cmpneq_sd(__m128d __a, __m128d __b) /// the value in the first parameter is not less than the corresponding /// value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -910,7 +910,7 @@ _mm_cmpnlt_sd(__m128d __a, __m128d __b) /// the value in the first parameter is not less than or equal to the /// corresponding value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -935,7 +935,7 @@ _mm_cmpnle_sd(__m128d __a, __m128d __b) /// the value in the first parameter is not greater than the corresponding /// value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -961,7 +961,7 @@ _mm_cmpngt_sd(__m128d __a, __m128d __b) /// the value in the first parameter is not greater than or equal to the /// corresponding value in the second parameter. /// -/// The comparison yields 0h for false, FFFFFFFFFFFFFFFFh for true. +/// The comparison yields 0x0 for false, 0xFFFFFFFFFFFFFFFF for true. /// /// \headerfile /// @@ -2174,8 +2174,8 @@ _mm_add_epi64(__m128i __a, __m128i __b) /// \brief Adds, with saturation, the corresponding elements of two 128-bit /// signed [16 x i8] vectors, saving each sum in the corresponding element of -/// a 128-bit result vector of [16 x i8]. Positive sums greater than 7Fh are -/// saturated to 7Fh. Negative sums less than 80h are saturated to 80h. +/// a 128-bit result vector of [16 x i8]. Positive sums greater than 0x7F are +/// saturated to 0x7F. Negative sums less than 0x80 are saturated to 0x80. /// /// \headerfile /// @@ -2195,9 +2195,9 @@ _mm_adds_epi8(__m128i __a, __m128i __b) /// \brief Adds, with saturation, the corresponding elements of two 128-bit /// signed [8 x i16] vectors, saving each sum in the corresponding element of -/// a 128-bit result vector of [8 x i16]. Positive sums greater than 7FFFh -/// are saturated to 7FFFh. Negative sums less than 8000h are saturated to -/// 8000h. +/// a 128-bit result vector of [8 x i16]. Positive sums greater than 0x7FFF +/// are saturated to 0x7FFF. Negative sums less than 0x8000 are saturated to +/// 0x8000. /// /// \headerfile /// @@ -2217,8 +2217,8 @@ _mm_adds_epi16(__m128i __a, __m128i __b) /// \brief Adds, with saturation, the corresponding elements of two 128-bit /// unsigned [16 x i8] vectors, saving each sum in the corresponding element -/// of a 128-bit result vector of [16 x i8]. Positive sums greater than FFh -/// are saturated to FFh. Negative sums are saturated to 00h. +/// of a 128-bit result vector of [16 x i8]. Positive sums greater than 0xFF +/// are saturated to 0xFF. Negative sums are saturated to 0x00. /// /// \headerfile /// @@ -2238,8 +2238,8 @@ _mm_adds_epu8(__m128i __a, __m128i __b) /// \brief Adds, with saturation, the corresponding elements of two 128-bit /// unsigned [8 x i16] vectors, saving each sum in the corresponding element -/// of a 128-bit result vector of [8 x i16]. Positive sums greater than FFFFh -/// are saturated to FFFFh. Negative sums are saturated to 0000h. +/// of a 128-bit result vector of [8 x i16]. Positive sums greater than +/// 0xFFFF are saturated to 0xFFFF. Negative sums are saturated to 0x0000. /// /// \headerfile /// @@ -2624,8 +2624,8 @@ _mm_sub_epi64(__m128i __a, __m128i __b) /// \brief Subtracts corresponding 8-bit signed integer values in the input and /// returns the differences in the corresponding bytes in the destination. -/// Differences greater than 7Fh are saturated to 7Fh, and differences less -/// than 80h are saturated to 80h. +/// Differences greater than 0x7F are saturated to 0x7F, and differences less +/// than 0x80 are saturated to 0x80. /// /// \headerfile /// @@ -2645,8 +2645,8 @@ _mm_subs_epi8(__m128i __a, __m128i __b) /// \brief Subtracts corresponding 16-bit signed integer values in the input and /// returns the differences in the corresponding bytes in the destination. -/// Differences greater than 7FFFh are saturated to 7FFFh, and values less -/// than 8000h are saturated to 8000h. +/// Differences greater than 0x7FFF are saturated to 0x7FFF, and values less +/// than 0x8000 are saturated to 0x8000. /// /// \headerfile /// @@ -2666,7 +2666,7 @@ _mm_subs_epi16(__m128i __a, __m128i __b) /// \brief Subtracts corresponding 8-bit unsigned integer values in the input /// and returns the differences in the corresponding bytes in the -/// destination. Differences less than 00h are saturated to 00h. +/// destination. Differences less than 0x00 are saturated to 0x00. /// /// \headerfile /// @@ -2686,7 +2686,7 @@ _mm_subs_epu8(__m128i __a, __m128i __b) /// \brief Subtracts corresponding 16-bit unsigned integer values in the input /// and returns the differences in the corresponding bytes in the -/// destination. Differences less than 0000h are saturated to 0000h. +/// destination. Differences less than 0x0000 are saturated to 0x0000. /// /// \headerfile /// @@ -3168,7 +3168,7 @@ _mm_srl_epi64(__m128i __a, __m128i __count) } /// \brief Compares each of the corresponding 8-bit values of the 128-bit -/// integer vectors for equality. Each comparison yields 0h for false, FFh +/// integer vectors for equality. Each comparison yields 0x0 for false, 0xFF /// for true. /// /// \headerfile @@ -3187,8 +3187,8 @@ _mm_cmpeq_epi8(__m128i __a, __m128i __b) } /// \brief Compares each of the corresponding 16-bit values of the 128-bit -/// integer vectors for equality. Each comparison yields 0h for false, FFFFh -/// for true. +/// integer vectors for equality. Each comparison yields 0x0 for false, +/// 0xFFFF for true. /// /// \headerfile /// @@ -3206,8 +3206,8 @@ _mm_cmpeq_epi16(__m128i __a, __m128i __b) } /// \brief Compares each of the corresponding 32-bit values of the 128-bit -/// integer vectors for equality. Each comparison yields 0h for false, -/// FFFFFFFFh for true. +/// integer vectors for equality. Each comparison yields 0x0 for false, +/// 0xFFFFFFFF for true. /// /// \headerfile /// @@ -3226,8 +3226,8 @@ _mm_cmpeq_epi32(__m128i __a, __m128i __b) /// \brief Compares each of the corresponding signed 8-bit values of the 128-bit /// integer vectors to determine if the values in the first operand are -/// greater than those in the second operand. Each comparison yields 0h for -/// false, FFh for true. +/// greater than those in the second operand. Each comparison yields 0x0 for +/// false, 0xFF for true. /// /// \headerfile /// @@ -3250,7 +3250,7 @@ _mm_cmpgt_epi8(__m128i __a, __m128i __b) /// 128-bit integer vectors to determine if the values in the first operand /// are greater than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFF for true. /// /// \headerfile /// @@ -3271,7 +3271,7 @@ _mm_cmpgt_epi16(__m128i __a, __m128i __b) /// 128-bit integer vectors to determine if the values in the first operand /// are greater than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFF for true. /// /// \headerfile /// @@ -3292,7 +3292,7 @@ _mm_cmpgt_epi32(__m128i __a, __m128i __b) /// integer vectors to determine if the values in the first operand are less /// than those in the second operand. /// -/// Each comparison yields 0h for false, FFh for true. +/// Each comparison yields 0x0 for false, 0xFF for true. /// /// \headerfile /// @@ -3313,7 +3313,7 @@ _mm_cmplt_epi8(__m128i __a, __m128i __b) /// 128-bit integer vectors to determine if the values in the first operand /// are less than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFF for true. /// /// \headerfile /// @@ -3334,7 +3334,7 @@ _mm_cmplt_epi16(__m128i __a, __m128i __b) /// 128-bit integer vectors to determine if the values in the first operand /// are less than those in the second operand. /// -/// Each comparison yields 0h for false, FFFFFFFFh for true. +/// Each comparison yields 0x0 for false, 0xFFFFFFFF for true. /// /// \headerfile /// diff --git a/lib/Headers/tmmintrin.h b/lib/Headers/tmmintrin.h index 042bfc7e3b..97d61488e0 100644 --- a/lib/Headers/tmmintrin.h +++ b/lib/Headers/tmmintrin.h @@ -276,8 +276,9 @@ _mm_hadd_pi32(__m64 __a, __m64 __b) } /// \brief Horizontally adds the adjacent pairs of values contained in 2 packed -/// 128-bit vectors of [8 x i16]. Positive sums greater than 7FFFh are -/// saturated to 7FFFh. Negative sums less than 8000h are saturated to 8000h. +/// 128-bit vectors of [8 x i16]. Positive sums greater than 0x7FFF are +/// saturated to 0x7FFF. Negative sums less than 0x8000 are saturated to +/// 0x8000. /// /// \headerfile /// @@ -300,8 +301,9 @@ _mm_hadds_epi16(__m128i __a, __m128i __b) } /// \brief Horizontally adds the adjacent pairs of values contained in 2 packed -/// 64-bit vectors of [4 x i16]. Positive sums greater than 7FFFh are -/// saturated to 7FFFh. Negative sums less than 8000h are saturated to 8000h. +/// 64-bit vectors of [4 x i16]. Positive sums greater than 0x7FFF are +/// saturated to 0x7FFF. Negative sums less than 0x8000 are saturated to +/// 0x8000. /// /// \headerfile /// @@ -417,8 +419,8 @@ _mm_hsub_pi32(__m64 __a, __m64 __b) /// \brief Horizontally subtracts the adjacent pairs of values contained in 2 /// packed 128-bit vectors of [8 x i16]. Positive differences greater than -/// 7FFFh are saturated to 7FFFh. Negative differences less than 8000h are -/// saturated to 8000h. +/// 0x7FFF are saturated to 0x7FFF. Negative differences less than 0x8000 are +/// saturated to 0x8000. /// /// \headerfile /// @@ -442,8 +444,8 @@ _mm_hsubs_epi16(__m128i __a, __m128i __b) /// \brief Horizontally subtracts the adjacent pairs of values contained in 2 /// packed 64-bit vectors of [4 x i16]. Positive differences greater than -/// 7FFFh are saturated to 7FFFh. Negative differences less than 8000h are -/// saturated to 8000h. +/// 0x7FFF are saturated to 0x7FFF. Negative differences less than 0x8000 are +/// saturated to 0x8000. /// /// \headerfile ///