diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2021-07-09 15:26:00 -0400 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2021-07-09 15:26:00 -0400 |
| commit | 33267e41a74fc5d8fd7bb9091760dfd03ea9b94e (patch) | |
| tree | 6523aaa318f3482d7a77f2d2c7e4c24134451b57 /pango/pango-layout.c | |
| parent | 4ecec6eff40a8ed3c6e3d5acbbdc01d00311668b (diff) | |
| download | pango-33267e41a74fc5d8fd7bb9091760dfd03ea9b94e.tar.gz | |
docs: Small layout docs improvements
Add some more default values, and correct the docs
for pango_layout_set_spacing wrt to the default value.
Diffstat (limited to 'pango/pango-layout.c')
| -rw-r--r-- | pango/pango-layout.c | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/pango/pango-layout.c b/pango/pango-layout.c index 0227f819..9b61cf77 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -456,6 +456,8 @@ pango_layout_get_height (PangoLayout *layout) * The wrap mode only has effect if a width is set on the layout * with [method@Pango.Layout.set_width]. To turn off wrapping, * set the width to -1. + * + * The default value is %PANGO_WRAP_WORD. */ void pango_layout_set_wrap (PangoLayout *layout, @@ -530,6 +532,8 @@ pango_layout_is_wrapped (PangoLayout *layout) * * The indent setting is ignored if layout alignment is set to * %PANGO_ALIGN_CENTER. + * + * The default value is 0. */ void pango_layout_set_indent (PangoLayout *layout, @@ -573,11 +577,12 @@ pango_layout_get_indent (PangoLayout *layout) * * line2.top = line1.bottom + spacing * - * Note: Since 1.44, Pango defaults to using the line height - * (as determined by the font) for placing lines. The @spacing - * set with this function is only taken into account when the - * line height factor is set to zero with - * [method@Pango.Layout.set_line_spacing]. + * The default value is 0. + * + * Note: Since 1.44, Pango is using the line height (as determined + * by the font) for placing lines when the line height factor is set + * to a non-zero value with [method@Pango.Layout.set_line_spacing]. + * In that case, the @spacing set with this function is ignored. */ void pango_layout_set_spacing (PangoLayout *layout, @@ -624,7 +629,7 @@ pango_layout_get_spacing (PangoLayout *layout) * (as determined by the font(s)). In this case, the spacing * set with [method@Pango.Layout.set_spacing] is ignored. * - * If @factor is zero, spacing is applied as before. + * If @factor is zero (the default), spacing is applied as before. * * Since: 1.44 */ |