[clang] [Headers][X86] Make brief descriptions briefer (PR #82422)

Paul T Robinson via cfe-commits cfe-commits at lists.llvm.org
Thu Feb 22 09:04:21 PST 2024


================
@@ -2099,9 +2099,11 @@ static __inline__ __m128i __DEFAULT_FN_ATTRS _mm_add_epi64(__m128i __a,
 }
 
 /// 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 0x7F are
-///    saturated to 0x7F. Negative sums less than 0x80 are saturated to 0x80.
+///    signed [16 x i8] vectors, saving each sum in the corresponding element
+///    of a 128-bit result vector of [16 x i8].
+///
----------------
pogo59 wrote:

Adding the blank line makes the brief section more compact, so I'm not clear what you want.

In our documentation, the first paragraph appears at the top of the documentation page for the function; both paragraphs will appear in the full description after the synopsis. No information is lost. I believe the detail about how saturation works is not needed in the brief description.

Are you saying the detail about saturation belongs in the brief description? Or something else?

https://github.com/llvm/llvm-project/pull/82422


More information about the cfe-commits mailing list