text: Add doc to line_index_at_point

ruffle-rs · Dec 12, 2024 · 699a06d · 699a06d
1 parent 9f9d671
commit 699a06d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/src/display_object/edit_text.rs b/core/src/display_object/edit_text.rs
@@ -2100,6 +2100,11 @@ impl<'gc> EditText<'gc> {
         Some(first_box.start())
     }
 
+    /// Returns the index of the line that is at the given position.
+    ///
+    /// It returns `None` when there's no line at the given position,
+    /// with the exception that positions below the last line will
+    /// return the index of the last line.
     pub fn line_index_at_point(self, position: Point<Twips>) -> Option<usize> {
         let edit_text = self.0.read();