From 35c174ce2e855e23a28f09439c8ec52dbc1adbd4 Mon Sep 17 00:00:00 2001 From: Ioana Ghiban Date: Thu, 25 Jan 2024 16:14:13 +0100 Subject: [PATCH] [doc] Make documentation more consistent --- intrinsiccv/include/intrinsiccv.h | 305 +++++++++++++----------------- 1 file changed, 131 insertions(+), 174 deletions(-) diff --git a/intrinsiccv/include/intrinsiccv.h b/intrinsiccv/include/intrinsiccv.h index a9d98637f..2a6521b3b 100644 --- a/intrinsiccv/include/intrinsiccv.h +++ b/intrinsiccv/include/intrinsiccv.h @@ -1,4 +1,4 @@ -// SPDX-FileCopyrightText: 2023 - 2024 Arm Limited and/or its affiliates +// SPDX-FileCopyrightText: 2023-2024 Arm Limited and/or its affiliates // // SPDX-License-Identifier: Apache-2.0 @@ -31,16 +31,16 @@ extern "C" { /// @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 from the start of one row to the -/// start of the next row for the src_a. +/// start of the next row for the first source data. /// 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. +/// start of the next row for the second source data. /// 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 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 Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// INTRINSICCV_BINARY_OP(saturating_add_s8, int8_t); @@ -63,16 +63,16 @@ INTRINSICCV_BINARY_OP(saturating_add_u64, uint64_t); /// @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 from the start of one row to the -/// start of the next row for the src_a. +/// start of the next row for the first source data. /// 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. +/// start of the next row for the second source data. /// 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 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 Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// INTRINSICCV_BINARY_OP(saturating_sub_s8, int8_t); @@ -95,16 +95,16 @@ INTRINSICCV_BINARY_OP(saturating_sub_u64, uint64_t); /// @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 from the start of one row to the -/// start of the next row for the src_a. +/// start of the next row for the first source data. /// 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. +/// start of the next row for the second source data. /// 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 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 Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// INTRINSICCV_BINARY_OP(saturating_absdiff_u8, uint8_t); @@ -133,7 +133,7 @@ INTRINSICCV_BINARY_OP(saturating_absdiff_s32, int32_t); /// @param dst_stride Distance in bytes from the start of one row to the /// start of the next row for the destination data. /// Must not be less than width * sizeof(type). -/// @param width Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param scale Currently unused parameter. /// @@ -152,16 +152,16 @@ INTRINSICCV_BINARY_OP(add_abs_with_threshold, int16_t, int16_t); /// where each letter represents one byte of data, and one pixel is represented /// by 3 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(gray_to_rgb_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -174,16 +174,16 @@ void INTRINSICCV_C_API(gray_to_rgb_u8)(const uint8_t *src, size_t src_stride, /// where each letter represents one byte of data, and one pixel is represented /// by 4 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(gray_to_rgba_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -196,16 +196,16 @@ void INTRINSICCV_C_API(gray_to_rgba_u8)(const uint8_t *src, size_t src_stride, /// Each letter represents one byte of data, and one pixel is represented /// by 3 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgb_to_bgr_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -214,16 +214,16 @@ void INTRINSICCV_C_API(rgb_to_bgr_u8)(const uint8_t *src, size_t src_stride, /// Copies a source RBG image to destination buffer. /// All channels are 8-bit wide. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgb_to_rgb_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -236,16 +236,16 @@ void INTRINSICCV_C_API(rgb_to_rgb_u8)(const uint8_t *src, size_t src_stride, /// Each letter represents one byte of data, and one pixel is represented /// by 4 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgba_to_bgra_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -254,16 +254,16 @@ void INTRINSICCV_C_API(rgba_to_bgra_u8)(const uint8_t *src, size_t src_stride, /// Copies a source RBGA image to destination buffer. /// All channels are 8-bit wide. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgba_to_rgba_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -277,16 +277,16 @@ void INTRINSICCV_C_API(rgba_to_rgba_u8)(const uint8_t *src, size_t src_stride, /// Each letter represents one byte of data, and one pixel is represented /// by 4 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgb_to_bgra_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -300,16 +300,16 @@ void INTRINSICCV_C_API(rgb_to_bgra_u8)(const uint8_t *src, size_t src_stride, /// Each letter represents one byte of data, and one pixel is represented /// by 4 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgb_to_rgba_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -323,16 +323,16 @@ void INTRINSICCV_C_API(rgb_to_rgba_u8)(const uint8_t *src, size_t src_stride, /// Each letter represents one byte of data, and one pixel is represented /// by 3 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the first source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgba_to_bgr_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -346,16 +346,16 @@ void INTRINSICCV_C_API(rgba_to_bgr_u8)(const uint8_t *src, size_t src_stride, /// Each letter represents one byte of data, and one pixel is represented /// by 3 bytes. There is no padding between the pixels. /// -/// @param src Pointer to the first source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(uint8). -/// @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(uint8). -/// @param width Number of elements in a row. -/// @param height Number of rows in the data. +/// @param src Pointer to the first source data. Must be non-null. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// 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 from the start of one row to the +/// start of the next row for the destination data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. +/// @param height Number of rows in the data. /// void INTRINSICCV_C_API(rgba_to_rgb_u8)(const uint8_t *src, size_t src_stride, uint8_t *dst, size_t dst_stride, @@ -373,19 +373,19 @@ void INTRINSICCV_C_API(rgba_to_rgb_u8)(const uint8_t *src, size_t src_stride, /// @param src_y Pointer to the input's Y component. Must be non-null. /// @param src_y_stride Distance in bytes from the start of one row to the /// start of the next row for the input's Y component. -/// Must not be less than width * sizeof(u8). +/// Must not be less than width * sizeof(type). /// @param src_uv Pointer to the input's interleaved UV components. /// Must be non-null. If the width parameter is odd, the /// width of this input stream still needs to be even. /// @param src_uv_stride Distance in bytes from the start of one row to the /// start of the next row for the input's UV components. /// Must not be less than -/// __builtin_align_up(width, 2) * sizeof(u8). +/// __builtin_align_up(width, 2) * sizeof(type). /// @param dst Pointer to the destination data. Must be non-null. /// @param dst_stride Distance in bytes from the start of one row to the /// start of the next row for the destination data. Must /// not be less than width * sizeof(type). -/// @param width Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param is_nv21 If true, input is treated as NV21, otherwise treated /// as NV12. @@ -409,19 +409,19 @@ void INTRINSICCV_C_API(yuv_sp_to_rgb_u8)(const uint8_t *src_y, /// @param src_y Pointer to the input's Y component. Must be non-null. /// @param src_y_stride Distance in bytes from the start of one row to the /// start of the next row for the input's Y component. -/// Must not be less than width * sizeof(u8). +/// Must not be less than width * sizeof(type). /// @param src_uv Pointer to the input's interleaved UV components. /// Must be non-null. If the width parameter is odd, the /// width of this input stream still needs to be even. /// @param src_uv_stride Distance in bytes from the start of one row to the /// start of the next row for the input's UV components. /// Must not be less than -/// __builtin_align_up(width, 2) * sizeof(u8). +/// __builtin_align_up(width, 2) * sizeof(type). /// @param dst Pointer to the destination data. Must be non-null. /// @param dst_stride Distance in bytes from the start of one row to the /// start of the next row for the destination data. Must /// not be less than width * sizeof(type). -/// @param width Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param is_nv21 If true, input is treated as NV21, otherwise treated /// as NV12. @@ -444,19 +444,19 @@ void INTRINSICCV_C_API(yuv_sp_to_bgr_u8)(const uint8_t *src_y, /// @param src_y Pointer to the input's Y component. Must be non-null. /// @param src_y_stride Distance in bytes from the start of one row to the /// start of the next row for the input's Y component. -/// Must not be less than width * sizeof(u8). +/// Must not be less than width * sizeof(type). /// @param src_uv Pointer to the input's interleaved UV components. /// Must be non-null. If the width parameter is odd, the /// width of this input stream still needs to be even. /// @param src_uv_stride Distance in bytes from the start of one row to the /// start of the next row for the input's UV components. /// Must not be less than -/// __builtin_align_up(width, 2) * sizeof(u8). +/// __builtin_align_up(width, 2) * sizeof(type). /// @param dst Pointer to the destination data. Must be non-null. /// @param dst_stride Distance in bytes from the start of one row to the /// start of the next row for the destination data. Must /// not be less than width * sizeof(type). -/// @param width Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param is_nv21 If true, input is treated as NV21, otherwise treated /// as NV12. @@ -479,19 +479,19 @@ void INTRINSICCV_C_API(yuv_sp_to_rgba_u8)(const uint8_t *src_y, /// @param src_y Pointer to the input's Y component. Must be non-null. /// @param src_y_stride Distance in bytes from the start of one row to the /// start of the next row for the input's Y component. -/// Must not be less than width * sizeof(u8). +/// Must not be less than width * sizeof(type). /// @param src_uv Pointer to the input's interleaved UV components. /// Must be non-null. If the width parameter is odd, the /// width of this input stream still needs to be even. /// @param src_uv_stride Distance in bytes from the start of one row to the /// start of the next row for the input's UV components. /// Must not be less than -/// __builtin_align_up(width, 2) * sizeof(u8). +/// __builtin_align_up(width, 2) * sizeof(type). /// @param dst Pointer to the destination data. Must be non-null. /// @param dst_stride Distance in bytes from the start of one row to the /// start of the next row for the destination data. Must /// not be less than width * sizeof(type). -/// @param width Number of elements in a row. +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param is_nv21 If true, input is treated as NV21, otherwise treated /// as NV12. @@ -527,10 +527,10 @@ void INTRINSICCV_C_API(erode_u8)(const uint8_t *src, size_t src_stride, /// Counts how many nonzero elements are in the source data. /// /// @param src Pointer to the source data. Must be non-null. -/// @param src_stride Distance in bytes between the row first elements for -/// the source data. Must not be less than -/// width * (element size in bytes). -/// @param width Number of elements in a row. +/// @param src_stride Distance in bytes from the start of one row to the +/// start of the next row for the source data. +/// Must not be less than width * sizeof(type). +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// size_t INTRINSICCV_C_API(count_nonzeros_u8)(const uint8_t *src, @@ -571,28 +571,6 @@ void INTRINSICCV_C_API(gaussian_blur_5x5_u8)( intrinsiccv_border_type_t border_type, const intrinsiccv_filter_params_t *params); -/// Splits a multi channel source stream into separate 1-channel streams. -/// -/// @param src_data Pointer to the source data. Must be non-null. -/// @param src_stride Distance in bytes from the start of one row to the -/// start of the next row in the source data. Must not be -/// less than width * (element size in bytes) * channels. -/// @param dst_data A C style array of pointers to the destination data. -/// Number of pointers in the array must be the same as the -/// channel number. All pointers must be non-null. -/// @param dst_strides A C style array of stride values for the destination -/// streams. A stride value represents the distance in -/// bytes from the start of one row to the start of the -/// next row in the given destination stream. Number of -/// stride values in the array must be the same as the -/// channel number. All stride values must not be less than -/// width * (element size in bytes). -/// @param width Number of pixels in one row of the source. (One pixel -/// consists of 'channels' number of elements.) -/// @param height Number of rows in the source. -/// @param channels Number of channels in the source. -/// @param element_size Size of one element in bytes. -/// void INTRINSICCV_C_API(split)(const void *src_data, size_t src_stride, void **dst_data, size_t *dst_strides, size_t width, size_t height, size_t channels, @@ -602,27 +580,6 @@ void INTRINSICCV_C_API(transpose)(const void *src, size_t src_stride, void *dst, size_t dst_stride, size_t src_width, size_t src_height, size_t element_size); -/// Merges separate 1-channel source streams to one multi channel stream. -/// -/// @param srcs A C style array of pointers to the source data. -/// Number of pointers in the array must be the same as the -/// channel number. All pointers must be non-null. -/// @param src_strides A C style array of stride values for the source -/// streams. A stride value represents the distance in -/// bytes from the start of one row to the start of the -/// next row in the given source stream. Number of -/// stride values in the array must be the same as the -/// channel number. All stride values must not be less than -/// width * (element size in bytes). -/// @param dst Pointer to the destination data. Must be non-null. -/// @param dst_stride Distance in bytes from the start of one row to the -/// start of the next row in the destination data. Must not -/// be less than width * (element size in bytes) * channels. -/// @param width Number of elements in a row in the source. -/// @param height Number of rows in the source. -/// @param channels Number of channels in the destination. -/// @param element_size Size of one element in bytes. -/// void INTRINSICCV_C_API(merge)(const void **srcs, const size_t *src_strides, void *dst, size_t dst_stride, size_t width, size_t height, size_t channels, @@ -633,8 +590,8 @@ void INTRINSICCV_C_API(merge)(const void **srcs, const size_t *src_strides, /// @param src Pointer to the source data. Must be non-null. /// @param src_stride Distance in bytes from the start of one row to the /// start of the next row in the source data. Must not be -/// less than width * (element size in bytes). -/// @param width Number of elements in a row. +/// less than width * sizeof(type). +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param min_value Pointer to save result minimum value to, or nullptr if /// minimum is not to be calculated. @@ -668,8 +625,8 @@ void INTRINSICCV_C_API(min_max_s32)(const int32_t *src, size_t src_stride, /// @param src Pointer to the source data. Must be non-null. /// @param src_stride Distance in bytes from the start of one row to the /// start of the next row in the source data. Must not be -/// less than width * (element size in bytes). -/// @param width Number of elements in a row. +/// less than width * sizeof(type). +/// @param width Number of elements are in a row. /// @param height Number of rows in the data. /// @param min_offset Pointer to save result offset of minimum value to, or /// nullptr if minimum is not to be calculated. -- GitLab