summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-08-08 12:33:26 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-08-08 12:34:52 -0400
commitddb5482ab08475d54df0d21f6eeaa628bdd5aad5 (patch)
tree8ec5999509f95a335d39e9c9dec1f8b943de849e
parentcc74b40a0c5f3bf467c4766696d6a2ccdf1237db (diff)
downloadpango-ddb5482ab08475d54df0d21f6eeaa628bdd5aad5.tar.gz
docs: Some clarifications
Add some more detail around baseline-to-baseline distances.
-rw-r--r--pango/fonts.c4
-rw-r--r--pango/pango-layout.c9
2 files changed, 9 insertions, 4 deletions
diff --git a/pango/fonts.c b/pango/fonts.c
index cd30811c..45d05b38 100644
--- a/pango/fonts.c
+++ b/pango/fonts.c
@@ -2115,8 +2115,8 @@ pango_font_metrics_get_descent (PangoFontMetrics *metrics)
*
* Gets the line height from a font metrics structure.
*
- * The line height is the distance between successive baselines
- * in wrapped text.
+ * The line height is the recommended distance between successive
+ * baselines in wrapped text using this font.
*
* If the line height is not available, 0 is returned.
*
diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index ae0bc330..b39ca62b 100644
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -5286,8 +5286,13 @@ pango_layout_line_get_extents (PangoLayoutLine *line,
* @line: a `PangoLayoutLine`
* @height: (out) (optional): return location for the line height
*
- * Computes the height of the line, i.e. the distance between
- * this and the previous lines baseline.
+ * Computes the height of the line, as the maximum of the heights
+ * of fonts used in this line.
+ *
+ * Note that the actual baseline-to-baseline distance between lines
+ * of text is influenced by other factors, such as
+ * [method@Pango.Layout.set_spacing] and
+ * [method@Pango.Layout.set_line_spacing].
*
* Since: 1.44
*/