Comment

1 files changed, 4 insertions, 1 deletions

diff --git a/include/mgl/graphics/text.h b/include/mgl/graphics/text.h
index 8e4817b..86d297f 100644
--- a/include/mgl/graphics/text.h
+++ b/include/mgl/graphics/text.h
@@ -48,7 +48,10 @@ void mgl_text_set_max_width(mgl_text *self, float max_width);
 /* If |max_rows| is 0 then the text can display an unlimited amount of rows */
 void mgl_text_set_max_rows(mgl_text *self, unsigned int max_rows);
 mgl_vec2f mgl_text_get_bounds(mgl_text *self);
-/* Returns the position of the character relative to the window top left (relative to the current mgl_view) */
+/*
+    Returns the position of the character relative to the window top left (relative to the current mgl_view).
+    If the index is out of range, then the position of the end of the string is returned.
+*/
 mgl_vec2f mgl_text_find_character_pos(mgl_text *self, size_t index);
 void mgl_text_draw(mgl_context *context, mgl_text *text);