From 9909e3326806f0ad1405648c16296cd42dff39fc Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 15 Feb 2022 18:02:09 -0600 Subject: [PATCH] Improve docs for hb_ot_layout_get_ligature_carets Add some relevant details to the documentation for this function. Fixes: #3168 --- src/hb-ot-layout.cc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/hb-ot-layout.cc b/src/hb-ot-layout.cc index a599eea6e..2d73ab690 100644 --- a/src/hb-ot-layout.cc +++ b/src/hb-ot-layout.cc @@ -361,6 +361,13 @@ hb_ot_layout_get_attach_points (hb_face_t *face, * Fetches a list of the caret positions defined for a ligature glyph in the GDEF * table of the font. The list returned will begin at the offset provided. * + * Note that a ligature that is formed from n characters will have n-1 + * caret positions. The first character is not represented in the array, + * since its caret position is the glyph position. + * + * The positions returned by this function are 'unshaped', and will have to + * be fixed up for kerning that may be applied to the ligature glyph. + * * Return value: Total number of ligature caret positions for @glyph. * **/