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
--- a/src/cx/array_list.h	Tue Dec 20 16:09:03 2022 +0100
+++ b/src/cx/array_list.h	Mon Jan 23 20:00:26 2023 +0100
@@ -101,9 +101,10 @@
  * Copies elements from one array to another.
  *
  * The elements are copied to the \p target array at the specified \p index,
- * overwriting possible elements. The index must be in range of the current
- * array \p size. If the number of elements added would extend the array's size,
- * and \p capacity is not \c NULL, the remaining capacity is used.
+ * overwriting possible elements. The \p index does not need to be in range of
+ * the current array \p size. If the new index plus the number of elements added
+ * would extend the array's size, and \p capacity is not \c NULL, the remaining
+ * capacity is used.
  *
  * If the capacity is insufficient to hold the new data, a reallocation
  * attempt is made, unless the allocator is set to \c NULL, in which case

mercurial