From 7df2e664dbc3c736ea5ff739ac112fa3408aeb19 Mon Sep 17 00:00:00 2001 From: Ioana Ghiban Date: Fri, 19 Jan 2024 19:38:23 +0100 Subject: [PATCH] [doc] Fix documentation for saturating_sub --- intrinsiccv/include/intrinsiccv.h | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/intrinsiccv/include/intrinsiccv.h b/intrinsiccv/include/intrinsiccv.h index 58359ac5c..70ed2cf3c 100644 --- a/intrinsiccv/include/intrinsiccv.h +++ b/intrinsiccv/include/intrinsiccv.h @@ -57,21 +57,21 @@ INTRINSICCV_BINARY_OP(saturating_add_u64, uint64_t); /// /// The subtraction is saturated, i.e. the result is 0 (unsigned) or the /// smallest possible value of the type of the element if the subtraction result -/// would underflow. Source data length (in bytes) is `stride` * `height`, -/// it must be the same for the two sources. +/// would underflow. Source data length (in bytes) is `stride` * `height`. +/// Width and height are the same for the two sources. /// /// @param src_a Pointer to the first source data. Must be non-null. /// @param src_b Pointer to the second source data. Must be non-null. -/// @param src_a_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(type). -/// @param src_b_stride Distance in bytes between the row first elements for -/// the second source data. Must not be less than -/// width * sizeof(type). +/// @param src_a_stride Distance in bytes from the start of one row to the +/// start of the next row for the src_a. +/// Must not be less than width * sizeof(type). +/// @param src_b_stride Distance in bytes from the start of one row to the +/// start of the next row for the src_b. +/// Must not be less than width * sizeof(type). /// @param dst Pointer to the destination data. Must be non-null. -/// @param dst_stride Distance in bytes between the row first elements for -/// the destination data. Must not be less than -/// width * sizeof(type). +/// @param dst_stride Distance in bytes from the start of one row to the +/// start of the next row for the destination. +/// Must not be less than width * sizeof(type). /// @param width How many elements are in a row /// @param height How many rows are in the data /// -- GitLab