Commit 91f7b966 authored by Matthias Clasen's avatar Matthias Clasen
Browse files

gtk: Clean up docs syntax

Replace leftover gtk-doc syntax (#Type) with backquotes.
parent 2d266d10
......@@ -1821,11 +1821,11 @@ gtk_at_spi_context_get_context_path (GtkAtSpiContext *self)
/*< private >
* gtk_at_spi_context_to_ref:
* @self: a #GtkAtSpiContext
* @self: a `GtkAtSpiContext`
*
* Returns an ATSPI object reference for the #GtkAtSpiContext.
* Returns an ATSPI object reference for the `GtkAtSpiContext`.
*
* Returns: (transfer floating): a #GVariant with the reference
* Returns: (transfer floating): a `GVariant` with the reference
*/
GVariant *
gtk_at_spi_context_to_ref (GtkAtSpiContext *self)
......
......@@ -139,14 +139,15 @@ gtk_pango_get_font_attributes (PangoFontDescription *font,
/*
* gtk_pango_get_default_attributes:
* @attributes: a #AtkAttributeSet to add the attributes to
* @layout: the #PangoLayout from which to get attributes
* @layout: the `PangoLayout` from which to get attributes
* @builder: a `GVariantBuilder` to add to
*
* Adds the default text attributes from @layout to @attributes,
* after translating them from Pango attributes to atspi attributes.
* Adds the default text attributes from @layout to @builder,
* after translating them from Pango attributes to atspi
* attributes.
*
* This is a convenience function that can be used to implement
* support for the #AtkText interface in widgets using Pango
* support for the `AtkText` interface in widgets using Pango
* layouts.
*
* Returns: the modified @attributes
......@@ -212,8 +213,8 @@ gtk_pango_get_default_attributes (PangoLayout *layout,
/*
* gtk_pango_get_run_attributes:
* @layout: the #PangoLayout to get the attributes from
* @builder: GVariantBuilder to add to
* @layout: the `PangoLayout` to get the attributes from
* @builder: `GVariantBuilder` to add to
* @offset: the offset at which the attributes are wanted
* @start_offset: return location for the starting offset
* of the current run
......@@ -394,7 +395,7 @@ gtk_pango_get_run_attributes (PangoLayout *layout,
/*
* gtk_pango_move_chars:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of characters to move from @offset
*
......@@ -438,7 +439,7 @@ gtk_pango_move_chars (PangoLayout *layout,
/*
* gtk_pango_move_words:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of words to move from @offset
*
......@@ -484,7 +485,7 @@ gtk_pango_move_words (PangoLayout *layout,
/*
* gtk_pango_move_sentences:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of sentences to move from @offset
*
......@@ -531,7 +532,7 @@ gtk_pango_move_sentences (PangoLayout *layout,
#if 0
/*
* gtk_pango_move_lines:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @count: the number of lines to move from @offset
*
......@@ -602,7 +603,7 @@ gtk_pango_move_lines (PangoLayout *layout,
/*
* gtk_pango_is_inside_word:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
*
* Returns whether the given position is inside
......@@ -631,7 +632,7 @@ gtk_pango_is_inside_word (PangoLayout *layout,
/*
* gtk_pango_is_inside_sentence:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
*
* Returns whether the given position is inside
......@@ -867,7 +868,7 @@ pango_layout_get_line_after (PangoLayout *layout,
/*
* gtk_pango_get_text_before:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @boundary_type: a #AtspiTextBoundaryType
* @start_offset: return location for the start of the returned text
......@@ -972,7 +973,7 @@ gtk_pango_get_text_before (PangoLayout *layout,
/*
* gtk_pango_get_text_after:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @boundary_type: a #AtspiTextBoundaryType
* @start_offset: return location for the start of the returned text
......@@ -1083,9 +1084,9 @@ gtk_pango_get_text_after (PangoLayout *layout,
/*
* gtk_pango_get_text_at:
* @layout: a #PangoLayout
* @layout: a `PangoLayout`
* @offset: a character offset in @layout
* @boundary_type: a #AtspiTextBoundaryType
* @boundary_type: a `AtspiTextBoundaryType`
* @start_offset: return location for the start of the returned text
* @end_offset: return location for the end of the return text
*
......
......@@ -585,7 +585,7 @@ root_register (gpointer data)
/*< private >
* gtk_at_spi_root_queue_register:
* @self: a #GtkAtSpiRoot
* @self: a `GtkAtSpiRoot`
*
* Queues the registration of the root object on the AT-SPI bus.
*/
......@@ -761,11 +761,11 @@ gtk_at_spi_root_get_cache (GtkAtSpiRoot *self)
/*< private >
* gtk_at_spi_root_to_ref:
* @self: a #GtkAtSpiRoot
* @self: a `GtkAtSpiRoot`
*
* Returns an ATSPI object reference for the #GtkAtSpiRoot node.
* Returns an ATSPI object reference for the `GtkAtSpiRoot` node.
*
* Returns: (transfer floating): a #GVariant with the root reference
* Returns: (transfer floating): a `GVariant` with the root reference
*/
GVariant *
gtk_at_spi_root_to_ref (GtkAtSpiRoot *self)
......
......@@ -28,9 +28,9 @@
/*< private >
* gtk_accessible_role_to_atspi_role:
* @role: a #GtkAccessibleRole
* @role: a `GtkAccessibleRole`
*
* Converts a #GtkAccessibleRole value to the equivalent ATSPI role.
* Converts a `GtkAccessibleRole` value to the equivalent ATSPI role.
*
* Returns: an #AtspiRole
*/
......@@ -282,10 +282,10 @@ gtk_accessible_role_to_atspi_role (GtkAccessibleRole role)
/*<private>
* gtk_atspi_role_for_context:
* @context: a #GtkATContext
* @context: a `GtkATContext`
*
* Returns a suitable ATSPI role for a context, taking into account
* both the #GtkAccessibleRole set on the context and the type
* both the `GtkAccessibleRole` set on the context and the type
* of accessible.
*
* Returns: an #AtspiRole
......
......@@ -42,8 +42,8 @@
*
* Decodes a data URL according to RFC2397 and returns the decoded data.
*
* Returns: a new #GBytes with the decoded data
**/
* Returns: a new `GBytes` with the decoded data
*/
GBytes *
gtk_css_data_url_parse (const char *url,
char **out_mimetype,
......
......@@ -64,7 +64,7 @@ typedef enum
*
* Warnings that can occur while parsing CSS.
*
* Unlike #GtkCssParserErrors, warnings do not cause the parser to
* Unlike `GtkCssParserError`s, warnings do not cause the parser to
* skip any input, but they indicate issues that should be fixed.
*/
typedef enum
......
......@@ -29,7 +29,7 @@ G_BEGIN_DECLS
/**
* GTK_CSS_PARSER_ERROR:
*
* Domain for #GtkCssParser errors.
* Domain for `GtkCssParser` errors.
*/
#define GTK_CSS_PARSER_ERROR (gtk_css_parser_error_quark ())
......@@ -39,7 +39,7 @@ GQuark gtk_css_parser_error_quark (void);
/**
* GTK_CSS_PARSER_WARNING:
*
* Domain for #GtkCssParser warnings.
* Domain for `GtkCssParser` warnings.
*/
#define GTK_CSS_PARSER_WARNING (gtk_css_parser_warning_quark ())
......
......@@ -152,7 +152,7 @@ gtk_css_parser_unref (GtkCssParser *self)
/**
* gtk_css_parser_get_file:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Gets the file being parsed. If no file is associated with @self -
* for example when raw data is parsed - %NULL is returned.
......@@ -167,7 +167,7 @@ gtk_css_parser_get_file (GtkCssParser *self)
/**
* gtk_css_parser_resolve_url:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @url: the URL to resolve
*
* Resolves a given URL against the parser's location.
......@@ -198,7 +198,7 @@ gtk_css_parser_resolve_url (GtkCssParser *self,
/**
* gtk_css_parser_get_start_location:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Queries the location of the current token.
*
......@@ -222,7 +222,7 @@ gtk_css_parser_get_start_location (GtkCssParser *self)
/**
* gtk_css_parser_get_end_location:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @out_location: (caller-allocates) Place to store the location
*
* Queries the location of the current token.
......@@ -247,7 +247,7 @@ gtk_css_parser_get_end_location (GtkCssParser *self)
/**
* gtk_css_parser_get_block_location:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Queries the start location of the token that started the current
* block that is being parsed.
......@@ -450,7 +450,7 @@ gtk_css_parser_end_block (GtkCssParser *self)
/*
* gtk_css_parser_skip:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* Skips a component value.
*
......@@ -477,7 +477,7 @@ gtk_css_parser_skip (GtkCssParser *self)
/*
* gtk_css_parser_skip_until:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @token_type: type of token to skip to
*
* Repeatedly skips a token until a certain type is reached.
......@@ -700,7 +700,7 @@ gtk_css_parser_consume_function (GtkCssParser *self,
/**
* gtk_css_parser_has_token:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @token_type: type of the token to check
*
* Checks if the next token is of @token_type.
......@@ -720,7 +720,7 @@ gtk_css_parser_has_token (GtkCssParser *self,
/**
* gtk_css_parser_has_ident:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @ident: name of identifier
*
* Checks if the next token is an identifier with the given @name.
......@@ -752,7 +752,7 @@ gtk_css_parser_has_integer (GtkCssParser *self)
/**
* gtk_css_parser_has_function:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @name: name of function
*
* Checks if the next token is a function with the given @name.
......@@ -773,7 +773,7 @@ gtk_css_parser_has_function (GtkCssParser *self,
/**
* gtk_css_parser_try_delim:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @codepoint: unicode character codepoint to check
*
* Checks if the current token is a delimiter matching the given
......@@ -803,7 +803,7 @@ gtk_css_parser_try_delim (GtkCssParser *self,
/**
* gtk_css_parser_try_ident:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @ident: identifier to check for
*
* Checks if the current token is an identifier matching the given
......@@ -830,7 +830,7 @@ gtk_css_parser_try_ident (GtkCssParser *self,
/**
* gtk_css_parser_try_at_keyword:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @keyword: name of keyword to check for
*
* Checks if the current token is an at-keyword token with the
......@@ -857,7 +857,7 @@ gtk_css_parser_try_at_keyword (GtkCssParser *self,
/**
* gtk_css_parser_try_token:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
* @token_type: type of token to try
*
* Consumes the next token if it matches the given @token_type.
......@@ -886,7 +886,7 @@ gtk_css_parser_try_token (GtkCssParser *self,
/**
* gtk_css_parser_consume_ident:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* If the current token is an identifier, consumes it and returns
* its name.
......@@ -918,7 +918,7 @@ gtk_css_parser_consume_ident (GtkCssParser *self)
/**
* gtk_css_parser_consume_string:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* If the current token is a string, consumes it and return the string.
*
......@@ -963,11 +963,11 @@ gtk_css_parser_parse_url_arg (GtkCssParser *parser,
/**
* gtk_css_parser_consume_url:
* @self: a #GtkCssParser
* @self: a `GtkCssParser`
*
* If the parser matches the <url> token from the [CSS
* specification](https://drafts.csswg.org/css-values-4/#url-value),
* consumes it, resolves the URL and returns the resulting #GFile.
* consumes it, resolves the URL and returns the resulting `GFile`.
* On failure, an error is emitted and %NULL is returned.
*
* Returns: (nullable) (transfer full): the resulting URL
......
......@@ -188,7 +188,7 @@ gtk_css_section_get_end_location (const GtkCssSection *section)
/**
* gtk_css_section_print:
* @section: a section
* @string: a #GString to print to
* @string: a `GString` to print to
*
* Prints the `section` into `string` in a human-readable form.
*
......@@ -235,7 +235,7 @@ gtk_css_section_print (const GtkCssSection *section,
/**
* gtk_css_section_to_string:
* @section: a #GtkCssSection
* @section: a `GtkCssSection`
*
* Prints the section into a human-readable text form using
* [method@Gtk.CssSection.print].
......
......@@ -151,7 +151,7 @@ append_string (GString *string,
/*
* gtk_css_token_is_finite:
* @token: a #GtkCssToken
* @token: a `GtkCssToken`
*
* A token is considered finite when it would stay the same no matter
* what bytes follow it in the data stream.
......@@ -213,7 +213,7 @@ gtk_css_token_is_finite (const GtkCssToken *token)
/*
* gtk_css_token_is_preserved:
* @token: a #GtkCssToken
* @token: a `GtkCssToken`
* @out_closing: (nullable): Type of the token that closes a block
* started with this token
*
......
......@@ -453,8 +453,8 @@ gsk_pango_renderer_release (GskPangoRenderer *renderer)
/**
* gtk_snapshot_append_layout:
* @snapshot: a #GtkSnapshot
* @layout: the #PangoLayout to render
* @snapshot: a `GtkSnapshot`
* @layout: the `PangoLayout` to render
* @color: the foreground color to render the layout in
*
* Creates render nodes for rendering @layout in the given foregound @color
......
......@@ -78,7 +78,7 @@ gtk_accessible_default_init (GtkAccessibleInterface *iface)
/*< private >
* gtk_accessible_get_at_context:
* @self: a #GtkAccessible
* @self: a `GtkAccessible`
*
* Retrieves the `GtkATContext` for the given `GtkAccessible`.
*
......@@ -707,7 +707,7 @@ gtk_accessible_platform_changed (GtkAccessible *self,
*
* This functionality can be overridden by `GtkAccessible`
* implementations, e.g. to get platform state from an ignored
* child widget, as is the case for #GtkText wrappers.
* child widget, as is the case for `GtkText` wrappers.
*
* Returns: the value of @state for the accessible
*/
......@@ -754,7 +754,7 @@ gtk_accessible_bounds_changed (GtkAccessible *self)
* By default, hidden widgets are are among these, but there can
* be other reasons to return %FALSE, e.g. for widgets that are
* purely presentations, or for widgets whose functionality is
* represented elsewhere, as is the case for #GtkText widgets.
* represented elsewhere, as is the case for `GtkText` widgets.
*
* Returns: %TRUE if the widget should be represented
*/
......
......@@ -98,9 +98,9 @@ gtk_accessible_attribute_set_unref (GtkAccessibleAttributeSet *self)
/*< private >
* gtk_accessible_attribute_set_add:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @attribute: the attribute to set
* @value: (nullable): a #GtkAccessibleValue
* @value: (nullable): a `GtkAccessibleValue`
*
* Adds @attribute to the attributes set, and sets its value.
*
......@@ -143,10 +143,11 @@ gtk_accessible_attribute_set_add (GtkAccessibleAttributeSet *self,
/*< private >
* gtk_accessible_attribute_set_remove:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @attribute: the attribute to be removed
*
* Resets the @attribute in the given #GtkAccessibleAttributeSet to its default value.
* Resets the @attribute in the given `GtkAccessibleAttributeSet`
* to its default value.
*
* Returns: %TRUE if the set was modified, and %FALSE otherwise
*/
......@@ -178,7 +179,7 @@ gtk_accessible_attribute_set_contains (GtkAccessibleAttributeSet *self,
/*< private >
* gtk_accessible_attribute_set_get_value:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @attribute: the attribute to retrieve
*
* Retrieves the value of the given @attribute in the set.
......@@ -216,11 +217,11 @@ gtk_accessible_attribute_set_get_changed (GtkAccessibleAttributeSet *self)
/*< private >
* gtk_accessible_attribute_set_print:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
* @only_set: %TRUE if only the set attributes should be printed
* @buffer: a #GString
* @buffer: a `GString`
*
* Prints the contents of the #GtkAccessibleAttributeSet into @buffer.
* Prints the contents of the `GtkAccessibleAttributeSet` into @buffer.
*/
void
gtk_accessible_attribute_set_print (GtkAccessibleAttributeSet *self,
......@@ -254,12 +255,12 @@ gtk_accessible_attribute_set_print (GtkAccessibleAttributeSet *self,
/*< private >
* gtk_accessible_attribute_set_to_string:
* @self: a #GtkAccessibleAttributeSet
* @self: a `GtkAccessibleAttributeSet`
*
* Prints the contents of a #GtkAccessibleAttributeSet into a string.
* Prints the contents of a `GtkAccessibleAttributeSet` into a string.
*
* Returns: (transfer full): a newly allocated string with the contents
* of the #GtkAccessibleAttributeSet
* of the `GtkAccessibleAttributeSet`
*/
char *
gtk_accessible_attribute_set_to_string (GtkAccessibleAttributeSet *self)
......
<
......@@ -22,7 +22,7 @@
* GtkAccessibleValue:
*
* GtkAccessibleValue is a reference counted, generic container for values used
* to represent the state and properties of a #GtkAccessible implementation.
* to represent the state and properties of a `GtkAccessible` implementation.
*
* There are two kinds of accessible value types:
*
......@@ -59,12 +59,12 @@ G_DEFINE_BOXED_TYPE (GtkAccessibleValue, gtk_accessible_value,
/*< private >
* gtk_accessible_value_alloc:
* @value_class: a #GtkAccessibleValueClass structure
* @value_class: a `GtkAccessibleValueClass` structure
*
* Allocates a new #GtkAccessibleValue subclass using @value_class as the
* Allocates a new `GtkAccessibleValue` subclass using @value_class as the
* type definition.
*
* Returns: (transfer full): the newly allocated #GtkAccessibleValue
* Returns: (transfer full): the newly allocated `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_alloc (const GtkAccessibleValueClass *value_class)
......@@ -89,9 +89,9 @@ gtk_accessible_value_alloc (const GtkAccessibleValueClass *value_class)
/*< private >
* gtk_accessible_value_ref:
* @self: a #GtkAccessibleValue
* @self: a `GtkAccessibleValue`
*
* Acquires a reference on the given #GtkAccessibleValue.
* Acquires a reference on the given `GtkAccessibleValue`.
*
* Returns: (transfer full): the value, with an additional reference
*/
......@@ -107,9 +107,9 @@ gtk_accessible_value_ref (GtkAccessibleValue *self)
/*< private >
* gtk_accessible_value_unref:
* @self: (transfer full): a #GtkAccessibleValue
* @self: (transfer full): a `GtkAccessibleValue`
*
* Releases a reference on the given #GtkAccessibleValue.
* Releases a reference on the given `GtkAccessibleValue`.
*/
void
gtk_accessible_value_unref (GtkAccessibleValue *self)
......@@ -128,10 +128,10 @@ gtk_accessible_value_unref (GtkAccessibleValue *self)
/*< private >
* gtk_accessible_value_print:
* @self: a #GtkAccessibleValue
* @buffer: a #GString
* @self: a `GtkAccessibleValue`
* @buffer: a `GString`
*
* Prints the contents of a #GtkAccessibleValue into the given @buffer.
* Prints the contents of a `GtkAccessibleValue` into the given @buffer.
*/
void
gtk_accessible_value_print (const GtkAccessibleValue *self,
......@@ -146,9 +146,9 @@ gtk_accessible_value_print (const GtkAccessibleValue *self,
/*< private >
* gtk_accessible_value_to_string:
* @self: a #GtkAccessibleValue
* @self: a `GtkAccessibleValue`
*
* Fills a string with the contents of the given #GtkAccessibleValue.
* Fills a string with the contents of the given `GtkAccessibleValue`.
*
* Returns: (transfer full): a string with the contents of the value
*/
......@@ -166,14 +166,14 @@ gtk_accessible_value_to_string (const GtkAccessibleValue *self)
/*< private >
* gtk_accessible_value_equal:
* @value_a: (nullable): the first #GtkAccessibleValue
* @value_b: (nullable): the second #GtkAccessibleValue
* @value_a: (nullable): the first `GtkAccessibleValue`
* @value_b: (nullable): the second `GtkAccessibleValue`
*
* Checks whether @value_a and @value_b are equal.
*
* This function is %NULL-safe.
*
* Returns: %TRUE if the given #GtkAccessibleValue instances are equal,
* Returns: %TRUE if the given `GtkAccessibleValue` instances are equal,
* and %FALSE otherwise
*/
gboolean
......@@ -556,9 +556,10 @@ static const GtkAccessibleValueClass GTK_REFERENCE_LIST_ACCESSIBLE_VALUE = {
* gtk_reference_list_accessible_value_new:
* @value: (element-type GtkAccessible) (transfer full): a list of accessible objects
*
* Creates a new #GtkAccessible that stores a list of references to #GtkAccessible objects.
* Creates a new `GtkAccessible` that stores a list of references
* to `GtkAccessible` objects.
*
* Returns: (transfer full): the newly created #GtkAccessible
* Returns: (transfer full): the newly created `GtkAccessible`
*/
GtkAccessibleValue *
gtk_reference_list_accessible_value_new (GList *value)
......@@ -914,12 +915,12 @@ typedef void (* GtkAccessibleValueEnumInit) (GValue *va
/*< private >
* gtk_accessible_value_get_default_for_state:
* @state: a #GtkAccessibleState
* @state: a `GtkAccessibleState`
*
* Retrieves the #GtkAccessibleValue that contains the default for the
* Retrieves the `GtkAccessibleValue` that contains the default for the
* given @state.
*
* Returns: (transfer full): the #GtkAccessibleValue
* Returns: (transfer full): the `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_get_default_for_state (GtkAccessibleState state)
......@@ -1542,19 +1543,19 @@ gtk_accessible_attribute_init_value (const GtkAccessibleCollect *cstate,
/*< private >
* gtk_accessible_value_collect_for_state:
* @state: a #GtkAccessibleState
* @error: return location for a #GError
* @state: a `GtkAccessibleState`
* @error: return location for a `GError`
* @args: a `va_list` reference
*
* Collects and consumes the next item in the @args variadic arguments list,
* and returns a #GtkAccessibleValue for it.
* and returns a `GtkAccessibleValue` for it.
*
* If the collection fails, @error is set and %NULL is returned.
*
* The returned value could be %NULL even on success, in which case the state
* should be reset to its default value by the caller.
*
* Returns: (transfer full) (nullable): a #GtkAccessibleValue
* Returns: (transfer full) (nullable): a `GtkAccessibleValue`
*/
GtkAccessibleValue *
gtk_accessible_value_collect_for_state (GtkAccessibleState state,
......@@ -1570,11 +1571,11 @@ gtk_accessible_value_collect_for_state (GtkAccessibleState state,