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 <simon.marchi@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/src/common/dynamic-array.h b/src/common/dynamic-array.h
index 1fbc29b70ac06285a30fc4ac21c60a5f081165af..483db363122ebbc5a6339cd5ec144a2181922066 100644 (file)
--- 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(
  */
 static inline
 void *lttng_dynamic_pointer_array_get_pointer(