diff options
author | Matthias Clasen <mclasen@redhat.com> | 2021-02-04 17:57:01 -0500 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2021-03-11 13:17:36 -0500 |
commit | bc2106a9e19b412c22390b8709d6ea2bc4df179d (patch) | |
tree | 0fac475d51e8a172aa86e25312e3ce3e2c7847c2 /pango/pango-gravity.c | |
parent | 7d3628ba5dfb173bc8b1d5e7ad0a214d428fb6a7 (diff) | |
download | pango-bc2106a9e19b412c22390b8709d6ea2bc4df179d.tar.gz |
docs: Replace lots of vestigial xml markup
We want to use pure markdown, since docbook
is going away as the intermediate format.
Diffstat (limited to 'pango/pango-gravity.c')
-rw-r--r-- | pango/pango-gravity.c | 54 |
1 files changed, 26 insertions, 28 deletions
diff --git a/pango/pango-gravity.c b/pango/pango-gravity.c index 8565db16..2d48c45e 100644 --- a/pango/pango-gravity.c +++ b/pango/pango-gravity.c @@ -33,47 +33,45 @@ * pango_attr_gravity_new(), * pango_attr_gravity_hint_new() * - * Since 1.16, Pango is able to correctly lay vertical text out. In fact, it can - * set layouts of mixed vertical and non-vertical text. This section describes + * Since 1.16, Pango is able to correctly lay vertical text out. In fact, it can + * set layouts of mixed vertical and non-vertical text. This section describes * the types used for setting vertical text parameters. * - * The way this is implemented is through the concept of - * <firstterm>gravity</firstterm>. Gravity of normal Latin text is south. A - * gravity value of east means that glyphs will be rotated ninety degrees - * counterclockwise. So, to render vertical text one needs to set the gravity - * and rotate the layout using the matrix machinery already in place. This has - * the huge advantage that most algorithms working on a #PangoLayout do not need - * any change as the assumption that lines run in the X direction and stack in - * the Y direction holds even for vertical text layouts. + * The way this is implemented is through the concept of *gravity*. Gravity of + * normal Latin text is south. A gravity value of east means that glyphs will be + * rotated ninety degrees counterclockwise. So, to render vertical text one needs + * to set the gravity and rotate the layout using the matrix machinery already in + * place. This has the huge advantage that most algorithms working on a #PangoLayout + * do not need any change as the assumption that lines run in the X direction and + * stack in the Y direction holds even for vertical text layouts. * * Applications should only need to set base gravity on #PangoContext in use, and - * let Pango decide the gravity assigned to each run of text. This automatically - * handles text with mixed scripts. A very common use is to set the context base - * gravity to auto using pango_context_set_base_gravity() - * and rotate the layout normally. Pango will make sure that - * Asian languages take the right form, while other scripts are rotated normally. + * let Pango decide the gravity assigned to each run of text. This automatically + * handles text with mixed scripts. A very common use is to set the context base + * gravity to auto using pango_context_set_base_gravity() and rotate the layout + * normally. Pango will make sure that Asian languages take the right form, while + * other scripts are rotated normally. * * The correct way to set gravity on a layout is to set it on the context - * associated with it using pango_context_set_base_gravity(). The context - * of a layout can be accessed using pango_layout_get_context(). The currently + * associated with it using pango_context_set_base_gravity(). The context + * of a layout can be accessed using pango_layout_get_context(). The currently * set base gravity of the context can be accessed using - * pango_context_get_base_gravity() and the <firstterm>resolved</firstterm> - * gravity of it using pango_context_get_gravity(). The resolved gravity is - * the same as the base gravity for the most part, except that if the base - * gravity is set to %PANGO_GRAVITY_AUTO, the resolved gravity will depend - * on the current matrix set on context, and is derived using - * pango_gravity_get_for_matrix(). + * pango_context_get_base_gravity() and the *resolved* gravity of it using + * pango_context_get_gravity(). The resolved gravity is the same as the base + * gravity for the most part, except that if the base gravity is set to + * %PANGO_GRAVITY_AUTO, the resolved gravity will depend on the current matrix + * set on context, and is derived using pango_gravity_get_for_matrix(). * * The next thing an application may want to set on the context is the - * <firstterm>gravity hint</firstterm>. A #PangoGravityHint instructs how - * different scripts should react to the set base gravity. + * *gravity hint*. A #PangoGravityHint instructs how different scripts should + * react to the set base gravity. * * Font descriptions have a gravity property too, that can be set using * pango_font_description_set_gravity() and accessed using - * pango_font_description_get_gravity(). However, those are rarely useful + * pango_font_description_get_gravity(). However, those are rarely useful * from application code and are mainly used by #PangoLayout internally. * - * Last but not least, one can create #PangoAttribute<!---->s for gravity + * Last but not least, one can create #PangoAttributes for gravity * and gravity hint using pango_attr_gravity_new() and * pango_attr_gravity_hint_new(). */ @@ -335,7 +333,7 @@ pango_gravity_get_for_script (PangoScript script, * This function is similar to pango_gravity_get_for_script() except * that this function makes a distinction between narrow/half-width and * wide/full-width characters also. Wide/full-width characters always - * stand <emphasis>upright</emphasis>, that is, they always take the base gravity, + * stand *upright*, that is, they always take the base gravity, * whereas narrow/full-width characters are always rotated in vertical * context. * |