Skip to content
GitLab
Commit 7f04ed92 authored by Matthias Clasen's avatar Matthias Clasen
Browse files

docs: Convert gtk-doc syntax leftovers 

Remove leftovers like #Type, reduce indentations
to avoid markdown block quotes, etc.
parent 75eee838
Pipeline #284440 passed with stages
in 8 minutes and 59 seconds
Expand all Hide whitespace changes
Inline Side-by-side
CODING_STYLE.md
View file @ 7f04ed92
......@@ -49,19 +49,19 @@ in the gtk-doc / gnome-doc style. For instance:
/**
* pango_layout_get_line:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @line: the index of a line, which must be between 0 and
* pango_layout_get_line_count(layout) - 1, inclusive.
* `pango_layout_get_line_count(layout) - 1`, inclusive.
*
* Retrieves a particular line from a #PangoLayout (or @layout.)
* Retrieves a particular line from a `PangoLayout` (or @layout.)
*
* Return value: the requested #PangoLayoutLine, or %NULL if the
* index is out of range. This layout line can
* be ref'ed and retained, but will become invalid
* if changes are made to the #PangoLayout.
* Return value: the requested `PangoLayoutLine`, or %NULL
* if the index is out of range. This layout line can
* be ref'ed and retained, but will become invalid
* if changes are made to the `PangoLayout`.
*
* Since: 1.6
**/
*/
PangoLayoutLine *
pango_layout_get_line (PangoLayout *layout,
int line)
......
pango/break.c
View file @ 7f04ed92
......@@ -143,17 +143,18 @@ typedef enum
* pango_default_break:
* @text: text to break. Must be valid UTF-8
* @length: length of text in bytes (may be -1 if @text is nul-terminated)
* @analysis: (nullable): a #PangoAnalysis for the @text
* @analysis: (nullable): a `PangoAnalysis` structure for the @text
* @attrs: logical attributes to fill in
* @attrs_len: size of the array passed as @attrs
*
* This is the default break algorithm.
*
* It applies Unicode rules without language-specific tailoring, therefore
* the @analyis argument is unused and can be %NULL.
* It applies Unicode rules without language-specific
* tailoring, therefore the @analyis argument is unused
* and can be %NULL.
*
* See pango_tailor_break() for language-specific breaks.
**/
* See [func@Pango.tailor_break] for language-specific breaks.
*/
void
pango_default_break (const gchar *text,
gint length,
......@@ -1617,19 +1618,20 @@ tailor_break (const char *text,
/**
* pango_break:
* @text: the text to process. Must be valid UTF-8
* @length: length of @text in bytes (may be -1 if @text is nul-terminated)
* @analysis: #PangoAnalysis structure from pango_itemize()
* @attrs: (array length=attrs_len): an array to store character
* information in
* @text: the text to process. Must be valid UTF-8
* @length: length of @text in bytes (may be -1 if @text is nul-terminated)
* @analysis: `PangoAnalysis` structure for @text
* @attrs: (array length=attrs_len): an array to store character information in
* @attrs_len: size of the array passed as @attrs
*
* Determines possible line, word, and character breaks for a string of
* Unicode text with a single analysis.
* Determines possible line, word, and character breaks
* for a string of Unicode text with a single analysis.
*
* For most purposes you may want to use pango_get_log_attrs().
* For most purposes you may want to use
* [func@Pango.get_log_attrs].
*
* Deprecated: 1.44: Use pango_default_break() and pango_tailor_break()
* Deprecated: 1.44: Use [func@Pango.default_break] and
* [func@Pango.tailor_break]
*/
void
pango_break (const gchar *text,
......@@ -1656,15 +1658,18 @@ pango_break (const gchar *text,
*
* Locates a paragraph boundary in @text.
*
* A boundary is caused by delimiter characters, such as a newline, carriage
* return, carriage return-newline pair, or Unicode paragraph separator character.
* The index of the run of delimiters is returned in @paragraph_delimiter_index.
* The index of the start of the paragrap (index after all delimiters) is stored
* A boundary is caused by delimiter characters, such as
* a newline, carriage return, carriage return-newline pair,
* or Unicode paragraph separator character.
*
* The index of the run of delimiters is returned in
* @paragraph_delimiter_index. The index of the start
* of the paragrap (index after all delimiters) is stored
* in @next_paragraph_start.
*
* If no delimiters are found, both @paragraph_delimiter_index and
* @next_paragraph_start are filled with the length of @text (an index one
* off the end).
* If no delimiters are found, both @paragraph_delimiter_index
* and @next_paragraph_start are filled with the length of @text
* (an index one off the end).
*/
void
pango_find_paragraph_boundary (const gchar *text,
......@@ -1750,16 +1755,18 @@ pango_find_paragraph_boundary (const gchar *text,
* pango_tailor_break:
* @text: text to process. Must be valid UTF-8
* @length: length in bytes of @text
* @analysis: `PangoAnalysis` structure from [func@itemize] for @text
* @analysis: `PangoAnalysis` for @text
* @offset: Byte offset of @text from the beginning of the
* paragraph, or -1 to ignore attributes from @analysis
* paragraph, or -1 to ignore attributes from @analysis
* @log_attrs: (array length=log_attrs_len): array with one `PangoLogAttr`
* per character in @text, plus one extra, to be filled in
* @log_attrs_len: length of @log_attrs array
*
* Apply language-specific tailoring to the breaks in @log_attrs.
* Apply language-specific tailoring to the breaks
* in @log_attrs.
*
* The line breaks are assumed to have been produced by [func@default_break].
* The line breaks are assumed to have been produced
* by [func@Pango.default_break].
*
* If @offset is not -1, it is used to apply attributes
* from @analysis that are relevant to line breaking.
......@@ -1825,11 +1832,13 @@ tailor_segment (const char *range_start,
*
* Computes a `PangoLogAttr` for each character in @text.
*
* The @log_attrs array must have one `PangoLogAttr` for each position in @text;
* if @text contains N characters, it has N+1 positions, including the last
* position at the end of the text. @text should be an entire paragraph; logical
* attributes can't be computed without context (for example you need to see
* spaces on either side of a word to know the word is a word).
* The @log_attrs array must have one `PangoLogAttr` for
* each position in @text; if @text contains N characters,
* it has N+1 positions, including the last position at the
* end of the text. @text should be an entire paragraph;
* logical attributes can't be computed without context
* (for example you need to see spaces on either side of
* a word to know the word is a word).
*/
void
pango_get_log_attrs (const char *text,
......
pango/ellipsize.c
View file @ 7f04ed92
......@@ -243,7 +243,7 @@ line_iter_prev_cluster (EllipsizeState *state,
* - Starts a grapheme - checked here
*
* In the future we'd also like to add a check for cursive connectivity here.
* This should be an addition to #PangoGlyphVisAttr
* This should be an addition to `PangoGlyphVisAttr`
*
*/
......@@ -735,11 +735,11 @@ current_width (EllipsizeState *state)
/**
* _pango_layout_line_ellipsize:
* @line: a #PangoLayoutLine
* @line: a `PangoLayoutLine`
* @attrs: Attributes being used for itemization/shaping
* @shape_flags: Flags to use when shaping
*
* Given a #PangoLayoutLine with the runs still in logical order, ellipsize
* Given a `PangoLayoutLine` with the runs still in logical order, ellipsize
* it according the layout's policy to fit within the set width of the layout.
*
* Return value: whether the line had to be ellipsized
......
pango/fonts.c
View file @ 7f04ed92
......@@ -183,7 +183,7 @@ pango_font_description_get_family (const PangoFontDescription *desc)
*
* The [enum@Pango.Style] enumeration describes whether the font is
* slanted and the manner in which it is slanted; it can be either
* #PANGO_STYLE_NORMAL, #PANGO_STYLE_ITALIC, or #PANGO_STYLE_OBLIQUE.
* %PANGO_STYLE_NORMAL, %PANGO_STYLE_ITALIC, or %PANGO_STYLE_OBLIQUE.
*
* Most fonts will either have a italic style or an oblique style,
* but not both, and font matching in Pango will match italic
......@@ -1803,10 +1803,8 @@ pango_font_find_shaper (PangoFont *font,
* pango_font_get_glyph_extents:
* @font: (nullable): a `PangoFont`
* @glyph: the glyph index
* @ink_rect: (out) (optional): rectangle used to store the extents of the glyph
* as drawn or %NULL to indicate that the result is not needed.
* @logical_rect: (out) (optional): rectangle used to store the logical extents of
* the glyph or %NULL to indicate that the result is not needed.
* @ink_rect: (out) (optional): rectangle used to store the extents of the glyph as drawn
* @logical_rect: (out) (optional): rectangle used to store the logical extents of the glyph
*
* Gets the logical and ink extents of a glyph within a font.
*
......@@ -1893,21 +1891,22 @@ pango_font_get_metrics (PangoFont *font,
/**
* pango_font_get_font_map:
* @font: (nullable): a `PangoFont`, or %NULL
* @font: (nullable): a `PangoFont`
*
* Gets the font map for which the font was created.
*
* 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.
* 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.
*
* It is the responsibility of the user to ensure that the font map is kept
* alive. In most uses this is not an issue as a #PangoContext holds
* a reference to the font map.
* It is the responsibility of the user to ensure that the
* font map is kept alive. In most uses this is not an issue
* as a `PangoContext` holds a reference to the font map.
*
* Return value: (transfer none) (nullable): the `PangoFontMap` for the
* font, or %NULL if @font is %NULL.
* Return value: (transfer none) (nullable): the `PangoFontMap`
* for the font
*
* Since: 1.10
*/
......@@ -1947,11 +1946,12 @@ pango_font_get_face (PangoFont *font)
*
* Get a `hb_font_t` object backing this font.
*
* Note that the objects returned by this function are cached and immutable.
* If you need to make changes to the `hb_font_t`, use hb_font_create_sub_font().
* Note that the objects returned by this function are cached
* and immutable. If you need to make changes to the `hb_font_t`,
* use hb_font_create_sub_font().
*
* Returns: (transfer none) (nullable): the `hb_font_t` object backing the
* font, or %NULL if the font does not have one
* Returns: (transfer none) (nullable): the `hb_font_t` object
* backing the font
*
* Since: 1.44
*/
......@@ -2369,13 +2369,13 @@ pango_font_family_real_get_face (PangoFontFamily *family,
* pango_font_family_get_face:
* @family: a `PangoFontFamily`
* @name: (nullable): the name of a face. If the name is %NULL,
* the family's default face (fontconfig calls it "Regular")
* will be returned.
* the family's default face (fontconfig calls it "Regular")
* will be returned.
*
* Gets the `PangoFontFace` of @family with the given name.
*
* Returns: (transfer none) (nullable): the `PangoFontFace`,
* or %NULL if no face with the given name exists.
* or %NULL if no face with the given name exists.
*
* Since: 1.46
*/
......@@ -2526,8 +2526,8 @@ pango_font_face_get_face_name (PangoFontFace *face)
* pango_font_face_list_sizes:
* @face: a `PangoFontFace`.
* @sizes: (out) (array length=n_sizes) (nullable) (optional):
* location to store a pointer to an array of int. This array
* should be freed with g_free().
* location to store a pointer to an array of int. This array
* should be freed with g_free().
* @n_sizes: location to store the number of elements in @sizes
*
* List the available sizes for a font.
......
pango/glyphstring.c
View file @ 7f04ed92
......@@ -31,7 +31,7 @@
* Create a new `PangoGlyphString`.
*
* Return value: the newly allocated `PangoGlyphString`, which
* should be freed with [method@Pango.GlyphString.free].
* should be freed with [method@Pango.GlyphString.free].
*/
PangoGlyphString *
pango_glyph_string_new (void)
......@@ -48,8 +48,8 @@ pango_glyph_string_new (void)
/**
* pango_glyph_string_set_size:
* @string: a `PangoGlyphString`.
* @new_len: the new length of the string.
* @string: a `PangoGlyphString`.
* @new_len: the new length of the string
*
* Resize a glyph string to the given length.
*/
......@@ -97,13 +97,13 @@ G_DEFINE_BOXED_TYPE (PangoGlyphString, pango_glyph_string,
/**
* pango_glyph_string_copy:
* @string: (nullable): a `PangoGlyphString`, may be %NULL
* @string: (nullable): a `PangoGlyphString`
*
* Copy a glyph string and associated storage.
*
* Return value: (nullable): the newly allocated `PangoGlyphString`,
* which should be freed with [method@Pango.GlyphString.free],
* or %NULL if @string was %NULL.
* Return value: (nullable): the newly allocated `PangoGlyphString`
* which should be freed with [method@Pango.GlyphString.free],
* or %NULL if @string was %NULL.
*/
PangoGlyphString *
pango_glyph_string_copy (PangoGlyphString *string)
......@@ -144,17 +144,15 @@ pango_glyph_string_free (PangoGlyphString *string)
/**
* pango_glyph_string_extents_range:
* @glyphs: a `PangoGlyphString`
* @start: start index
* @end: end index (the range is the set of bytes with
indices such that start <= index < end)
* @font: a `PangoFont`
* @glyphs: a `PangoGlyphString`
* @start: start index
* @end: end index (the range is the set of bytes with
* indices such that start <= index < end)
* @font: a `PangoFont`
* @ink_rect: (out caller-allocates) (optional): rectangle used to
* store the extents of the glyph string range as drawn or
* %NULL to indicate that the result is not needed.
* store the extents of the glyph string range as drawn
* @logical_rect: (out caller-allocates) (optional): rectangle used to
* store the logical extents of the glyph string range or
* %NULL to indicate that the result is not needed.
* store the logical extents of the glyph string range
*
* Computes the extents of a sub-portion of a glyph string.
*
......@@ -262,12 +260,10 @@ pango_glyph_string_extents_range (PangoGlyphString *glyphs,
/**
* pango_glyph_string_extents:
* @glyphs: a `PangoGlyphString`
* @font: a `PangoFont`
* @ink_rect: (out) (optional): rectangle used to store the extents of the glyph string
* as drawn or %NULL to indicate that the result is not needed.
* @logical_rect: (out) (optional): rectangle used to store the logical extents of the
* glyph string or %NULL to indicate that the result is not needed.
* @glyphs: a `PangoGlyphString`
* @font: a `PangoFont`
* @ink_rect: (out) (optional): rectangle used to store the extents of the glyph string as drawn
* @logical_rect: (out) (optional): rectangle used to store the logical extents of the glyph string
*
* Compute the logical and ink extents of a glyph string.
*
......@@ -322,9 +318,8 @@ pango_glyph_string_get_width (PangoGlyphString *glyphs)
* @length: the length of @text, in bytes
* @embedding_level: the embedding level of the string
* @logical_widths: (array): an array whose length is the number of
* characters in text (equal to g_utf8_strlen (text,
* length) unless text has NUL bytes) to be filled in
* with the resulting character widths.
* characters in text (equal to `g_utf8_strlen (text, length)` unless
* text has `NUL` bytes) to be filled in with the resulting character widths.
*
* Given a `PangoGlyphString` and corresponding text, determine the width
* corresponding to each character.
......@@ -363,14 +358,14 @@ pango_glyph_string_get_logical_widths (PangoGlyphString *glyphs,
/**
* pango_glyph_string_index_to_x:
* @glyphs: the glyphs return from [func@shape]
* @text: the text for the run
* @length: the number of bytes (not characters) in @text.
* @analysis: the analysis information return from [func@itemize]
* @index_: the byte index within @text
* @trailing: whether we should compute the result for the beginning (%FALSE)
* or end (%TRUE) of the character.
* @x_pos: (out): location to store result
* @glyphs: the glyphs return from [func@shape]
* @text: the text for the run
* @length: the number of bytes (not characters) in @text.
* @analysis: the analysis information return from [func@itemize]
* @index_: the byte index within @text
* @trailing: whether we should compute the result for the beginning (%FALSE)
* or end (%TRUE) of the character.
* @x_pos: (out): location to store result
*
* Converts from character position to x position.
*
......@@ -378,7 +373,6 @@ pango_glyph_string_get_logical_widths (PangoGlyphString *glyphs,
* Character positions are computed by dividing up each cluster
* into equal portions.
*/
void
pango_glyph_string_index_to_x (PangoGlyphString *glyphs,
char *text,
......@@ -493,15 +487,14 @@ pango_glyph_string_index_to_x (PangoGlyphString *glyphs,
/**
* pango_glyph_string_x_to_index:
* @glyphs: the glyphs returned from [func@shape]
* @text: the text for the run
* @length: the number of bytes (not characters) in text.
* @analysis: the analysis information return from [func@itemize]
* @x_pos: the x offset (in Pango units)
* @index_: (out): location to store calculated byte index within @text
* @trailing: (out): location to store a boolean indicating
* whether the user clicked on the leading or trailing
* edge of the character.
* @glyphs: the glyphs returned from [func@shape]
* @text: the text for the run
* @length: the number of bytes (not characters) in text.
* @analysis: the analysis information return from [func@itemize]
* @x_pos: the x offset (in Pango units)
* @index_: (out): location to store calculated byte index within @text
* @trailing: (out): location to store a boolean indicating whether the
* user clicked on the leading or trailing edge of the character
*
* Convert from x offset to character position.
*
......
pango/modules.c
View file @ 7f04ed92
......@@ -45,8 +45,8 @@ pango_find_map (PangoLanguage *language G_GNUC_UNUSED,
/**
* pango_map_get_engine: (skip)
* @map: a #PangoMap
* @script: a #PangoScript
* @map: a `PangoMap`
* @script: a `PangoScript`
*
* Do not use. Does not do anything.
*
......@@ -63,8 +63,8 @@ pango_map_get_engine (PangoMap *map G_GNUC_UNUSED,
/**
* pango_map_get_engines: (skip)
* @map: a #PangoMap
* @script: a #PangoScript
* @map: a `PangoMap`
* @script: a `PangoScript`
* @exact_engines: (nullable): location to store list of engines that exactly
* handle this script.
* @fallback_engines: (nullable): location to store list of engines that
......@@ -89,7 +89,7 @@ pango_map_get_engines (PangoMap *map G_GNUC_UNUSED,
/**
* pango_module_register: (skip)
* @module: a #PangoIncludedModule
* @module: a `PangoIncludedModule`
*
* Do not use. Does not do anything.
*
......
pango/pango-attributes.c
View file @ 7f04ed92
This diff is collapsed.
pango/pango-attributes.h
View file @ 7f04ed92
......@@ -209,28 +209,28 @@ typedef enum
* @PANGO_UNDERLINE_SINGLE: a single underline should be drawn
* @PANGO_UNDERLINE_DOUBLE: a double underline should be drawn
* @PANGO_UNDERLINE_LOW: a single underline should be drawn at a
* position beneath the ink extents of the text being
* underlined. This should be used only for underlining
* single characters, such as for keyboard accelerators.
* %PANGO_UNDERLINE_SINGLE should be used for extended
* portions of text.
* position beneath the ink extents of the text being
* underlined. This should be used only for underlining
* single characters, such as for keyboard accelerators.
* %PANGO_UNDERLINE_SINGLE should be used for extended
* portions of text.
* @PANGO_UNDERLINE_ERROR: an underline indicating an error should
* be drawn below. The exact style of rendering is up to the
* `PangoRenderer` in use, but typical styles include wavy
* or dotted lines.
* This underline is typically used to indicate an error such
* as a possible mispelling; in some cases a contrasting color
* may automatically be used. This type of underlining is
* available since Pango 1.4.
* be drawn below. The exact style of rendering is up to the
* `PangoRenderer` in use, but typical styles include wavy
* or dotted lines.
* This underline is typically used to indicate an error such
* as a possible mispelling; in some cases a contrasting color
* may automatically be used. This type of underlining is
* available since Pango 1.4.
* @PANGO_UNDERLINE_SINGLE_LINE: Like @PANGO_UNDERLINE_SINGLE, but
* drawn continuously across multiple runs. This type
* of underlining is available since Pango 1.46.
* drawn continuously across multiple runs. This type
* of underlining is available since Pango 1.46.
* @PANGO_UNDERLINE_DOUBLE_LINE: Like @PANGO_UNDERLINE_DOUBLE, but
* drawn continuously across multiple runs. This type
* of underlining is available since Pango 1.46.
* drawn continuously across multiple runs. This type
* of underlining is available since Pango 1.46.
* @PANGO_UNDERLINE_ERROR_LINE: Like @PANGO_UNDERLINE_ERROR, but
* drawn continuously across multiple runs. This type
* of underlining is available since Pango 1.46.
* drawn continuously across multiple runs. This type
* of underlining is available since Pango 1.46.
*
* The `PangoUnderline` enumeration is used to specify whether text
* should be underlined, and if so, the type of underlining.
......@@ -251,7 +251,7 @@ typedef enum {
* PangoOverline:
* @PANGO_OVERLINE_NONE: no overline should be drawn
* @PANGO_OVERLINE_SINGLE: Draw a single line above the ink
* extents of the text being underlined.
* extents of the text being underlined.
*
* The `PangoOverline` enumeration is used to specify whether text
* should be overlined, and if so, the type of line.
......@@ -596,7 +596,7 @@ PangoAttribute *pango_attr_overline_color_new (guint16 red,
* @PANGO_SHOW_SPACES: Render spaces, tabs and newlines visibly
* @PANGO_SHOW_LINE_BREAKS: Render line breaks visibly
* @PANGO_SHOW_IGNORABLES: Render default-ignorable Unicode
* characters visibly
* characters visibly
*
* These flags affect how Pango treats characters that are normally
* not visible in the output.
......
pango/pango-bidi-type.c
View file @ 7f04ed92
......@@ -91,9 +91,9 @@ pango_bidi_type_for_unichar (gunichar ch)
/**
* pango_log2vis_get_embedding_levels:
* @text: the text to itemize.
* @length: the number of bytes (not characters) to process, or -1
* if @text is nul-terminated and the length should be calculated.
* @text: the text to itemize.
* @length: the number of bytes (not characters) to process, or -1
* if @text is nul-terminated and the length should be calculated.
* @pbase_dir: input base direction, and output resolved direction.
*
* Return the bidirectional embedding levels of the input paragraph.
......
pango/pango-color.c
View file @ 7f04ed92
......@@ -34,18 +34,18 @@ G_DEFINE_BOXED_TYPE (PangoColor, pango_color,
/**
* pango_color_copy:
* @src: (nullable): color to copy, may be %NULL
* @src: (nullable): color to copy
*
* Creates a copy of @src.
*
* The copy should be freed with pango_color_free(). Primarily
* used by language bindings, not that useful otherwise (since
* colors can just be copied by assignment in C).
* The copy should be freed with [method@Pango.Color.free].
* Primarily used by language bindings, not that useful
* otherwise (since colors can just be copied by assignment
* in C).
*
* Return value: (nullable): the newly allocated `PangoColor`, which
* should be freed with [method@Pango.Color.free], or %NULL if
* @src was %NULL.
**/
* Return value: (nullable): the newly allocated `PangoColor`,
* which should be freed with [method@Pango.Color.free]
*/
PangoColor*
pango_color_copy (const PangoColor *src)
{
......@@ -63,10 +63,10 @@ pango_color_copy (const PangoColor *src)
/**
* pango_color_free:
* @color: (nullable): an allocated #PangoColor, may be %NULL
* @color: (nullable): an allocated `PangoColor`
*
* Frees a color allocated by pango_color_copy().
**/
* Frees a color allocated by [ctor@Pango.copy].
*/
void
pango_color_free (PangoColor *color)
{
......@@ -78,18 +78,19 @@ pango_color_free (PangoColor *color)
/**
* pango_color_to_string:
* @color: a #PangoColor
* @color: a `PangoColor`
*
* Returns a textual specification of @color.
*
* The string is in the hexadecimal form `#rrrrggggbbbb`, where
* `r`, `g` and `b` are hex digits representing the red, green,
* and blue components respectively.
* The string is in the hexadecimal form `#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().
* Return value: a newly-allocated text string that must
* be freed with g_free().
*
* Since: 1.16
**/
*/
gchar *
pango_color_to_string (const PangoColor *color)
{
......@@ -211,27 +212,29 @@ hex (const char *spec,
/**
* pango_color_parse_with_alpha:
* @color: (nullable): a `PangoColor` structure in which to store the
* result, or %NULL
* @alpha: (out) (optional): return location for alpha, or %NULL
* @color: (nullable): a `PangoColor` structure in which
* to store the result
* @alpha: (out) (optional): return location for alpha
* @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 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`.)
* 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
* in @spec, @alpha is set to 0xffff (for a solid color).
* `#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
*/
......@@ -320,22 +323,23 @@ pango_color_parse_with_alpha (PangoColor *color,
/**
* pango_color_parse:
* @color: (nullable): a `PangoColor` structure in which to store the
* result, or %NULL
* @color: (nullable): a `PangoColor` structure in which
* to store the result
* @spec: a string specifying the new color
*
* Fill in the fields of a color from a string specification.
*