From 067c727321da5c05d90930768ce40ef6f9d83874 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 29 Dec 2021 13:55:23 -0500 Subject: fontmap: Improve docs slightly Mention GListModel. --- pango/pango-fontmap.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pango/pango-fontmap.c b/pango/pango-fontmap.c index 7321d975..71e3e20c 100644 --- a/pango/pango-fontmap.c +++ b/pango/pango-fontmap.c @@ -124,6 +124,11 @@ pango_font_map_load_font (PangoFontMap *fontmap, * @n_families: (out): location to store the number of elements in @families * * List all families for a fontmap. + * + * Note that the returned families are not in any particular order. + * + * `PangoFontMap` also implemented the [iface@Gio.ListModel] interface + * for enumerating families. */ void pango_font_map_list_families (PangoFontMap *fontmap, -- cgit v1.2.1 From 3593dfba9e8562d2fcf4741f1aea15ce9908628d Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 29 Dec 2021 13:54:47 -0500 Subject: font: Documentation additions and clarifications Face names are not actually guaranteed to be unique, so don't say that. --- pango/fonts.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/pango/fonts.c b/pango/fonts.c index 79776b50..99262942 100644 --- a/pango/fonts.c +++ b/pango/fonts.c @@ -2420,6 +2420,12 @@ pango_font_family_get_name (PangoFontFamily *family) * * The faces in a family share a common design, but differ in slant, weight, * width and other aspects. + * + * Note that the returned faces are not in any particular order, and + * multiple faces may have the same name or characteristics. + * + * `PangoFontFamily` also implemented the [iface@Gio.ListModel] interface + * for enumerating faces. */ void pango_font_family_list_faces (PangoFontFamily *family, @@ -2609,9 +2615,9 @@ pango_font_face_is_synthesized (PangoFontFace *face) * * Gets a name representing the style of this face. * - * The name identifies the face among the different faces - * in the `PangoFontFamily` for the face. It is suitable - * for displaying to users. + * Note that a font family may contain multiple faces + * with the same name (e.g. a variable and a non-variable + * face for the same style). * * Return value: the face name for the face. This string is * owned by the face object and must not be modified or freed. -- cgit v1.2.1