garray: Note lack of bounds checking in g_ptr_array_index() documentation
authorPhilip Withnall <philip.withnall@collabora.co.uk>
Tue, 5 Nov 2013 16:43:26 +0000 (16:43 +0000)
committerPhilip Withnall <philip.withnall@collabora.co.uk>
Tue, 5 Nov 2013 16:43:26 +0000 (16:43 +0000)
glib/garray.c

index 3bfbe9d..a93044b 100644 (file)
@@ -865,6 +865,10 @@ struct _GRealPtrArray
  *
  * Returns the pointer at the given index of the pointer array.
  *
+ * <note><para>
+ * This does not perform bounds checking on the given @index_, so you are
+ * responsible for checking it against the array length.</para></note>
+ *
  * Returns: the pointer at the given index.
  **/