summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-08-08 16:40:12 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-08-08 17:50:21 -0400
commitd20b0c92ff117c62fdacfc1bc1075730013a969d (patch)
treeeb3e28c6d7b30bb240d30030e9680590469c28c1
parentaaa473091d6c837b52f54d21e1ca3a884e42889a (diff)
downloadpango-d20b0c92ff117c62fdacfc1bc1075730013a969d.tar.gz
docs: Cosmetic fixeslayout-docs
-rw-r--r--docs/pango_markup.md10
-rw-r--r--docs/pango_rendering.md15
2 files changed, 13 insertions, 12 deletions
diff --git a/docs/pango_markup.md b/docs/pango_markup.md
index c82de9d5..16359777 100644
--- a/docs/pango_markup.md
+++ b/docs/pango_markup.md
@@ -39,7 +39,7 @@ string into the string text plus a [struct@Pango.AttrList] using either of
A simple example of a marked-up string might be:
```
-<span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!"
+<span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
```
![Markup example](blue-text.png)
@@ -56,7 +56,7 @@ Arabic text:
Pango uses GMarkup to parse this language, which means that XML features
such as numeric character entities such as `&#169;` for © can be used too.
-The root tag of a marked-up document is `<markup>`, but pango_parse_markup()
+The root tag of a marked-up document is `<markup>`, but [func@Pango.parse_markup]
allows you to omit this tag, so you will most likely never need to use it.
The most general markup tag is `<span>`, then there are some convenience
tags.
@@ -66,7 +66,7 @@ tags.
font
font_desc
: A font description string, such as "Sans Italic 12". See
- pango_font_description_from_string() for a description of the format of
+ [func@Pango.FontDescription.from_string] for a description of the format of
the string representation. Note that any other span attributes will override
this description. So if you have "Sans Italic" and also a style="normal"
attribute, you will get Sans normal, not italic.
@@ -141,11 +141,11 @@ underline_color
name such as 'red'.
overline
-: One of 'none' or 'single'. Overline support was added in Pango 1.46/
+: One of 'none' or 'single'. Overline support was added in Pango 1.46.
overline_color
: The color of overlines; an RGB color specification such as '#00FF00' or a color
- name such as 'red'. Overline support was added in Pango 1.46/
+ name such as 'red'. Overline support was added in Pango 1.46.
rise
: Vertical displacement, in Pango units or in points (e.g. '5pt'). Can be
diff --git a/docs/pango_rendering.md b/docs/pango_rendering.md
index 9dfddd55..2745c0c0 100644
--- a/docs/pango_rendering.md
+++ b/docs/pango_rendering.md
@@ -16,23 +16,24 @@ various stages of this pipeline and the APIs that implement them.
Itemization
: breaks a piece of text into segments with consistent direction and shaping
properies. Among other things, this determines which font to use for each
- character. Use pango_itemize() or pango_itemize_with_base_dir() to itemize text.
+ character. Use [func@Pango.itemize] or [func@Pango.itemize_with_base_dir]
+ to itemize text.
Shaping
-: converts characters into glyphs. Use pango_shape(), pango_shape_full() or
- pango_shape_with_flags() to shape text.
+: converts characters into glyphs. Use [func@Pango.shape],
+ [func@Pango.shape_full] or [func@Pango.shape_with_flags] to shape text.
Line Breaking
: determines where line breaks should be inserted into a sequence of glyphs.
- The function pango_break() determines possible line breaks. The actual line
- breaking is done by [class@Pango.Layout].
+ The function [func@Pango.break] determines possible line breaks. The actual
+ line breaking is done by [class@Pango.Layout].
Justification
: adjusts inter-word spacing to form lines of even length. This is done by
[class@Pango.Layout].
Rendering
-: takes a string of positioned glyphs, and renders them onto a surface. This is
- accomplished by a [class@Pango.Renderer] object. The functions
+: takes a string of positioned glyphs, and renders them onto a surface.
+ This is accomplished by a [class@Pango.Renderer] object. The functions
pango_cairo_show_glyph_string() and pango_cairo_show_layout() use a
[class@Pango.Renderer] to draw text onto a cairo surface.