[pango/gi-docs: 5/30] docs: Replace lots of vestigial xml markup
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pango/gi-docs: 5/30] docs: Replace lots of vestigial xml markup
- Date: Wed, 17 Feb 2021 07:07:15 +0000 (UTC)
commit 4475e19636b3f073ce5f361dde4de21996580b54
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Feb 4 17:57:01 2021 -0500
docs: Replace lots of vestigial xml markup
We want to use pure markdown, since docbook
is going away as the intermediate format.
pango/fonts.c | 6 ++---
pango/pango-attributes.c | 2 +-
pango/pango-break.h | 63 +++++++++++++++++++++-------------------------
pango/pango-color.c | 48 ++++++++++++++++-------------------
pango/pango-engine.c | 4 +--
pango/pango-engine.h | 35 +++++++++++++-------------
pango/pango-font.h | 2 +-
pango/pango-fontmap.c | 2 +-
pango/pango-glyph-item.h | 15 +++++------
pango/pango-gravity.c | 54 +++++++++++++++++++--------------------
pango/pango-language.c | 31 +++++++++++------------
pango/pango-layout.c | 52 ++++++++++++++++++--------------------
pango/pango-markup.c | 12 ++++-----
pango/pango-matrix.c | 4 +--
pango/pango-matrix.h | 10 ++++----
pango/pango-ot-info.c | 2 +-
pango/pango-ot-private.h | 4 +--
pango/pango-ot-ruleset.c | 22 ++++++----------
pango/pango-ot.h | 8 +++---
pango/pango-renderer.c | 6 ++---
pango/pango-script.c | 4 +--
pango/pango-script.h | 11 ++++----
pango/pango-tabs.c | 7 +++---
pango/pango-types.h | 8 +++---
pango/pango-utils.c | 4 +--
pango/pangocairo-render.c | 21 ++++++++--------
pango/pangofc-font.c | 15 ++++-------
pango/pangofc-fontmap.c | 12 ++-------
pango/pangoft2-render.c | 8 +++---
pango/pangoft2.h | 2 +-
pango/pangowin32-fontmap.c | 4 +--
pango/pangoxft-render.c | 6 ++---
32 files changed, 221 insertions(+), 263 deletions(-)
---
diff --git a/pango/fonts.c b/pango/fonts.c
index 9f3e9af8..a778facd 100644
--- a/pango/fonts.c
+++ b/pango/fonts.c
@@ -1857,7 +1857,7 @@ pango_font_get_metrics (PangoFont *font,
*
* Gets the font map for which the font was created.
*
- * Note that the font maintains a <firstterm>weak</firstterm> reference
+ * Note that the font maintains a *weak* reference
* to the font map, so if all references to font map are dropped, the font
* map will be finalized even if there are fonts created with the font
* map that are still alive. In that case this function will return %NULL.
@@ -2101,7 +2101,7 @@ pango_font_metrics_get_approximate_digit_width (PangoFontMetrics *metrics)
* @metrics: a #PangoFontMetrics structure
*
* Gets the suggested position to draw the underline.
- * The value returned is the distance <emphasis>above</emphasis> the
+ * The value returned is the distance *above* the
* baseline of the top of the underline. Since most fonts have
* underline positions beneath the baseline, this value is typically
* negative.
@@ -2141,7 +2141,7 @@ pango_font_metrics_get_underline_thickness (PangoFontMetrics *metrics)
* @metrics: a #PangoFontMetrics structure
*
* Gets the suggested position to draw the strikethrough.
- * The value returned is the distance <emphasis>above</emphasis> the
+ * The value returned is the distance *above* the
* baseline of the top of the strikethrough.
*
* Return value: the suggested strikethrough position, in Pango units.
diff --git a/pango/pango-attributes.c b/pango/pango-attributes.c
index 3ef76a70..a545fa78 100644
--- a/pango/pango-attributes.c
+++ b/pango/pango-attributes.c
@@ -2164,7 +2164,7 @@ pango_attr_iterator_get (PangoAttrIterator *iterator,
* pango_font_description_set_family_static() using values from
* an attribute in the #PangoAttrList associated with the iterator,
* so if you plan to keep it around, you must call:
- * <literal>pango_font_description_set_family (desc, pango_font_description_get_family
(desc))</literal>.
+ * pango_font_description_set_family (desc, pango_font_description_get_family (desc)).
* @language: (allow-none): if non-%NULL, location to store language tag for item, or %NULL
* if none is found.
* @extra_attrs: (allow-none) (element-type Pango.Attribute) (transfer full): if non-%NULL,
diff --git a/pango/pango-break.h b/pango/pango-break.h
index 9209ee15..ae7d953a 100644
--- a/pango/pango-break.h
+++ b/pango/pango-break.h
@@ -37,51 +37,44 @@ G_BEGIN_DECLS
* @is_char_break: if set, can break here when doing character wrapping
* @is_white: is whitespace character
* @is_cursor_position: if set, cursor can appear in front of character.
- * i.e. this is a grapheme boundary, or the first character
- * in the text.
- * This flag implements Unicode's
- * <ulink url="http://www.unicode.org/reports/tr29/";>Grapheme
- * Cluster Boundaries</ulink> semantics.
+ * i.e. this is a grapheme boundary, or the first character in the text.
+ * This flag implements Unicode's
+ * [Grapheme Cluster Boundaries](http://www.unicode.org/reports/tr29/)
+ * semantics.
* @is_word_start: is first character in a word
* @is_word_end: is first non-word char after a word
- * Note that in degenerate cases, you could have both @is_word_start
- * and @is_word_end set for some character.
+ * Note that in degenerate cases, you could have both @is_word_start
+ * and @is_word_end set for some character.
* @is_sentence_boundary: is a sentence boundary.
- * There are two ways to divide sentences. The first assigns all
- * inter-sentence whitespace/control/format chars to some sentence,
- * so all chars are in some sentence; @is_sentence_boundary denotes
- * the boundaries there. The second way doesn't assign
- * between-sentence spaces, etc. to any sentence, so
+ * There are two ways to divide sentences. The first assigns all
+ * inter-sentence whitespace/control/format chars to some sentence,
+ * so all chars are in some sentence; @is_sentence_boundary denotes
+ * the boundaries there. The second way doesn't assign
+ * between-sentence spaces, etc. to any sentence, so
* @is_sentence_start/@is_sentence_end mark the boundaries of those sentences.
* @is_sentence_start: is first character in a sentence
* @is_sentence_end: is first char after a sentence.
- * Note that in degenerate cases, you could have both @is_sentence_start
- * and @is_sentence_end set for some character. (e.g. no space after a
- * period, so the next sentence starts right away)
+ * Note that in degenerate cases, you could have both @is_sentence_start
+ * and @is_sentence_end set for some character. (e.g. no space after a
+ * period, so the next sentence starts right away)
* @backspace_deletes_character: if set, backspace deletes one character
- * rather than the entire grapheme cluster. This
- * field is only meaningful on grapheme
- * boundaries (where @is_cursor_position is
- * set). In some languages, the full grapheme
- * (e.g. letter + diacritics) is considered a
- * unit, while in others, each decomposed
- * character in the grapheme is a unit. In the
- * default implementation of pango_break(), this
- * bit is set on all grapheme boundaries except
- * those following Latin, Cyrillic or Greek base characters.
+ * rather than the entire grapheme cluster. This field is only meaningful
+ * on grapheme boundaries (where @is_cursor_position is set). In some languages,
+ * the full grapheme (e.g. letter + diacritics) is considered a unit, while in
+ * others, each decomposed character in the grapheme is a unit. In the default
+ * implementation of [func@break], this bit is set on all grapheme boundaries
+ * except those following Latin, Cyrillic or Greek base characters.
* @is_expandable_space: is a whitespace character that can possibly be
- * expanded for justification purposes. (Since: 1.18)
+ * expanded for justification purposes. (Since: 1.18)
* @is_word_boundary: is a word boundary, as defined by UAX#29.
- * More specifically, means that this is not a position in the middle
- * of a word. For example, both sides of a punctuation mark are
- * considered word boundaries. This flag is particularly useful when
- * selecting text word-by-word.
- * This flag implements Unicode's
- * <ulink url="http://www.unicode.org/reports/tr29/";>Word
- * Boundaries</ulink> semantics. (Since: 1.22)
+ * More specifically, means that this is not a position in the middle of a word.
+ * For example, both sides of a punctuation mark are considered word boundaries.
+ * This flag is particularly useful when selecting text word-by-word. This flag
+ * implements Unicode's [Word Boundaries](http://www.unicode.org/reports/tr29/)
+ * semantics. (Since: 1.22)
*
- * The #PangoLogAttr structure stores information
- * about the attributes of a single character.
+ * The `PangoLogAttr` structure stores information about the attributes of a
+ * single character.
*/
struct _PangoLogAttr
{
diff --git a/pango/pango-color.c b/pango/pango-color.c
index a530719f..7f939030 100644
--- a/pango/pango-color.c
+++ b/pango/pango-color.c
@@ -80,8 +80,7 @@ pango_color_free (PangoColor *color)
* @color: a #PangoColor
*
* Returns a textual specification of @color in the hexadecimal form
- * <literal>#rrrrggggbbbb</literal>, where <literal>r</literal>,
- * <literal>g</literal> and <literal>b</literal> are hex digits representing
+ * `#rrrrggggbbbb`, where `r`, `g` and `b` are hex digits representing
* the red, green, and blue components respectively.
*
* Return value: a newly-allocated text string that must be freed with g_free().
@@ -214,23 +213,20 @@ hex (const char *spec,
* @alpha: (out) (optional): return location for alpha, or %NULL
* @spec: a string specifying the new color
*
- * Fill in the fields of a color from a string specification. The
- * string can either one of a large set of standard names. (Taken
- * from the CSS <ulink url="http://dev.w3.org/csswg/css-color/#named-colors";>specification</ulink>), or it
can be a hexadecimal
- * value in the
- * form '#rgb' '#rrggbb' '#rrrgggbbb' or '#rrrrggggbbbb' where
- * 'r', 'g' and 'b' are hex digits of the red, green, and blue
- * components of the color, respectively. (White in the four
- * forms is '#fff' '#ffffff' '#fffffffff' and '#ffffffffffff')
+ * Fill in the fields of a color from a string specification. The string can
+ * either one of a large set of standard names. (Taken from the CSS Color
+ * [specification](https://www.w3.org/TR/css-color-4/#named-colors),
+ * or it can be a hexadecimal value in the form `#rgb`, `#rrggbb`, `#rrrgggbbb`
+ * or `#rrrrggggbbbb` where `r`, `g` and `b` are hex digits of the red, green,
+ * and blue components of the color, respectively. (White in the four
+ * forms is `#fff`, `#ffffff`, `#fffffffff` and `#ffffffffffff`.)
*
- * Additionally, parse strings of the form
- * '#rgba', '#rrggbbaa', '#rrrrggggbbbbaaaa',
- * if @alpha is not %NULL, and set @alpha to the value specified
- * by the hex digits for 'a'. If no alpha component is found
+ * Additionally, parse strings of the form `#rgba`, `#rrggbbaa`,
+ * `#rrrrggggbbbbaaaa`, if @alpha is not %NULL, and set @alpha to the value
+ * specified by the hex digits for `a`. If no alpha component is found
* in @spec, @alpha is set to 0xffff (for a solid color).
*
- * Return value: %TRUE if parsing of the specifier succeeded,
- * otherwise false.
+ * Return value: %TRUE if parsing of the specifier succeeded, otherwise false.
*
* Since: 1.46
*/
@@ -323,21 +319,19 @@ pango_color_parse_with_alpha (PangoColor *color,
* result, or %NULL
* @spec: a string specifying the new color
*
- * Fill in the fields of a color from a string specification. The
- * string can either one of a large set of standard names. (Taken
- * from the CSS <ulink url="http://dev.w3.org/csswg/css-color/#named-colors";>specification</ulink>), or it
can be a hexadecimal
- * value in the
- * form '#rgb' '#rrggbb' '#rrrgggbbb' or '#rrrrggggbbbb' where
- * 'r', 'g' and 'b' are hex digits of the red, green, and blue
- * components of the color, respectively. (White in the four
- * forms is '#fff' '#ffffff' '#fffffffff' and '#ffffffffffff')
+ * Fill in the fields of a color from a string specification. The string can either
+ * one of a large set of standard names. (Taken from the CSS Color
+ * [specification](https://www.w3.org/TR/css-color-4/#named-colors), or it can be
+ * a value in the form `#rgb`, `#rrggbb`, `#rrrgggbbb` or `#rrrrggggbbbb`, where
+ * `r`, `g` and `b` are hex digits of the red, green, and blue components of the
+ * color, respectively. (White in the four forms is `#fff`, `#ffffff`, `#fffffffff`
+ * and `#ffffffffffff`.)
*
- * Return value: %TRUE if parsing of the specifier succeeded,
- * otherwise false.
+ * Return value: %TRUE if parsing of the specifier succeeded, otherwise false.
**/
gboolean
pango_color_parse (PangoColor *color,
- const char *spec)
+ const char *spec)
{
return pango_color_parse_with_alpha (color, NULL, spec);
}
diff --git a/pango/pango-engine.c b/pango/pango-engine.c
index 9c7bf3b3..e8988b01 100644
--- a/pango/pango-engine.c
+++ b/pango/pango-engine.c
@@ -39,7 +39,7 @@
* @title:PangoEngineLang
* @stability:Unstable
*
- * The <firstterm>language engines</firstterm> are rendering-system independent
+ * The *language engines* are rendering-system independent
* engines that determine line, word, and character breaks for character strings.
* These engines are used in pango_break().
*
@@ -51,7 +51,7 @@
* @title:PangoEngineShape
* @stability:Unstable
*
- * The <firstterm>shape engines</firstterm> are rendering-system dependent
+ * The *shape engines* are rendering-system dependent
* engines that convert character strings into glyph strings.
* These engines are used in pango_shape().
*
diff --git a/pango/pango-engine.h b/pango/pango-engine.h
index 25cfd6ba..8b99ec63 100644
--- a/pango/pango-engine.h
+++ b/pango/pango-engine.h
@@ -196,7 +196,7 @@ struct _PangoEngineShape
* appropriately using pango_glyph_string_set_size()). All fields
* of the @log_clusters and @glyphs array must be filled in, with
* the exception that Pango will automatically generate
- * <literal>glyphs->glyphs[i].attr.is_cluster_start</literal>
+ * `glyphs->glyphs[i].attr.is_cluster_start`
* using the @log_clusters array. Each input character must occur in one
* of the output logical clusters;
* if no rendering is desired for a character, this may involve
@@ -368,8 +368,8 @@ prefix ## _register_type (GTypeModule *module) \
/**
* PANGO_ENGINE_LANG_DEFINE_TYPE:
- * @name: Name of the the type to register (for example:, <literal>ArabicEngineFc</literal>
- * @prefix: Prefix for symbols that will be defined (for example:, <literal>arabic_engine_fc</literal>
+ * @name: Name of the the type to register (for example:, ArabicEngineFc)
+ * @prefix: Prefix for symbols that will be defined (for example:, arabic_engine_fc)
* @class_init: (nullable): Class initialization function for the new type, or %NULL
* @instance_init: (nullable): Instance initialization function for the new type, or %NULL
*
@@ -378,18 +378,17 @@ prefix ## _register_type (GTypeModule *module) \
* are defined.
*
* <programlisting>
- * static GType <replaceable>prefix</replaceable>_type;
- * static void <replaceable>prefix</replaceable>_register_type (GTypeModule module);
- * </programlisting>
+ * static GType *prefix*_type;
+ * static void *prefix*_register_type (GTypeModule module);
*
- * The <function><replaceable>prefix</replaceable>_register_type()</function>
+ * The *prefix*_register_type()
* function should be called in your script_engine_init() function for
* each type that your module implements, and then your script_engine_create()
* function can create instances of the object as follows:
*
- * <informalexample><programlisting>
- * PangoEngine *engine = g_object_new (<replaceable>prefix</replaceable>_type, NULL);
- * </programlisting></informalexample>
+ * ```
+ * PangoEngine *engine = g_object_new (prefix_type, NULL);
+ * ```
*
* Deprecated: 1.38
**/
@@ -400,8 +399,8 @@ prefix ## _register_type (GTypeModule *module) \
/**
* PANGO_ENGINE_SHAPE_DEFINE_TYPE:
- * @name: Name of the the type to register (for example:, <literal>ArabicEngineFc</literal>
- * @prefix: Prefix for symbols that will be defined (for example:, <literal>arabic_engine_fc</literal>
+ * @name: Name of the the type to register (for example:, ArabicEngineFc)
+ * @prefix: Prefix for symbols that will be defined (for example:, arabic_engine_fc)
* @class_init: (nullable): Class initialization function for the new type, or %NULL
* @instance_init: (nullable): Instance initialization function for the new type, or %NULL
*
@@ -410,18 +409,18 @@ prefix ## _register_type (GTypeModule *module) \
* are defined.
*
* <programlisting>
- * static GType <replaceable>prefix</replaceable>_type;
- * static void <replaceable>prefix</replaceable>_register_type (GTypeModule module);
+ * static GType *prefix*_type;
+ * static void *prefix*_register_type (GTypeModule module);
* </programlisting>
*
- * The <function><replaceable>prefix</replaceable>_register_type()</function>
+ * The *prefix*_register_type()
* function should be called in your script_engine_init() function for
* each type that your module implements, and then your script_engine_create()
* function can create instances of the object as follows:
*
- * <informalexample><programlisting>
- * PangoEngine *engine = g_object_new (<replaceable>prefix</replaceable>_type, NULL);
- * </programlisting></informalexample>
+ * ```
+ * PangoEngine *engine = g_object_new (prefix_type, NULL);
+ * ```
*
* Deprecated: 1.38
**/
diff --git a/pango/pango-font.h b/pango/pango-font.h
index ba1ea3ae..cc12a295 100644
--- a/pango/pango-font.h
+++ b/pango/pango-font.h
@@ -582,7 +582,7 @@ PangoFontFamily * pango_font_face_get_family (PangoFontFace *face);
* To create an implementation of a #PangoFont,
* the rendering-system specific code should allocate
* a larger structure that contains a nested
- * #PangoFont, fill in the <structfield>klass</structfield> member of
+ * #PangoFont, fill in the `klass` member of
* the nested #PangoFont with a pointer to
* a appropriate #PangoFontClass, then call
* pango_font_init() on the structure.
diff --git a/pango/pango-fontmap.c b/pango/pango-fontmap.c
index d4cdefa6..3360b1ee 100644
--- a/pango/pango-fontmap.c
+++ b/pango/pango-fontmap.c
@@ -289,7 +289,7 @@ pango_font_map_real_load_fontset (PangoFontMap *fontmap,
* @fontmap: a #PangoFontMap
*
* Returns the render ID for shape engines for this fontmap.
- * See the <structfield>render_type</structfield> field of
+ * See the `render_type` field of
* #PangoEngineInfo.
*
* Return value: the ID string for shape engines for
diff --git a/pango/pango-glyph-item.h b/pango/pango-glyph-item.h
index daf2b15f..543d74bd 100644
--- a/pango/pango-glyph-item.h
+++ b/pango/pango-glyph-item.h
@@ -85,10 +85,10 @@ void pango_glyph_item_get_logical_widths (PangoGlyphItem *glyph_item,
* PangoGlyphItemIter:
*
* A #PangoGlyphItemIter is an iterator over the clusters in a
- * #PangoGlyphItem. The <firstterm>forward direction</firstterm> of the
+ * #PangoGlyphItem. The *forward direction* of the
* iterator is the logical direction of text. That is, with increasing
* @start_index and @start_char values. If @glyph_item is right-to-left
- * (that is, if <literal>@glyph_item->item->analysis.level</literal> is odd),
+ * (that is, if `glyph_item->item->analysis.level` is odd),
* then @start_glyph decreases as the iterator moves forward. Moreover,
* in right-to-left cases, @start_glyph is greater than @end_glyph.
*
@@ -99,21 +99,22 @@ void pango_glyph_item_get_logical_widths (PangoGlyphItem *glyph_item,
* pango_glyph_item_iter_next_cluster() and
* pango_glyph_item_iter_prev_cluster(). A common idiom for doing a
* forward iteration over the clusters is:
- * <programlisting>
+ *
+ * ```
* PangoGlyphItemIter cluster_iter;
* gboolean have_cluster;
*
- * for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter,
+ * for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter,
* glyph_item, text);
* have_cluster;
- * have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter))
+ * have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter))
* {
* ...
* }
- * </programlisting>
+ * ```
*
* Note that @text is the start of the text for layout, which is then
- * indexed by <literal>@glyph_item->item->offset</literal> to get to the
+ * indexed by `glyph_item->item->offset` to get to the
* text of @glyph_item. The @start_index and @end_index values can directly
* index into @text. The @start_glyph, @end_glyph, @start_char, and @end_char
* values however are zero-based for the @glyph_item. For each cluster, the
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.
*
diff --git a/pango/pango-language.c b/pango/pango-language.c
index 04c3e0ca..42279c98 100644
--- a/pango/pango-language.c
+++ b/pango/pango-language.c
@@ -151,13 +151,12 @@ G_DEFINE_BOXED_TYPE (PangoLanguage, pango_language,
*
* Return the Unix-style locale string for the language currently in
* effect. On Unix systems, this is the return value from
- * <literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
- * affect this through the environment variables LC_ALL, LC_CTYPE or
- * LANG (checked in that order). The locale strings typically is in
- * the form lang_COUNTRY, where lang is an ISO-639 language code, and
- * COUNTRY is an ISO-3166 country code. For instance, sv_FI for
- * Swedish as written in Finland or pt_BR for Portuguese as written in
- * Brazil.
+ * `setlocale (LC_CTYPE, NULL)`, and the user can affect this through
+ * the environment variables LC_ALL, LC_CTYPE or LANG (checked
+ * in that order). The locale strings typically is in the form lang_COUNTRY,
+ * where lang is an ISO-639 language code, and COUNTRY is an ISO-3166 country
+ * code. For instance, sv_FI for Swedish as written in Finland or pt_BR for
+ * Portuguese as written in Brazil.
*
* On Windows, the C library doesn't use any such environment
* variables, and setting them won't affect the behavior of functions
@@ -256,7 +255,7 @@ _pango_get_lc_ctype (void)
* Note that this can change over the life of an application.
*
* On Unix systems, this is the return value is derived from
- * <literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
+ * `setlocale (LC_CTYPE, NULL)`, and the user can
* affect this through the environment variables LC_ALL, LC_CTYPE or
* LANG (checked in that order). The locale string typically is in
* the form lang_COUNTRY, where lang is an ISO-639 language code, and
@@ -274,10 +273,10 @@ _pango_get_lc_ctype (void)
* variables, and does return a Unix-style locale string based on
* either said environment variables or the thread's current locale.
*
- * Your application should call <literal>setlocale(LC_ALL, "");</literal>
- * for the user settings to take effect. Gtk+ does this in its initialization
+ * Your application should call `setlocale(LC_ALL, "")` for the user
+ * settings to take effect. GTK does this in its initialization
* functions automatically (by calling gtk_set_locale()).
- * See <literal>man setlocale</literal> for more details.
+ * See the setlocale manpage for more details.
*
* Return value: (transfer none): the default language as a
* #PangoLanguage, must not be freed.
@@ -578,9 +577,10 @@ static const LangInfo lang_texts[] = {
* "The quick brown fox..." is returned. This can be detected by
* comparing the returned pointer value to that returned for (non-existent)
* language code "xx". That is, compare to:
- * <informalexample><programlisting>
+ *
+ * ```
* pango_language_get_sample_string (pango_language_from_string ("xx"))
- * </programlisting></informalexample>
+ * ```
*
* Return value: the sample string. This value is owned by Pango
* and should not be freed.
@@ -870,8 +870,7 @@ pango_language_get_preferred (void)
* representative of that script. This will usually be the
* most widely spoken or used language written in that script:
* for instance, the sample language for %PANGO_SCRIPT_CYRILLIC
- * is <literal>ru</literal> (Russian), the sample language
- * for %PANGO_SCRIPT_ARABIC is <literal>ar</literal>.
+ * is ru (Russian), the sample language for %PANGO_SCRIPT_ARABIC is ar.
*
* For some
* scripts, no sample language will be returned because there
@@ -891,7 +890,7 @@ pango_language_get_preferred (void)
* is tested using pango_language_includes_script(). This can
* be used to control Pango's font selection for non-primary
* languages. For example, a PANGO_LANGUAGE enviroment variable
- * set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
+ * set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
* instead of Arabic (ar) when a segment of Arabic text is found
* in an otherwise non-Arabic text. The same trick can be used to
* choose a default language for %PANGO_SCRIPT_HAN when setting
diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index 97f874ac..c108d477 100644
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -406,9 +406,9 @@ pango_layout_get_width (PangoLayout *layout)
* this value if the layout contains multiple paragraphs of text.
* The default value of -1 means that first line of each paragraph is ellipsized.
* This behavior may be changed in the future to act per layout instead of per
- * paragraph. File a bug against pango at <ulink
- * url="http://bugzilla.gnome.org/";>http://bugzilla.gnome.org/</ulink> if your
- * code relies on this behavior.
+ * paragraph. File a bug against pango at
+ * [https://gitlab.gnome.org/gnome/pango](https://gitlab.gnome.org/gnome/pango)
+ * if your code relies on this behavior.
*
* Height setting only has effect if a positive width is set on
* @layout and ellipsization mode of @layout is not %PANGO_ELLIPSIZE_NONE.
@@ -1242,8 +1242,7 @@ pango_layout_set_markup (PangoLayout *layout,
/**
* pango_layout_set_markup_with_accel:
* @layout: a #PangoLayout
- * @markup: marked-up text
- * (see <link linkend="PangoMarkupFormat">markup format</link>)
+ * @markup: marked-up text (see the Pango Markup docs)
* @length: length of marked-up text in bytes, or -1 if @markup is
* null-terminated
* @accel_marker: marker for accelerators in the text
@@ -1251,8 +1250,7 @@ pango_layout_set_markup (PangoLayout *layout,
* for first located accelerator, or %NULL
*
* Sets the layout text and attribute list from marked-up text (see
- * <link linkend="PangoMarkupFormat">markup format</link>). Replaces
- * the current text and attribute list.
+ * the Pango Markup docs). Replaces the current text and attribute list.
*
* If @accel_marker is nonzero, the given character will mark the
* character following it as an accelerator. For example, @accel_marker
@@ -1569,7 +1567,7 @@ pango_layout_get_lines_readonly (PangoLayout *layout)
* pango_layout_get_line:
* @layout: a #PangoLayout
* @line: the index of a line, which must be between 0 and
- * <literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
+ * `pango_layout_get_line_count(layout) - 1`, inclusive.
*
* Retrieves a particular line from a #PangoLayout.
*
@@ -1611,7 +1609,7 @@ pango_layout_get_line (PangoLayout *layout,
* pango_layout_get_line_readonly:
* @layout: a #PangoLayout
* @line: the index of a line, which must be between 0 and
- * <literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
+ * `pango_layout_get_line_count(layout) - 1`, inclusive.
*
* Retrieves a particular line from a #PangoLayout.
*
@@ -2154,10 +2152,10 @@ pango_layout_xy_to_index (PangoLayout *layout,
*
* Converts from an index within a #PangoLayout to the onscreen position
* corresponding to the grapheme at that index, which is represented
- * as rectangle. Note that <literal>pos->x</literal> is always the leading
- * edge of the grapheme and <literal>pos->x + pos->width</literal> the trailing
+ * as rectangle. Note that `pos->x` is always the leading
+ * edge of the grapheme and `pos->x + pos->width` the trailing
* edge of the grapheme. If the directionality of the grapheme is right-to-left,
- * then <literal>pos->width</literal> will be negative.
+ * then `pos->width` will be negative.
**/
void
pango_layout_index_to_pos (PangoLayout *layout,
@@ -4713,24 +4711,24 @@ pango_layout_line_get_width (PangoLayoutLine *line)
/**
* pango_layout_line_get_x_ranges:
- * @line: a #PangoLayoutLine
+ * @line: a #PangoLayoutLine
* @start_index: Start byte index of the logical range. If this value
- * is less than the start index for the line, then
- * the first range will extend all the way to the leading
- * edge of the layout. Otherwise it will start at the
- * leading edge of the first character.
+ * is less than the start index for the line, then
+ * the first range will extend all the way to the leading
+ * edge of the layout. Otherwise it will start at the
+ * leading edge of the first character.
* @end_index: Ending byte index of the logical range. If this value
- * is greater than the end index for the line, then
- * the last range will extend all the way to the trailing
- * edge of the layout. Otherwise, it will end at the
- * trailing edge of the last character.
+ * is greater than the end index for the line, then
+ * the last range will extend all the way to the trailing
+ * edge of the layout. Otherwise, it will end at the
+ * trailing edge of the last character.
* @ranges: (out) (array length=n_ranges) (transfer full):
- * location to store a pointer to an array of ranges.
- * The array will be of length <literal>2*n_ranges</literal>,
- * with each range starting at <literal>(*ranges)[2*n]</literal>
- * and of width <literal>(*ranges)[2*n + 1] - (*ranges)[2*n]</literal>.
- * This array must be freed with g_free(). The coordinates are relative
- * to the layout and are in Pango units.
+ * location to store a pointer to an array of ranges.
+ * The array will be of length `2*n_ranges`,
+ * with each range starting at `(*ranges)[2*n]`
+ * and of width `(*ranges)[2*n + 1] - (*ranges)[2*n]`.
+ * This array must be freed with g_free(). The coordinates
+ * are relative to the layout and are in Pango units.
* @n_ranges: The number of ranges stored in @ranges.
*
* Gets a list of visual ranges corresponding to a given logical range.
diff --git a/pango/pango-markup.c b/pango/pango-markup.c
index b74c1ad4..b3afcef5 100644
--- a/pango/pango-markup.c
+++ b/pango/pango-markup.c
@@ -51,9 +51,9 @@
* pango_markup_parser_new().
*
* A simple example of a marked-up string might be:
- * |[
+ * ```
* <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!
- * ]|
+ * ```
*
* Pango uses #GMarkup to parse this language, which means that XML
* features such as numeric character entities such as `©` for
@@ -800,7 +800,7 @@ pango_markup_parser_new_internal (char accel_marker,
/**
* pango_parse_markup:
- * @markup_text: markup to parse (see <link linkend="PangoMarkupFormat">markup format</link>)
+ * @markup_text: markup to parse (see the Pango Markup docs)
* @length: length of @markup_text, or -1 if nul-terminated
* @accel_marker: character that precedes an accelerator, or 0 for none
* @attr_list: (out) (allow-none): address of return location for a #PangoAttrList, or %NULL
@@ -808,8 +808,7 @@ pango_markup_parser_new_internal (char accel_marker,
* @accel_char: (out) (allow-none): address of return location for accelerator char, or %NULL
* @error: address of return location for errors, or %NULL
*
- * Parses marked-up text (see
- * <link linkend="PangoMarkupFormat">markup format</link>) to create
+ * Parses marked-up text (see the Pango Markup docs) to create
* a plain-text string and an attribute list.
*
* If @accel_marker is nonzero, the given character will mark the
@@ -882,8 +881,7 @@ pango_parse_markup (const char *markup_text,
* pango_markup_parser_new:
* @accel_marker: character that precedes an accelerator, or 0 for none
*
- * Parses marked-up text (see
- * <link linkend="PangoMarkupFormat">markup format</link>) to create
+ * Parses marked-up text (see the Pango Markp docs) to create
* a plain-text string and an attribute list.
*
* If @accel_marker is nonzero, the given character will mark the
diff --git a/pango/pango-matrix.c b/pango/pango-matrix.c
index 50f8be1a..787e2f60 100644
--- a/pango/pango-matrix.c
+++ b/pango/pango-matrix.c
@@ -273,10 +273,10 @@ pango_matrix_get_font_scale_factors (const PangoMatrix *matrix,
* components of the transformation are ignored. The calculation of
* the returned vector is as follows:
*
- * <programlisting>
+ * ```
* dx2 = dx1 * xx + dy1 * xy;
* dy2 = dx1 * yx + dy1 * yy;
- * </programlisting>
+ * ```
*
* Affine transformations are position invariant, so the same vector
* always transforms to the same vector. If (@x1,@y1) transforms
diff --git a/pango/pango-matrix.h b/pango/pango-matrix.h
index 9ec37042..9dfadee9 100644
--- a/pango/pango-matrix.h
+++ b/pango/pango-matrix.h
@@ -42,10 +42,10 @@ typedef struct _PangoMatrix PangoMatrix;
* coordinates and device coordinates. The transformation
* is given by
*
- * <programlisting>
+ * ```
* x_device = x_user * matrix->xx + y_user * matrix->xy + matrix->x0;
* y_device = x_user * matrix->yx + y_user * matrix->yy + matrix->y0;
- * </programlisting>
+ * ```
*
* Since: 1.6
**/
@@ -72,10 +72,10 @@ struct _PangoMatrix
* Constant that can be used to initialize a PangoMatrix to
* the identity transform.
*
- * <informalexample><programlisting>
+ * ```
* PangoMatrix matrix = PANGO_MATRIX_INIT;
- * pango_matrix_rotate (&matrix, 45.);
- * </programlisting></informalexample>
+ * pango_matrix_rotate (&matrix, 45.);
+ * ```
*
* Since: 1.6
**/
diff --git a/pango/pango-ot-info.c b/pango/pango-ot-info.c
index 2b1b61f4..0d75cf25 100644
--- a/pango/pango-ot-info.c
+++ b/pango/pango-ot-info.c
@@ -76,7 +76,7 @@ pango_ot_info_finalizer (void *object)
/**
* pango_ot_info_get:
- * @face: a <type>FT_Face</type>.
+ * @face: a FT_Face
*
* Returns the #PangoOTInfo structure for the given FreeType font face.
*
diff --git a/pango/pango-ot-private.h b/pango/pango-ot-private.h
index d9d86644..7ba44c6a 100644
--- a/pango/pango-ot-private.h
+++ b/pango/pango-ot-private.h
@@ -40,7 +40,7 @@ typedef struct _PangoOTInfoClass PangoOTInfoClass;
*
* The #PangoOTInfo struct contains the various
* tables associated with an OpenType font. It contains only private fields and
- * should only be accessed via the <function>pango_ot_info_*</function> functions
+ * should only be accessed via the pango_ot_info_… functions
* which are documented below. To obtain a #PangoOTInfo,
* use pango_ot_info_get().
*/
@@ -76,7 +76,7 @@ struct _PangoOTRulesetClass
* The #PangoOTBuffer structure is used to store strings of glyphs associated
* with a #PangoFcFont, suitable for OpenType layout processing. It contains
* only private fields and should only be accessed via the
- * <function>pango_ot_buffer_*</function> functions which are documented below.
+ * pango_ot_buffer_… functions which are documented below.
* To obtain a #PangoOTBuffer, use pango_ot_buffer_new().
*/
struct _PangoOTBuffer
diff --git a/pango/pango-ot-ruleset.c b/pango/pango-ot-ruleset.c
index 9df8faef..9cf4cfb0 100644
--- a/pango/pango-ot-ruleset.c
+++ b/pango/pango-ot-ruleset.c
@@ -120,29 +120,23 @@ pango_ot_ruleset_new (PangoOTInfo *info)
* script, language, or feature indices manually.
*
* In excess to what pango_ot_ruleset_new() does, this function will:
- * <itemizedlist>
- * <listitem>
- * Find the #PangoOTTag script and language tags associated with
+ *
+ * * Find the #PangoOTTag script and language tags associated with
* @script and @language using pango_ot_tag_from_script() and
* pango_ot_tag_from_language(),
- * </listitem>
- * <listitem>
- * For each of table types %PANGO_OT_TABLE_GSUB and %PANGO_OT_TABLE_GPOS,
+ *
+ * * For each of table types %PANGO_OT_TABLE_GSUB and %PANGO_OT_TABLE_GPOS,
* find the script index of the script tag found and the language
* system index of the language tag found in that script system, using
* pango_ot_info_find_script() and pango_ot_info_find_language(),
- * </listitem>
- * <listitem>
- * For found language-systems, if they have required feature
+ *
+ * * For found language-systems, if they have required feature
* index, add that feature to the ruleset using
* pango_ot_ruleset_add_feature(),
- * </listitem>
- * <listitem>
- * Remember found script and language indices for both table types,
+ *
+ * * Remember found script and language indices for both table types,
* and use them in future pango_ot_ruleset_maybe_add_feature() and
* pango_ot_ruleset_maybe_add_features().
- * </listitem>
- * </itemizedlist>
*
* Because of the way return values of pango_ot_info_find_script() and
* pango_ot_info_find_language() are ignored, this function automatically
diff --git a/pango/pango-ot.h b/pango/pango-ot.h
index b8c6acc8..6390538b 100644
--- a/pango/pango-ot.h
+++ b/pango/pango-ot.h
@@ -42,7 +42,7 @@ G_BEGIN_DECLS
*
* The #PangoOTTag typedef is used to represent TrueType and OpenType
* four letter tags inside Pango. Use PANGO_OT_TAG_MAKE()
- * or PANGO_OT_TAG_MAKE_FROM_STRING() macros to create <type>PangoOTTag</type>s manually.
+ * or PANGO_OT_TAG_MAKE_FROM_STRING() macros to create PangoOTTags manually.
*/
typedef guint32 PangoOTTag;
@@ -54,7 +54,7 @@ typedef guint32 PangoOTTag;
* @c4: Fourth character.
*
* Creates a #PangoOTTag from four characters. This is similar and
- * compatible with the <function>FT_MAKE_TAG()</function> macro from FreeType.
+ * compatible with the FT_MAKE_TAG() macro from FreeType.
*/
/**
* PANGO_OT_TAG_MAKE_FROM_STRING:
@@ -84,9 +84,9 @@ typedef struct _PangoOTRulesetDescription PangoOTRulesetDescription;
* @PANGO_OT_TABLE_GSUB: The GSUB table.
* @PANGO_OT_TABLE_GPOS: The GPOS table.
*
- * The <type>PangoOTTableType</type> enumeration values are used to
+ * The PangoOTTableType enumeration values are used to
* identify the various OpenType tables in the
- * <function>pango_ot_info_*</function> functions.
+ * pango_ot_info_… functions.
*/
typedef enum
{
diff --git a/pango/pango-renderer.c b/pango/pango-renderer.c
index 432875a4..869a6cff 100644
--- a/pango/pango-renderer.c
+++ b/pango/pango-renderer.c
@@ -806,7 +806,7 @@ pango_renderer_default_draw_glyphs (PangoRenderer *renderer,
* output format supports it (PDF for example).
*
* Note that @text is the start of the text for layout, which is then
- * indexed by <literal>@glyph_item->item->offset</literal>.
+ * indexed by `glyph_item->item->offset`.
*
* If @text is %NULL, this simply calls pango_renderer_draw_glyphs().
*
@@ -1394,9 +1394,9 @@ pango_renderer_get_alpha (PangoRenderer *renderer,
* instance, if a subclass of #PangoRenderer was to add a stipple
* option for drawing underlines, it needs to call
*
- * <informalexample><programlisting>
+ * ```
* pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
- * </programlisting></informalexample>
+ * ```
*
* When the stipple changes or underlines with different stipples
* might be joined together. Pango automatically calls this for
diff --git a/pango/pango-script.c b/pango/pango-script.c
index fc95309f..3ea42a89 100644
--- a/pango/pango-script.c
+++ b/pango/pango-script.c
@@ -59,8 +59,8 @@
* @title:Scripts and Languages
*
* The functions in this section are used to identify the writing
- * system, or <firstterm>script</firstterm> of individual characters
- * and of ranges within a larger text string.
+ * system, or *script* of individual characters and of ranges within
+ * a larger text string.
*/
#include "config.h"
#include <stdlib.h>
diff --git a/pango/pango-script.h b/pango/pango-script.h
index a7ec3246..66cca15a 100644
--- a/pango/pango-script.h
+++ b/pango/pango-script.h
@@ -156,16 +156,15 @@ typedef struct _PangoScriptIter PangoScriptIter;
* @PANGO_SCRIPT_OLD_HUNGARIAN: Old Hungarian. Since: 1.40
* @PANGO_SCRIPT_SIGNWRITING: Signwriting. Since: 1.40
*
- * The #PangoScript enumeration identifies different writing
+ * The `PangoScript` enumeration identifies different writing
* systems. The values correspond to the names as defined in the
- * Unicode standard. See <ulink
- * url="http://www.unicode.org/reports/tr24/";>Unicode Standard Annex
- * #24: Script names</ulink>.
+ * Unicode standard. See
+ * [Unicode Standard Annex 24: Script names](http://www.unicode.org/reports/tr24/)
*
* Note that this enumeration is deprecated and will not be updated
* to include values in newer versions of the Unicode standard.
- * Applications should use the GUnicodeScript enumeration instead,
- * whose values are interchangeable with PangoScript.
+ * Applications should use the `GUnicodeScript` enumeration instead,
+ * whose values are interchangeable with `PangoScript`.
*/
typedef enum { /* ISO 15924 code */
PANGO_SCRIPT_INVALID_CODE = -1,
diff --git a/pango/pango-tabs.c b/pango/pango-tabs.c
index 56a34468..b4d13df4 100644
--- a/pango/pango-tabs.c
+++ b/pango/pango-tabs.c
@@ -119,10 +119,9 @@ pango_tab_array_new (gint initial_size,
* @first_position: position of first tab stop
* @...: additional alignment/position pairs
*
- * This is a convenience function that creates a #PangoTabArray
- * and allows you to specify the alignment and position of each
- * tab stop. You <emphasis>must</emphasis> provide an alignment
- * and position for @size tab stops.
+ * This is a convenience function that creates a #PangoTabArray and allows
+ * you to specify the alignment and position of each tab stop. You **must**
+ * provide an alignment and position for @size tab stops.
*
* Return value: the newly allocated #PangoTabArray, which should
* be freed with pango_tab_array_free().
diff --git a/pango/pango-types.h b/pango/pango-types.h
index 4662c71e..28151196 100644
--- a/pango/pango-types.h
+++ b/pango/pango-types.h
@@ -149,7 +149,7 @@ struct _PangoRectangle
* PANGO_ASCENT:
* @rect: a #PangoRectangle
*
- * Extracts the <firstterm>ascent</firstterm> from a #PangoRectangle
+ * Extracts the *ascent* from a #PangoRectangle
* representing glyph extents. The ascent is the distance from the
* baseline to the highest point of the character. This is positive if the
* glyph ascends above the baseline.
@@ -158,7 +158,7 @@ struct _PangoRectangle
* PANGO_DESCENT:
* @rect: a #PangoRectangle
*
- * Extracts the <firstterm>descent</firstterm> from a #PangoRectangle
+ * Extracts the *descent* from a #PangoRectangle
* representing glyph extents. The descent is the distance from the
* baseline to the lowest point of the character. This is positive if the
* glyph descends below the baseline.
@@ -167,7 +167,7 @@ struct _PangoRectangle
* PANGO_LBEARING:
* @rect: a #PangoRectangle
*
- * Extracts the <firstterm>left bearing</firstterm> from a #PangoRectangle
+ * Extracts the *left bearing* from a #PangoRectangle
* representing glyph extents. The left bearing is the distance from the
* horizontal origin to the farthest left point of the character.
* This is positive for characters drawn completely to the right of the
@@ -177,7 +177,7 @@ struct _PangoRectangle
* PANGO_RBEARING:
* @rect: a #PangoRectangle
*
- * Extracts the <firstterm>right bearing</firstterm> from a #PangoRectangle
+ * Extracts the *right bearing* from a #PangoRectangle
* representing glyph extents. The right bearing is the distance from the
* horizontal origin to the farthest right point of the character.
* This is positive except for characters drawn completely to the left of the
diff --git a/pango/pango-utils.c b/pango/pango-utils.c
index 6f48c62c..abc1c112 100644
--- a/pango/pango-utils.c
+++ b/pango/pango-utils.c
@@ -25,7 +25,7 @@
* @title:Version Checking
*
* The capital-letter macros defined here can be used to check the version of Pango
- * at compile-time, and to <firstterm>encode</firstterm> Pango versions into integers.
+ * at compile-time, and to *encode* Pango versions into integers.
*
* The functions can be used to check the version of the linked Pango library at run-time.
*/
@@ -905,7 +905,7 @@ pango_find_base_dir (const gchar *text,
*
* Checks @ch to see if it is a character that should not be
* normally rendered on the screen. This includes all Unicode characters
- * with "ZERO WIDTH" in their name, as well as <firstterm>bidi</firstterm> formatting characters, and
+ * with "ZERO WIDTH" in their name, as well as *bidi* formatting characters, and
* a few other ones. This is totally different from g_unichar_iszerowidth()
* and is at best misnamed.
*
diff --git a/pango/pangocairo-render.c b/pango/pangocairo-render.c
index 614a3a44..75a7a0f7 100644
--- a/pango/pangocairo-render.c
+++ b/pango/pangocairo-render.c
@@ -24,7 +24,7 @@
* @short_description:Font handling and rendering with Cairo
* @title:Cairo Fonts and Rendering
*
- * The <ulink url="http://cairographics.org";>Cairo library</ulink> is a
+ * The Cairo library is a
* vector graphics library with a powerful rendering model. It has such
* features as anti-aliased primitives, alpha-compositing, and
* gradients. Multiple backends for Cairo are available, to allow
@@ -69,11 +69,10 @@
* PangoFontDescription *desc;
* int i;
*
- * /* Center coordinates on the middle of the region we are drawing
- * */
+ * // Center coordinates on the middle of the region we are drawing
* cairo_translate (cr, RADIUS, RADIUS);
*
- * /* Create a PangoLayout, set the font and text */
+ * // Create a PangoLayout, set the font and text
* layout = pango_cairo_create_layout (cr);
*
* pango_layout_set_text (layout, "Text", -1);
@@ -81,8 +80,8 @@
* pango_layout_set_font_description (layout, desc);
* pango_font_description_free (desc);
*
- * /* Draw the layout N_WORDS times in a circle */
- * for (i = 0; i < N_WORDS; i++)
+ * // Draw the layout N_WORDS times in a circle
+ * for (i = 0; i < N_WORDS; i++)
* {
* int width, height;
* double angle = (360. * i) / N_WORDS;
@@ -90,23 +89,23 @@
*
* cairo_save (cr);
*
- * /* Gradient from red at angle == 60 to blue at angle == 240 */
+ * // Gradient from red at angle == 60 to blue at angle == 240
* red = (1 + cos ((angle - 60) * G_PI / 180.)) / 2;
* cairo_set_source_rgb (cr, red, 0, 1.0 - red);
*
* cairo_rotate (cr, angle * G_PI / 180.);
*
- * /* Inform Pango to re-layout the text with the new transformation */
+ * // Inform Pango to re-layout the text with the new transformation
* pango_cairo_update_layout (cr, layout);
*
- * pango_layout_get_size (layout, &width, &height);
+ * pango_layout_get_size (layout, &width, &height);
* cairo_move_to (cr, - ((double)width / PANGO_SCALE) / 2, - RADIUS);
* pango_cairo_show_layout (cr, layout);
*
* cairo_restore (cr);
* }
*
- * /* free the layout object */
+ * // free the layout object
* g_object_unref (layout);
* }
*
@@ -1210,7 +1209,7 @@ pango_cairo_show_glyph_string (cairo_t *cr,
* be drawn at the current point of the cairo context.
*
* Note that @text is the start of the text for layout, which is then
- * indexed by <literal>@glyph_item->item->offset</literal>.
+ * indexed by `glyph_item->item->offset`.
*
* Since: 1.22
**/
diff --git a/pango/pangofc-font.c b/pango/pangofc-font.c
index cf6b427f..d4488531 100644
--- a/pango/pangofc-font.c
+++ b/pango/pangofc-font.c
@@ -23,18 +23,13 @@
* SECTION:pangofc-font
* @short_description:Base font class for Fontconfig-based backends
* @title:PangoFcFont
- * @see_also:
- * <variablelist><varlistentry><term>#PangoFcFontMap</term> <listitem>The base class for font maps; creating
a new
- * Fontconfig-based backend involves deriving from both
- * #PangoFcFontMap and #PangoFcFont.</listitem></varlistentry></variablelist>
+ * @see_also: #PangoFcFontMap
*
* #PangoFcFont is a base class for font implementation using the
- * Fontconfig and FreeType libraries. It is used in the
- * <link linkend="pango-Xft-Fonts-and-Rendering">Xft</link> and
- * <link linkend="pango-FreeType-Fonts-and-Rendering">FreeType</link>
- * backends shipped with Pango, but can also be used when creating
- * new backends. Any backend deriving from this base class will
- * take advantage of the wide range of shapers implemented using
+ * Fontconfig and FreeType libraries. It is used in the Xft and
+ * FreeType backends shipped with Pango, but can also be used when
+ * creating new backends. Any backend deriving from this base class
+ * will take advantage of the wide range of shapers implemented using
* FreeType that come with Pango.
*/
#include "config.h"
diff --git a/pango/pangofc-fontmap.c b/pango/pangofc-fontmap.c
index fd17309d..25157dfe 100644
--- a/pango/pangofc-fontmap.c
+++ b/pango/pangofc-fontmap.c
@@ -23,18 +23,10 @@
* SECTION:pangofc-fontmap
* @short_description:Base fontmap class for Fontconfig-based backends
* @title:PangoFcFontMap
- * @see_also:
- * <variablelist><varlistentry>
- * <term>#PangoFcFont</term>
- * <listitem>The base class for fonts; creating a new
- * Fontconfig-based backend involves deriving from both
- * #PangoFcFontMap and #PangoFcFont.</listitem>
- * </varlistentry></variablelist>
+ * @see_also: #PangoFcFont
*
* PangoFcFontMap is a base class for font map implementations using the
- * Fontconfig and FreeType libraries. It is used in the
- * <link linkend="pango-Xft-Fonts-and-Rendering">Xft</link> and
- * <link linkend="pango-FreeType-Fonts-and-Rendering">FreeType</link>
+ * Fontconfig and FreeType libraries. It is used in the Xft and FreeType
* backends shipped with Pango, but can also be used when creating
* new backends. Any backend deriving from this base class will
* take advantage of the wide range of shapers implemented using
diff --git a/pango/pangoft2-render.c b/pango/pangoft2-render.c
index 6d299392..ab4dd5d0 100644
--- a/pango/pangoft2-render.c
+++ b/pango/pangoft2-render.c
@@ -589,7 +589,7 @@ pango_ft2_renderer_draw_trapezoid (PangoRenderer *renderer,
/**
* pango_ft2_render_layout_subpixel:
- * @bitmap: a <type>FT_Bitmap</type> to render the layout onto
+ * @bitmap: a FT_Bitmap to render the layout onto
* @layout: a #PangoLayout
* @x: the X position of the left of the layout (in Pango units)
* @y: the Y position of the top of the layout (in Pango units)
@@ -626,7 +626,7 @@ pango_ft2_render_layout_subpixel (FT_Bitmap *bitmap,
/**
* pango_ft2_render_layout:
- * @bitmap: a <type>FT_Bitmap</type> to render the layout onto
+ * @bitmap: a FT_Bitmap to render the layout onto
* @layout: a #PangoLayout
* @x: the X position of the left of the layout (in pixels)
* @y: the Y position of the top of the layout (in pixels)
@@ -644,7 +644,7 @@ pango_ft2_render_layout (FT_Bitmap *bitmap,
/**
* pango_ft2_render_layout_line_subpixel:
- * @bitmap: a <type>FT_Bitmap</type> to render the line onto
+ * @bitmap: a FT_Bitmap to render the line onto
* @line: a #PangoLayoutLine
* @x: the x position of start of string (in Pango units)
* @y: the y position of baseline (in Pango units)
@@ -681,7 +681,7 @@ pango_ft2_render_layout_line_subpixel (FT_Bitmap *bitmap,
/**
* pango_ft2_render_layout_line:
- * @bitmap: a <type>FT_Bitmap</type> to render the line onto
+ * @bitmap: a FT_Bitmap to render the line onto
* @line: a #PangoLayoutLine
* @x: the x position of start of string (in pixels)
* @y: the y position of baseline (in pixels)
diff --git a/pango/pangoft2.h b/pango/pangoft2.h
index 96228316..239eb05e 100644
--- a/pango/pangoft2.h
+++ b/pango/pangoft2.h
@@ -62,7 +62,7 @@ typedef struct _PangoFT2FontMap PangoFT2FontMap;
/**
* PangoFT2SubstituteFunc:
- * @pattern: the <type>FcPattern</type> to tweak.
+ * @pattern: the FcPattern to tweak.
* @data: user data.
*
* Function type for doing final config tweaking on prepared FcPatterns.
diff --git a/pango/pangowin32-fontmap.c b/pango/pangowin32-fontmap.c
index 6bc10a7a..f69ce1f9 100644
--- a/pango/pangowin32-fontmap.c
+++ b/pango/pangowin32-fontmap.c
@@ -816,7 +816,7 @@ _pango_win32_font_map_class_init (PangoWin32FontMapClass *class)
/**
* pango_win32_font_map_for_display:
*
- * Returns a <type>PangoWin32FontMap</type>. Font maps are cached and should
+ * Returns a PangoWin32FontMap. Font maps are cached and should
* not be freed. If the font map is no longer needed, it can
* be released with pango_win32_shutdown_display().
*
@@ -1800,7 +1800,7 @@ pango_win32_face_list_sizes (PangoFontFace *face,
/**
* pango_win32_font_map_get_font_cache:
- * @font_map: a <type>PangoWin32FontMap</type>.
+ * @font_map: a PangoWin32FontMap
*
* Obtains the font cache associated with the given font map.
*
diff --git a/pango/pangoxft-render.c b/pango/pangoxft-render.c
index 2e862dd5..a2584f3c 100644
--- a/pango/pangoxft-render.c
+++ b/pango/pangoxft-render.c
@@ -828,14 +828,14 @@ pango_xft_render_transformed (XftDraw *draw,
/**
* pango_xft_render:
- * @draw: the <type>XftDraw</type> object.
+ * @draw: the XftDraw object.
* @color: the color in which to draw the string
* @font: the font in which to draw the string
* @glyphs: the glyph string to draw
* @x: the x position of start of string (in pixels)
* @y: the y position of baseline (in pixels)
*
- * Renders a #PangoGlyphString onto an <type>XftDraw</type> object wrapping an X drawable.
+ * Renders a #PangoGlyphString onto an XftDraw object wrapping an X drawable.
*/
void
pango_xft_render (XftDraw *draw,
@@ -864,7 +864,7 @@ pango_xft_render (XftDraw *draw,
* @x: the x position of start of string (in pixels)
* @y: the y position of baseline (in pixels)
*
- * Renders a #PangoGlyphString onto an Xrender <type>Picture</type> object.
+ * Renders a #PangoGlyphString onto an Xrender Picture object.
*/
void
pango_xft_picture_render (Display *display,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
