remove the untrue restriction for the index parameter of cx_array_copy() from the documentation

Mon, 23 Jan 2023 20:00:26 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 23 Jan 2023 20:00:26 +0100
changeset 637
ceadf0792ded
parent 636
cfcc8cf0168c
child 638
eafb45eefc51

remove the untrue restriction for the index parameter of cx_array_copy() from the documentation

src/cx/array_list.h file | annotate | diff | comparison | revisions
     1.1 --- a/src/cx/array_list.h	Tue Dec 20 16:09:03 2022 +0100
     1.2 +++ b/src/cx/array_list.h	Mon Jan 23 20:00:26 2023 +0100
     1.3 @@ -101,9 +101,10 @@
     1.4   * Copies elements from one array to another.
     1.5   *
     1.6   * The elements are copied to the \p target array at the specified \p index,
     1.7 - * overwriting possible elements. The index must be in range of the current
     1.8 - * array \p size. If the number of elements added would extend the array's size,
     1.9 - * and \p capacity is not \c NULL, the remaining capacity is used.
    1.10 + * overwriting possible elements. The \p index does not need to be in range of
    1.11 + * the current array \p size. If the new index plus the number of elements added
    1.12 + * would extend the array's size, and \p capacity is not \c NULL, the remaining
    1.13 + * capacity is used.
    1.14   *
    1.15   * If the capacity is insufficient to hold the new data, a reallocation
    1.16   * attempt is made, unless the allocator is set to \c NULL, in which case

mercurial