summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-12-29 13:54:47 -0500
committerMatthias Clasen <mclasen@redhat.com>2022-01-01 20:00:01 -0500
commit3593dfba9e8562d2fcf4741f1aea15ce9908628d (patch)
tree79b497faef7cc44fd8bb3569ac96d4b7a6682586
parent067c727321da5c05d90930768ce40ef6f9d83874 (diff)
downloadpango-3593dfba9e8562d2fcf4741f1aea15ce9908628d.tar.gz
font: Documentation additions and clarifications
Face names are not actually guaranteed to be unique, so don't say that.
-rw-r--r--pango/fonts.c12
1 files 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.