From: Simon Marchi Date: Fri, 13 Dec 2019 21:47:57 +0000 (-0500) Subject: dynamic-array: fix documentation of lttng_dynamic_pointer_array_get_pointer X-Git-Tag: v2.11.1~22 X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=5ba6017516b4a6d1bc694b2d4ec3569b0348d7c3;p=lttng-tools.git dynamic-array: fix documentation of lttng_dynamic_pointer_array_get_pointer The documentation of this function says that mutating the array invalidates the return pointer. This is not true, since the returned pointer is the element itself, not a pointer to the array. Change-Id: I8b8978cddb2d1d6ce0b42ed313e9843ca418c96c Signed-off-by: Simon Marchi Signed-off-by: Jérémie Galarneau --- diff --git a/src/common/dynamic-array.h b/src/common/dynamic-array.h index 1fbc29b70..483db3631 100644 --- a/src/common/dynamic-array.h +++ b/src/common/dynamic-array.h @@ -117,8 +117,7 @@ size_t lttng_dynamic_pointer_array_get_count( } /* - * Returns a pointer to the element. Mutating operations on the array invalidate - * the returned pointer. + * Returns the pointer at index `index`. */ static inline void *lttng_dynamic_pointer_array_get_pointer(