diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2021-05-20 09:17:04 -0400 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2021-05-22 17:25:26 -0400 |
| commit | 91f7b9663fb17ebe26a28ec589a727397eef0967 (patch) | |
| tree | 0d53b59b4e28bd4c879bf2081f8bef1993a5b298 | |
| parent | 2d266d107b2db1c1bf478bf7c93e38884c86c366 (diff) | |
| download | gtk+-91f7b9663fb17ebe26a28ec589a727397eef0967.tar.gz | |
gtk: Clean up docs syntax
Replace leftover gtk-doc syntax (#Type) with backquotes.
230 files changed, 2640 insertions, 2623 deletions
diff --git a/gtk/a11y/gtkatspicontext.c b/gtk/a11y/gtkatspicontext.c index 7c5e967145..4804fe2f53 100644 --- a/gtk/a11y/gtkatspicontext.c +++ b/gtk/a11y/gtkatspicontext.c @@ -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) diff --git a/gtk/a11y/gtkatspipango.c b/gtk/a11y/gtkatspipango.c index 2f3697c83e..4c71b03b96 100644 --- a/gtk/a11y/gtkatspipango.c +++ b/gtk/a11y/gtkatspipango.c @@ -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 * diff --git a/gtk/a11y/gtkatspiroot.c b/gtk/a11y/gtkatspiroot.c index 1deafba927..5962361433 100644 --- a/gtk/a11y/gtkatspiroot.c +++ b/gtk/a11y/gtkatspiroot.c @@ -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) diff --git a/gtk/a11y/gtkatspiutils.c b/gtk/a11y/gtkatspiutils.c index 9210d3754e..a39314a7e8 100644 --- a/gtk/a11y/gtkatspiutils.c +++ b/gtk/a11y/gtkatspiutils.c @@ -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 diff --git a/gtk/css/gtkcssdataurl.c b/gtk/css/gtkcssdataurl.c index 77ab75687e..6645b4835d 100644 --- a/gtk/css/gtkcssdataurl.c +++ b/gtk/css/gtkcssdataurl.c @@ -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, diff --git a/gtk/css/gtkcssenums.h b/gtk/css/gtkcssenums.h index e83797e11a..7c42f33194 100644 --- a/gtk/css/gtkcssenums.h +++ b/gtk/css/gtkcssenums.h @@ -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 diff --git a/gtk/css/gtkcsserror.h b/gtk/css/gtkcsserror.h index a9392a2317..91bf5908fb 100644 --- a/gtk/css/gtkcsserror.h +++ b/gtk/css/gtkcsserror.h @@ -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 ()) diff --git a/gtk/css/gtkcssparser.c b/gtk/css/gtkcssparser.c index f8b403c3d8..aa2e171aa1 100644 --- a/gtk/css/gtkcssparser.c +++ b/gtk/css/gtkcssparser.c @@ -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 diff --git a/gtk/css/gtkcsssection.c b/gtk/css/gtkcsssection.c index c0edb7e1ff..5851cc201c 100644 --- a/gtk/css/gtkcsssection.c +++ b/gtk/css/gtkcsssection.c @@ -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]. diff --git a/gtk/css/gtkcsstokenizer.c b/gtk/css/gtkcsstokenizer.c index 34d29466b1..05fca8ed01 100644 --- a/gtk/css/gtkcsstokenizer.c +++ b/gtk/css/gtkcsstokenizer.c @@ -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 * diff --git a/gtk/gskpango.c b/gtk/gskpango.c index 332e96f4dc..e96c84a2fc 100644 --- a/gtk/gskpango.c +++ b/gtk/gskpango.c @@ -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 diff --git a/gtk/gtkaccessible.c b/gtk/gtkaccessible.c index 0c6e4cca4f..a5a8797ddd 100644 --- a/gtk/gtkaccessible.c +++ b/gtk/gtkaccessible.c @@ -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 */ diff --git a/gtk/gtkaccessibleattributeset.c b/gtk/gtkaccessibleattributeset.c index 2e7a072abc..fececf9bd1 100644 --- a/gtk/gtkaccessibleattributeset.c +++ b/gtk/gtkaccessibleattributeset.c @@ -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) diff --git a/gtk/gtkaccessiblevalue.c b/gtk/gtkaccessiblevalue.c index 063d1e13f0..6a9534bd8e 100644 --- a/gtk/gtkaccessiblevalue.c +++ b/gtk/gtkaccessiblevalue.c @@ -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, /*< private > * gtk_accessible_value_collect_for_state_value: - * @state: a #GtkAccessibleState - * @value: a #GValue - * @error: return location for a #GError + * @state: a `GtkAccessibleState` + * @value: a `GValue` + * @error: return location for a `GError` * - * Retrieves the value stored inside @value and returns a #GtkAccessibleValue + * Retrieves the value stored inside @value and returns a `GtkAccessibleValue` * for the given @state. * * If the collection fails, @error is set and %NULL is returned. @@ -1582,7 +1583,7 @@ gtk_accessible_value_collect_for_state (GtkAccessibleState state, * 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_value (GtkAccessibleState state, @@ -1611,8 +1612,8 @@ gtk_accessible_value_parse_for_state (GtkAccessibleState state, /** * gtk_accessible_state_init_value: - * @state: a #GtkAccessibleState - * @value: an uninitialized #GValue + * @state: a `GtkAccessibleState` + * @value: an uninitialized `GValue` * * Initializes @value with the appropriate type for the @state. * @@ -1632,12 +1633,12 @@ gtk_accessible_state_init_value (GtkAccessibleState state, /*< private > * gtk_accessible_value_get_default_for_property: - * @property: a #GtkAccessibleProperty + * @property: a `GtkAccessibleProperty` * - * Retrieves the #GtkAccessibleValue that contains the default for the + * Retrieves the `GtkAccessibleValue` that contains the default for the * given @property. * - * Returns: (transfer full): the #GtkAccessibleValue + * Returns: (transfer full): the `GtkAccessibleValue` */ GtkAccessibleValue * gtk_accessible_value_get_default_for_property (GtkAccessibleProperty property) @@ -1696,16 +1697,16 @@ gtk_accessible_value_get_default_for_property (GtkAccessibleProperty property) /*< private > * gtk_accessible_value_collect_for_property: - * @property: a #GtkAccessibleProperty - * @error: return location for a #GError + * @property: a `GtkAccessibleProperty` + * @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. * - * Returns: (transfer full) (nullable): a #GtkAccessibleValue + * Returns: (transfer full) (nullable): a `GtkAccessibleValue` */ GtkAccessibleValue * gtk_accessible_value_collect_for_property (GtkAccessibleProperty property, @@ -1721,11 +1722,11 @@ gtk_accessible_value_collect_for_property (GtkAccessibleProperty property, /*< private > * gtk_accessible_value_collect_for_property_value: - * @property: a #GtkAccessibleProperty - * @value: a #GValue - * @error: return location for a #GError + * @property: a `GtkAccessibleProperty` + * @value: a `GValue` + * @error: return location for a `GError` * - * Retrieves the value stored inside @value and returns a #GtkAccessibleValue + * Retrieves the value stored inside @value and returns a `GtkAccessibleValue` * for the given @property. * * If the collection fails, @error is set. @@ -1733,7 +1734,7 @@ gtk_accessible_value_collect_for_property (GtkAccessibleProperty property, * The returned value could be %NULL even on success, in which case the property * 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_property_value (GtkAccessibleProperty property, @@ -1762,8 +1763,8 @@ gtk_accessible_value_parse_for_property (GtkAccessibleProperty property, /** * gtk_accessible_property_init_value: - * @property: a #GtkAccessibleProperty - * @value: an uninitialized #GValue + * @property: a `GtkAccessibleProperty` + * @value: an uninitialized `GValue` * * Initializes @value with the appropriate type for the @property. * @@ -1783,12 +1784,12 @@ gtk_accessible_property_init_value (GtkAccessibleProperty property, /*< private > * gtk_accessible_value_get_default_for_relation: - * @relation: a #GtkAccessibleRelation + * @relation: a `GtkAccessibleRelation` * - * Retrieves the #GtkAccessibleValue that contains the default for the + * Retrieves the `GtkAccessibleValue` that contains the default for the * given @relation. * - * Returns: (transfer full): the #GtkAccessibleValue + * Returns: (transfer full): the `GtkAccessibleValue` */ GtkAccessibleValue * gtk_accessible_value_get_default_for_relation (GtkAccessibleRelation relation) @@ -1836,19 +1837,19 @@ gtk_accessible_value_get_default_for_relation (GtkAccessibleRelation relation) /*< private > * gtk_accessible_value_collect_for_relation: - * @relation: a #GtkAccessibleRelation - * @error: return location for a #GError + * @relation: a `GtkAccessibleRelation` + * @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 relation * 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_relation (GtkAccessibleRelation relation, @@ -1864,11 +1865,11 @@ gtk_accessible_value_collect_for_relation (GtkAccessibleRelation relation, /*< private > * gtk_accessible_value_collect_for_relation_value: - * @relation: a #GtkAccessibleRelation - * @value: a #GValue - * @error: return location for a #GError + * @relation: a `GtkAccessibleRelation` + * @value: a `GValue` + * @error: return location for a `GError` * - * Retrieves the value stored inside @value and returns a #GtkAccessibleValue + * Retrieves the value stored inside @value and returns a `GtkAccessibleValue` * for the given @relation. * * If the collection fails, @error is set and %NULL is returned. @@ -1876,7 +1877,7 @@ gtk_accessible_value_collect_for_relation (GtkAccessibleRelation relation, * The returned value could be %NULL even on success, in which case the relation * 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_relation_value (GtkAccessibleRelation relation, @@ -1905,8 +1906,8 @@ gtk_accessible_value_parse_for_relation (GtkAccessibleRelation relation, /** * gtk_accessible_relation_init_value: - * @relation: a #GtkAccessibleRelation - * @value: an uninitialized #GValue + * @relation: a `GtkAccessibleRelation` + * @value: an uninitialized `GValue` * * Initializes @value with the appropriate type for the @relation. * diff --git a/gtk/gtkactionhelper.c b/gtk/gtkactionhelper.c index 36eaa7bf24..9f0573eca1 100644 --- a/gtk/gtkactionhelper.c +++ b/gtk/gtkactionhelper.c @@ -368,10 +368,10 @@ gtk_action_helper_observer_iface_init (GtkActionObserverInterface *iface) /*< private > * gtk_action_helper_new: - * @widget: a #GtkWidget implementing #GtkActionable + * @widget: a `GtkWidget` implementing `GtkActionable` * * Creates a helper to track the state of a named action. This will - * usually be used by widgets implementing #GtkActionable. + * usually be used by widgets implementing `GtkActionable`. * * This helper class is usually used by @widget itself. In order to * avoid reference cycles, the helper does not hold a reference on @@ -380,7 +380,7 @@ gtk_action_helper_observer_iface_init (GtkActionObserverInterface *iface) * of the widget, you should take a ref on @widget for each ref you hold * on the helper. * - * Returns: a new #GtkActionHelper + * Returns: a new `GtkActionHelper` */ GtkActionHelper * gtk_action_helper_new (GtkActionable *widget) @@ -478,8 +478,8 @@ gtk_action_helper_set_action_name (GtkActionHelper *helper, /*< private > * gtk_action_helper_set_action_target_value: - * @helper: a #GtkActionHelper - * @target_value: an action target, as per #GtkActionable + * @helper: a `GtkActionHelper` + * @target_value: an action target, as per `GtkActionable` * * This function consumes @action_target if it is floating. */ diff --git a/gtk/gtkactionmuxer.c b/gtk/gtkactionmuxer.c index dc4eb5689b..d57e315daf 100644 --- a/gtk/gtkactionmuxer.c +++ b/gtk/gtkactionmuxer.c @@ -108,21 +108,21 @@ gtk_accels_remove (GtkAccels *accels, * * GtkActionMuxer aggregates and monitors actions from multiple sources. * - * #GtkActionMuxer is #GtkActionObservable and #GtkActionObserver that - * offers a #GActionGroup-like api and is capable of containing other - * #GActionGroup instances. #GtkActionMuxer does not implement the - * #GActionGroup interface because it requires excessive signal emissions - * and has poor scalability. We use the #GtkActionObserver machinery + * `GtkActionMuxer` is `GtkActionObservable` and `GtkActionObserver` that + * offers a `GActionGroup`-like api and is capable of containing other + * `GActionGroup` instances. `GtkActionMuxer` does not implement the + * `GActionGroup` interface because it requires excessive signal emissions + * and has poor scalability. We use the `GtkActionObserver` machinery * instead to propagate changes between action muxer instances and * to other users. * - * Beyond action groups, #GtkActionMuxer can incorporate actions that + * Beyond action groups, `GtkActionMuxer` can incorporate actions that * are associated with widget classes (*class actions*) and actions * that are associated with the parent widget, allowing for recursive * lookup. * - * In addition to the action attributes provided by #GActionGroup, - * #GtkActionMuxer maintains a *primary accelerator* string for + * In addition to the action attributes provided by `GActionGroup`, + * `GtkActionMuxer` maintains a *primary accelerator* string for * actions that can be shown in menuitems. * * The typical use is aggregating all of the actions applicable to a @@ -134,11 +134,11 @@ gtk_accels_remove (GtkAccels *accels, * application (such as “fullscreen”). * * In this case, each of these action groups could be added to a - * #GtkActionMuxer with the prefixes “app” and “win”, respectively. + * `GtkActionMuxer` with the prefixes “app” and “win”, respectively. * This would expose the actions as “app.quit” and “win.fullscreen” - * on the #GActionGroup-like interface presented by the #GtkActionMuxer. + * on the `GActionGroup`-like interface presented by the `GtkActionMuxer`. * - * Activations and state change requests on the #GtkActionMuxer are + * Activations and state change requests on the `GtkActionMuxer` are * wired through to the underlying actions in the expected way. * * This class is typically only used at the site of “consumption” of @@ -1223,9 +1223,9 @@ gtk_action_muxer_class_init (GObjectClass *class) /*< private > * gtk_action_muxer_insert: - * @muxer: a #GtkActionMuxer + * @muxer: a `GtkActionMuxer` * @prefix: the prefix string for the action group - * @action_group: a #GActionGroup + * @action_group: a `GActionGroup` * * Adds the actions in @action_group to the list of actions provided by * @muxer. @prefix is prefixed to each action name, such that for each @@ -1236,7 +1236,7 @@ gtk_action_muxer_class_init (GObjectClass *class) * contains an action called “`quit`”, then @muxer will * now contain an action called “`app.quit`”. * - * If any #GtkActionObservers are registered for actions in the group, + * If any `GtkActionObserver`s are registered for actions in the group, * “action_added” notifications will be emitted, as appropriate. * * @prefix must not contain a dot ('.'). @@ -1280,12 +1280,12 @@ gtk_action_muxer_insert (GtkActionMuxer *muxer, /*< private > * gtk_action_muxer_remove: - * @muxer: a #GtkActionMuxer + * @muxer: a `GtkActionMuxer` * @prefix: the prefix of the action group to remove * - * Removes a #GActionGroup from the #GtkActionMuxer. + * Removes a `GActionGroup` from the `GtkActionMuxer`. * - * If any #GtkActionObservers are registered for actions in the group, + * If any `GtkActionObserver`s are registered for actions in the group, * “action_removed” notifications will be emitted, as appropriate. */ void @@ -1319,7 +1319,7 @@ gtk_action_muxer_remove (GtkActionMuxer *muxer, * gtk_action_muxer_new: * @widget: the widget to which the muxer belongs * - * Creates a new #GtkActionMuxer. + * Creates a new `GtkActionMuxer`. */ GtkActionMuxer * gtk_action_muxer_new (GtkWidget *widget) @@ -1331,7 +1331,7 @@ gtk_action_muxer_new (GtkWidget *widget) /*< private > * gtk_action_muxer_get_parent: - * @muxer: a #GtkActionMuxer + * @muxer: a `GtkActionMuxer` * * Returns: (transfer none): the parent of @muxer, or NULL. */ @@ -1345,8 +1345,8 @@ gtk_action_muxer_get_parent (GtkActionMuxer *muxer) /*< private > * gtk_action_muxer_set_parent: - * @muxer: a #GtkActionMuxer - * @parent: (nullable): the new parent #GtkActionMuxer + * @muxer: a `GtkActionMuxer` + * @parent: (nullable): the new parent `GtkActionMuxer` * * Sets the parent of @muxer to @parent. */ diff --git a/gtk/gtkactionobservable.c b/gtk/gtkactionobservable.c index 01dac131a8..f5b429f8a3 100644 --- a/gtk/gtkactionobservable.c +++ b/gtk/gtkactionobservable.c @@ -30,9 +30,9 @@ gtk_action_observable_default_init (GtkActionObservableInterface *iface) /** * gtk_action_observable_register_observer: - * @observable: a #GtkActionObservable + * @observable: a `GtkActionObservable` * @action_name: the name of the action - * @observer: the #GtkActionObserver to which the events will be reported + * @observer: the `GtkActionObserver` to which the events will be reported * * Registers @observer as being interested in changes to @action_name on * @observable. @@ -50,9 +50,9 @@ gtk_action_observable_register_observer (GtkActionObservable *observable, /** * gtk_action_observable_unregister_observer: - * @observable: a #GtkActionObservable + * @observable: a `GtkActionObservable` * @action_name: the name of the action - * @observer: the #GtkActionObserver to which the events will be reported + * @observer: the `GtkActionObserver` to which the events will be reported * * Removes the registration of @observer as being interested in changes * to @action_name on @observable. diff --git a/gtk/gtkactionobserver.c b/gtk/gtkactionobserver.c index 0929c6a83e..77faa7fcb7 100644 --- a/gtk/gtkactionobserver.c +++ b/gtk/gtkactionobserver.c @@ -26,11 +26,11 @@ G_DEFINE_INTERFACE (GtkActionObserver, gtk_action_observer, G_TYPE_OBJECT) /*< private > * GtkActionObserver: * - * GtkActionObserver is a simple interface allowing objects that wish to + * `GtkActionObserver` is a simple interface allowing objects that wish to * be notified of changes to actions to be notified of those changes. * * It is also possible to monitor changes to action groups using - * #GObject signals, but there are a number of reasons that this + * `GObject` signals, but there are a number of reasons that this * approach could become problematic: * * - there are four separate signals that must be manually connected @@ -42,7 +42,7 @@ G_DEFINE_INTERFACE (GtkActionObserver, gtk_action_observer, G_TYPE_OBJECT) * to all observers: signal detail. In order to use signal detail, * each action name must be quarked, which is not always practical. * - * - even if quarking is acceptable, #GObject signal details are + * - even if quarking is acceptable, `GObject` signal details are * implemented by scanning a linked list, so there is no real * decrease in complexity */ @@ -54,7 +54,7 @@ gtk_action_observer_default_init (GtkActionObserverInterface *class) /*< private > * gtk_action_observer_action_added: - * @observer: a #GtkActionObserver + * @observer: a `GtkActionObserver` * @observable: the source of the event * @action_name: the name of the action * @enabled: %TRUE if the action is now enabled @@ -83,7 +83,7 @@ gtk_action_observer_action_added (GtkActionObserver *observer, /*< private > * gtk_action_observer_action_enabled_changed: - * @observer: a #GtkActionObserver + * @observer: a `GtkActionObserver` * @observable: the source of the event * @action_name: the name of the action * @enabled: %TRUE if the action is now enabled @@ -108,7 +108,7 @@ gtk_action_observer_action_enabled_changed (GtkActionObserver *observer, /*< private > * gtk_action_observer_action_state_changed: - * @observer: a #GtkActionObserver + * @observer: a `GtkActionObserver` * @observable: the source of the event * @action_name: the name of the action * @state: the new state of the action @@ -133,7 +133,7 @@ gtk_action_observer_action_state_changed (GtkActionObserver *observer, /*< private > * gtk_action_observer_action_removed: - * @observer: a #GtkActionObserver + * @observer: a `GtkActionObserver` * @observable: the source of the event * @action_name: the name of the action * @@ -156,7 +156,7 @@ gtk_action_observer_action_removed (GtkActionObserver *observer, /*< private > * gtk_action_observer_primary_accel_changed: - * @observer: a #GtkActionObserver + * @observer: a `GtkActionObserver` * @observable: the source of the event * @action_name: the name of the action * @action_and_target: detailed action of the changed accel, in “action and target” format diff --git a/gtk/gtkappchooserwidget.c b/gtk/gtkappchooserwidget.c index e7c0bcf4f5..b8a5f829da 100644 --- a/gtk/gtkappchooserwidget.c +++ b/gtk/gtkappchooserwidget.c @@ -988,7 +988,7 @@ gtk_app_chooser_widget_class_init (GtkAppChooserWidgetClass *klass) /** * GtkAppChooserWidget::application-selected: * @self: the object which received the signal - * @application: the selected #GAppInfo + * @application: the selected `GAppInfo` * * Emitted when an application item is selected from the widget's list. */ @@ -1005,7 +1005,7 @@ gtk_app_chooser_widget_class_init (GtkAppChooserWidgetClass *klass) /** * GtkAppChooserWidget::application-activated: * @self: the object which received the signal - * @application: the activated #GAppInfo + * @application: the activated `GAppInfo` * * Emitted when an application item is activated from the widget's list. * diff --git a/gtk/gtkapplication.c b/gtk/gtkapplication.c index 6eef3b1ded..c26e15cadb 100644 --- a/gtk/gtkapplication.c +++ b/gtk/gtkapplication.c @@ -1186,7 +1186,7 @@ gtk_application_handle_window_map (GtkApplication *application, /** * gtk_application_get_menu_by_id: - * @application: a #GtkApplication + * @application: a `GtkApplication` * @id: the id of the menu to look up * * Gets a menu from automatically loaded resources. diff --git a/gtk/gtkapplication.h b/gtk/gtkapplication.h index 56e51a18a6..ae354388e5 100644 --- a/gtk/gtkapplication.h +++ b/gtk/gtkapplication.h @@ -47,9 +47,9 @@ struct _GtkApplication /** * GtkApplicationClass: * @parent_class: The parent class. - * @window_added: Signal emitted when a #GtkWindow is added to + * @window_added: Signal emitted when a `GtkWindow` is added to * application through gtk_application_add_window(). - * @window_removed: Signal emitted when a #GtkWindow is removed from + * @window_removed: Signal emitted when a `GtkWindow` is removed from * application, either as a side-effect of being destroyed or * explicitly through gtk_application_remove_window(). */ diff --git a/gtk/gtkassistant.c b/gtk/gtkassistant.c index 0f13eb29bb..891b821e6b 100644 --- a/gtk/gtkassistant.c +++ b/gtk/gtkassistant.c @@ -596,7 +596,7 @@ gtk_assistant_class_init (GtkAssistantClass *class) /** * GtkAssistant:use-header-bar: * - * %TRUE if the assistant uses a #GtkHeaderBar for action buttons + * %TRUE if the assistant uses a `GtkHeaderBar` for action buttons * instead of the action-area. * * For technical reasons, this property is declared as an integer diff --git a/gtk/gtkatcontext.c b/gtk/gtkatcontext.c index 0d58350358..83aa94fe5d 100644 --- a/gtk/gtkatcontext.c +++ b/gtk/gtkatcontext.c @@ -596,9 +596,9 @@ gtk_at_context_create (GtkAccessibleRole accessible_role, * @role: the accessible role of the clone, or %GTK_ACCESSIBLE_ROLE_NONE to * use the same accessible role of @self * @accessible: (nullable): the accessible creating the context, or %NULL to - * use the same #GtkAccessible of @self + * use the same `GtkAccessible` of @self * @display: (nullable): the display connection, or %NULL to use the same - * #GdkDisplay of @self + * `GdkDisplay` of @self * * Clones the state of the given `GtkATContext`, using @role, @accessible, * and @display. @@ -710,7 +710,7 @@ gtk_at_context_update (GtkATContext *self) * gtk_at_context_set_accessible_state: * @self: a `GtkATContext` * @state: a `GtkAccessibleState` - * @value: (nullable): #GtkAccessibleValue + * @value: (nullable): `GtkAccessibleValue` * * Sets the @value for the given @state of a `GtkATContext`. * diff --git a/gtk/gtkbookmarklist.c b/gtk/gtkbookmarklist.c index 63e500a5af..08bd5f1bb5 100644 --- a/gtk/gtkbookmarklist.c +++ b/gtk/gtkbookmarklist.c @@ -489,7 +489,7 @@ gtk_bookmark_list_new (const char *filename, * Sets the @attributes to be enumerated and starts the enumeration. * * If @attributes is %NULL, no attributes will be queried, but a list - * of #GFileInfos will still be created. + * of `GFileInfo`s will still be created. */ void gtk_bookmark_list_set_attributes (GtkBookmarkList *self, diff --git a/gtk/gtkborder.c b/gtk/gtkborder.c index 434f38e864..443a90687e 100644 --- a/gtk/gtkborder.c +++ b/gtk/gtkborder.c @@ -29,10 +29,10 @@ /** * gtk_border_new: * - * Allocates a new #GtkBorder-struct and initializes its elements to zero. + * Allocates a new `GtkBorder` struct and initializes its elements to zero. * - * Returns: (transfer full): a newly allocated #GtkBorder-struct. - * Free with gtk_border_free() + * Returns: (transfer full): a newly allocated `GtkBorder` struct. + * Free with [method@Gtk.Border.free] */ GtkBorder * gtk_border_new (void) @@ -42,9 +42,9 @@ gtk_border_new (void) /** * gtk_border_copy: - * @border_: a #GtkBorder-struct + * @border_: a `GtkBorder` struct * - * Copies a #GtkBorder-struct. + * Copies a `GtkBorder`. * * Returns: (transfer full): a copy of @border_. */ @@ -58,9 +58,9 @@ gtk_border_copy (const GtkBorder *border_) /** * gtk_border_free: - * @border_: a #GtkBorder-struct + * @border_: a `GtkBorder` struct * - * Frees a #GtkBorder-struct. + * Frees a `GtkBorder`. */ void gtk_border_free (GtkBorder *border_) diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c index 1b384dac6c..1eb45c0308 100644 --- a/gtk/gtkbuildable.c +++ b/gtk/gtkbuildable.c @@ -49,7 +49,7 @@ gtk_buildable_default_init (GtkBuildableInterface *iface) /*< private > * gtk_buildable_set_buildable_id: - * @buildable: a #GtkBuildable + * @buildable: a `GtkBuildable` * @id: name to set * * Sets the ID of the @buildable object. @@ -162,7 +162,7 @@ gtk_buildable_parser_finished (GtkBuildable *buildable, * * Constructs a child of @buildable with the name @name. * - * #GtkBuilder calls this function if a “constructor” has been + * `GtkBuilder` calls this function if a “constructor” has been * specified in the UI definition. * * Returns: (transfer full): the constructed child @@ -190,7 +190,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable, * @builder: a `GtkBuilder` used to construct this object * @child: (nullable): child object or %NULL for non-child tags * @tagname: name of tag - * @parser: (out): a #GMarkupParser to fill in + * @parser: (out): a `GMarkupParser` to fill in * @data: (out): return location for user data that will be passed in * to parser functions * diff --git a/gtk/gtkbuildable.h b/gtk/gtkbuildable.h index e082706df1..0c005d71eb 100644 --- a/gtk/gtkbuildable.h +++ b/gtk/gtkbuildable.h @@ -115,7 +115,7 @@ struct _GtkBuildableParser * @custom_tag_start: Implement this if the buildable needs to parse * content below <child>. To handle an element, the implementation * must fill in the @parser and @user_data and return %TRUE. - * #GtkWidget implements this to parse accessible attributes specified + * `GtkWidget` implements this to parse accessible attributes specified * in <accessibility> elements. * Note that @user_data must be freed in @custom_tag_end or @custom_finished. * @custom_tag_end: Called for the end tag of each custom element that is @@ -124,8 +124,8 @@ struct _GtkBuildableParser * when the builder finishes parsing (see @custom_tag_start) * @parser_finished: Called when a builder finishes the parsing * of a UI definition. It is normally not necessary to implement this, - * unless you need to perform special cleanup actions. #GtkWindow sets - * the #GtkWidget:visible property here. + * unless you need to perform special cleanup actions. `GtkWindow` sets + * the `GtkWidget:visible` property here. * @get_internal_child: Returns an internal child of a buildable. * `GtkDialog` implements this to give access to its @vbox, making * it possible to add children to the vbox in a UI definition. @@ -147,8 +147,8 @@ struct _GtkBuildableIface /** * GtkBuildableIface::add_child: - * @buildable: a #GtkBuildable - * @builder: a #GtkBuilder + * @buildable: a `GtkBuildable` + * @builder: a `GtkBuilder` * @child: child to add * @type: (nullable): kind of child or %NULL * @@ -169,11 +169,11 @@ struct _GtkBuildableIface /** * GtkBuildableIface::custom_tag_start: - * @buildable: a #GtkBuildable - * @builder: a #GtkBuilder used to construct this object + * @buildable: a `GtkBuildable` + * @builder: a `GtkBuilder` used to construct this object * @child: (nullable): child object or %NULL for non-child tags * @tagname: name of tag - * @parser: (out): a #GtkBuildableParser to fill in + * @parser: (out): a `GtkBuildableParser` to fill in * @data: (out): return location for user data that will be passed in * to parser functions * @@ -190,8 +190,8 @@ struct _GtkBuildableIface gpointer *data); /** * GtkBuildableIface::custom_tag_end: - * @buildable: A #GtkBuildable - * @builder: #GtkBuilder used to construct this object + * @buildable: A `GtkBuildable` + * @builder: `GtkBuilder` used to construct this object * @child: (nullable): child object or %NULL for non-child tags * @tagname: name of tag * @data: user data that will be passed in to parser functions @@ -206,8 +206,8 @@ struct _GtkBuildableIface gpointer data); /** * GtkBuildableIface::custom_finished: - * @buildable: a #GtkBuildable - * @builder: a #GtkBuilder + * @buildable: a `GtkBuildable` + * @builder: a `GtkBuilder` * @child: (nullable): child object or %NULL for non-child tags * @tagname: the name of the tag * @data: user data created in custom_tag_start @@ -225,8 +225,8 @@ struct _GtkBuildableIface /** * GtkBuildableIface::get_internal_child: - * @buildable: a #GtkBuildable - * @builder: a #GtkBuilder + * @buildable: a `GtkBuildable` + * @builder: a `GtkBuilder` * @childname: name of child * * Retrieves the internal child called @childname of the @buildable object. diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c index cfb698fa40..dd867fc367 100644 --- a/gtk/gtkbuilder.c +++ b/gtk/gtkbuilder.c @@ -136,7 +136,7 @@ * been constructed by GTK as part of a composite widget, to set * properties on them or to add further children (e.g. the content area * of a `GtkDialog`). This can be achieved by setting the “internal-child” - * property of the `<child>` element to a true value. Note that #GtkBuilder + * property of the `<child>` element to a true value. Note that `GtkBuilder` * still requires an `<object>` element for the internal child, even if it * has already been constructed. * @@ -302,7 +302,7 @@ gtk_builder_class_init (GtkBuilderClass *klass) * The translation domain used when translating property values that * have been marked as translatable. * - * If the translation domain is %NULL, #GtkBuilder uses gettext(), + * If the translation domain is %NULL, `GtkBuilder` uses gettext(), * otherwise g_dgettext(). */ builder_props[PROP_TRANSLATION_DOMAIN] = @@ -2060,7 +2060,7 @@ error: * @builder: a `GtkBuilder` * @type: the `GType` of the value * @string: the string representation of the value - * @value: (out): the #GValue to store the result in + * @value: (out): the `GValue` to store the result in * @error: (nullable): return location for an error * * Demarshals a value from a string. @@ -2839,8 +2839,8 @@ gtk_builder_new_from_string (const char *string, /*< private > * _gtk_builder_prefix_error: - * @builder: a #GtkBuilder - * @context: the #GtkBuildableParseContext + * @builder: a `GtkBuilder` + * @context: the `GtkBuildableParseContext` * @error: an error * * Calls g_prefix_error() to prepend a filename:line:column marker @@ -2865,8 +2865,8 @@ _gtk_builder_prefix_error (GtkBuilder *builder, /*< private > * _gtk_builder_error_unhandled_tag: - * @builder: a #GtkBuilder - * @context: the #GtkBuildableParseContext + * @builder: a `GtkBuilder` + * @context: the `GtkBuildableParseContext` * @object: name of the object that is being handled * @element_name: name of the element whose start tag is being handled * @error: return location for the error @@ -2896,8 +2896,8 @@ _gtk_builder_error_unhandled_tag (GtkBuilder *builder, } /*< private > - * @builder: a #GtkBuilder - * @context: the #GtkBuildableParseContext + * @builder: a `GtkBuilder` + * @context: the `GtkBuildableParseContext` * @parent_name: the name of the expected parent element * @error: return location for an error * @@ -2963,7 +2963,7 @@ gtk_builder_lookup_object (GtkBuilder *builder, } /*< private > - * @builder: a #GtkBuilder + * @builder: a `GtkBuilder` * @name: object name to look up * @line: line number where @name was encountered * @col: column number where @name was encountered @@ -3005,7 +3005,7 @@ _gtk_builder_lookup_object (GtkBuilder *builder, /*< private > * _gtk_builder_lookup_failed: - * @GtkBuilder: a #GtkBuilder + * @GtkBuilder: a `GtkBuilder` * @error: return location for error * * Finds whether any object lookups have failed. diff --git a/gtk/gtkbuilder.h b/gtk/gtkbuilder.h index ed0043c8a8..2e02114116 100644 --- a/gtk/gtkbuilder.h +++ b/gtk/gtkbuilder.h @@ -42,18 +42,18 @@ typedef struct _GtkBuilderClass GtkBuilderClass; /** * GtkBuilderError: * @GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION: A type-func attribute didn’t name - * a function that returns a #GType. - * @GTK_BUILDER_ERROR_UNHANDLED_TAG: The input contained a tag that #GtkBuilder + * a function that returns a `GType`. + * @GTK_BUILDER_ERROR_UNHANDLED_TAG: The input contained a tag that `GtkBuilder` * can’t handle. * @GTK_BUILDER_ERROR_MISSING_ATTRIBUTE: An attribute that is required by - * #GtkBuilder was missing. - * @GTK_BUILDER_ERROR_INVALID_ATTRIBUTE: #GtkBuilder found an attribute that + * `GtkBuilder` was missing. + * @GTK_BUILDER_ERROR_INVALID_ATTRIBUTE: `GtkBuilder` found an attribute that * it doesn’t understand. - * @GTK_BUILDER_ERROR_INVALID_TAG: #GtkBuilder found a tag that + * @GTK_BUILDER_ERROR_INVALID_TAG: `GtkBuilder` found a tag that * it doesn’t understand. * @GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE: A required property value was * missing. - * @GTK_BUILDER_ERROR_INVALID_VALUE: #GtkBuilder couldn’t parse + * @GTK_BUILDER_ERROR_INVALID_VALUE: `GtkBuilder` couldn’t parse * some attribute value. * @GTK_BUILDER_ERROR_VERSION_MISMATCH: The input file requires a newer version * of GTK. @@ -69,7 +69,7 @@ typedef struct _GtkBuilderClass GtkBuilderClass; * `gmodule-export-2.0` pkgconfig module can fix this problem. * * Error codes that identify various errors that can occur while using - * #GtkBuilder. + * `GtkBuilder`. */ typedef enum { @@ -186,7 +186,7 @@ GClosure * gtk_builder_create_closure (GtkBuilder *builder, /** * GTK_BUILDER_WARN_INVALID_CHILD_TYPE: - * @object: the #GtkBuildable on which the warning occurred + * @object: the `GtkBuildable` on which the warning occurred * @type: the unexpected type value * * This macro should be used to emit a warning about and unexpected @type value diff --git a/gtk/gtkbuilderparser.c b/gtk/gtkbuilderparser.c index be030fd0a4..dcc8e75417 100644 --- a/gtk/gtkbuilderparser.c +++ b/gtk/gtkbuilderparser.c @@ -207,14 +207,14 @@ gtk_buildable_parse_context_parse (GtkBuildableParseContext *context, /** * gtk_buildable_parse_context_push: - * @context: a #GtkBuildableParseContext - * @parser: a #GtkBuildableParser - * @user_data: user data to pass to #GtkBuildableParser functions + * @context: a `GtkBuildableParseContext` + * @parser: a `GtkBuildableParser` + * @user_data: user data to pass to `GtkBuildableParser` functions * * Temporarily redirects markup data to a sub-parser. * * This function may only be called from the start_element handler of - * a #GtkBuildableParser. It must be matched with a corresponding call to + * a `GtkBuildableParser`. It must be matched with a corresponding call to * gtk_buildable_parse_context_pop() in the matching end_element handler * (except in the case that the parser aborts due to an error). * @@ -263,7 +263,7 @@ gtk_buildable_parse_context_push (GtkBuildableParseContext *context, /** * gtk_buildable_parse_context_pop: - * @context: a #GtkBuildableParseContext + * @context: a `GtkBuildableParseContext` * * Completes the process of a temporary sub-parser redirection. * @@ -301,7 +301,7 @@ gtk_buildable_parse_context_pop (GtkBuildableParseContext *context) /** * gtk_buildable_parse_context_get_element: - * @context: a #GtkBuildablParseContext + * @context: a `GtkBuildablParseContext` * * Retrieves the name of the currently open element. * @@ -321,11 +321,11 @@ gtk_buildable_parse_context_get_element (GtkBuildableParseContext *context) /** * gtk_buildable_parse_context_get_element_stack: - * @context: a #GtkBuildableParseContext + * @context: a `GtkBuildableParseContext` * * Retrieves the element stack from the internal state of the parser. * - * The returned #GPtrArray is an array of strings where the last item is + * The returned `GPtrArray` is an array of strings where the last item is * the currently open tag (as would be returned by * gtk_buildable_parse_context_get_element()) and the previous item is its * immediate parent. @@ -345,7 +345,7 @@ gtk_buildable_parse_context_get_element_stack (GtkBuildableParseContext *context /** * gtk_buildable_parse_context_get_position: - * @context: a #GtkBuildableParseContext + * @context: a `GtkBuildableParseContext` * @line_number: (out) (optional): return location for a line number * @char_number: (out) (optional): return location for a char-on-line number * diff --git a/gtk/gtkbuilderprecompile.c b/gtk/gtkbuilderprecompile.c index 4a06a2393e..a9b8ac164b 100644 --- a/gtk/gtkbuilderprecompile.c +++ b/gtk/gtkbuilderprecompile.c @@ -300,7 +300,7 @@ marshal_tree (GString *marshaled, * binary form that is more efficient to parse. This is a custom * format that is only supported by GtkBuilder. * - * returns: A #GByte with the precompiled data + * returns: A `GBytes` with the precompiled data **/ GBytes * _gtk_buildable_parser_precompile (const char *text, diff --git a/gtk/gtkbuilderscope.h b/gtk/gtkbuilderscope.h index fc5d9de14b..212555c527 100644 --- a/gtk/gtkbuilderscope.h +++ b/gtk/gtkbuilderscope.h @@ -51,15 +51,15 @@ typedef enum { /*< prefix=GTK_BUILDER_CLOSURE >*/ /** * GtkBuilderScopeInterface: - * @get_type_from_name: Try to lookup a #GType via the its name. See + * @get_type_from_name: Try to lookup a `GType` via the its name. See * gtk_builder_get_type_from_name() for more details. * The C implementation will use g_type_from_name() and if that fails try to guess the * correct function name for registering the type and then use dlsym() to load it. * The default implementation just tries g_type_from_name() and otherwise fails. - * @get_type_from_function: Try to lookup a #GType via the given function name, specified + * @get_type_from_function: Try to lookup a `GType` via the given function name, specified * explicitly in a GtkBuilder file, like via the "type-func" attribute in the "<object>" tag. * This function is very rarely used. - * The C implementation will use dlsym() and call the resulting function as a #GTypeFunc. + * The C implementation will use dlsym() and call the resulting function as a `GTypeFunc`. * The default implementation will fail and just return %G_TYPE_INVALID. * @create_closure: Create a closure with the given arguments. See gtk_builder_create_closure() * for more details on those. @@ -67,7 +67,7 @@ typedef enum { /*< prefix=GTK_BUILDER_CLOSURE >*/ * g_cclosure_new() to create a closure for the symbol. * The default implementation just fails and returns %NULL. * - * The virtual function table to implement for #GtkBuilderScope implementations. + * The virtual function table to implement for `GtkBuilderScope` implementations. * Default implementations for each function do exist, but they usually just fail, * so it is suggested that implementations implement all of them. */ diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c index a4360e1a78..41f70e05f3 100644 --- a/gtk/gtkcalendar.c +++ b/gtk/gtkcalendar.c @@ -1353,7 +1353,7 @@ gtk_calendar_new (void) /** * gtk_calendar_select_day: * @self: a `GtkCalendar`. - * @date: (transfer none): a #GDateTime representing the day to select + * @date: (transfer none): a `GDateTime` representing the day to select * * Switches to @date's year and month and select its day. */ @@ -1608,7 +1608,7 @@ gtk_calendar_unmark_day (GtkCalendar *calendar, * gtk_calendar_get_date: * @self: a `GtkCalendar` * - * Returns a #GDateTime representing the shown + * Returns a `GDateTime` representing the shown * year, month and the selected day. * * The returned date is in the local time zone. diff --git a/gtk/gtkcellarea.c b/gtk/gtkcellarea.c index 5d7c328606..a46d50900b 100644 --- a/gtk/gtkcellarea.c +++ b/gtk/gtkcellarea.c @@ -24,15 +24,15 @@ * * An abstract class for laying out GtkCellRenderers * - * The #GtkCellArea is an abstract class for #GtkCellLayout widgets + * The `GtkCellArea` is an abstract class for `GtkCellLayout` widgets * (also referred to as "layouting widgets") to interface with an - * arbitrary number of #GtkCellRenderers and interact with the user - * for a given #GtkTreeModel row. + * arbitrary number of `GtkCellRenderer`s and interact with the user + * for a given `GtkTreeModel` row. * * The cell area handles events, focus navigation, drawing and * size requests and allocations for a given row of data. * - * Usually users dont have to interact with the #GtkCellArea directly + * Usually users dont have to interact with the `GtkCellArea` directly * unless they are implementing a cell-layouting widget themselves. * * # Requesting area sizes @@ -41,13 +41,13 @@ * [GtkWidget’s geometry management section][geometry-management], * GTK uses a height-for-width * geometry management system to compute the sizes of widgets and user - * interfaces. #GtkCellArea uses the same semantics to calculate the - * size of an area for an arbitrary number of #GtkTreeModel rows. + * interfaces. `GtkCellArea` uses the same semantics to calculate the + * size of an area for an arbitrary number of `GtkTreeModel` rows. * * When requesting the size of a cell area one needs to calculate * the size for a handful of rows, and this will be done differently by - * different layouting widgets. For instance a #GtkTreeViewColumn - * always lines up the areas from top to bottom while a #GtkIconView + * different layouting widgets. For instance a `GtkTreeViewColumn` + * always lines up the areas from top to bottom while a `GtkIconView` * on the other hand might enforce that all areas received the same * width and wrap the areas around, requesting height for more cell * areas when allocated less width. @@ -55,23 +55,23 @@ * It’s also important for areas to maintain some cell * alignments with areas rendered for adjacent rows (cells can * appear “columnized” inside an area even when the size of - * cells are different in each row). For this reason the #GtkCellArea - * uses a #GtkCellAreaContext object to store the alignments + * cells are different in each row). For this reason the `GtkCellArea` + * uses a `GtkCellArea`Context object to store the alignments * and sizes along the way (as well as the overall largest minimum * and natural size for all the rows which have been calculated * with the said context). * - * The #GtkCellAreaContext is an opaque object specific to the - * #GtkCellArea which created it (see gtk_cell_area_create_context()). + * The `GtkCellArea`Context is an opaque object specific to the + * `GtkCellArea` which created it (see gtk_cell_area_create_context()). * The owning cell-layouting widget can create as many contexts as * it wishes to calculate sizes of rows which should receive the * same size in at least one orientation (horizontally or vertically), - * However, it’s important that the same #GtkCellAreaContext which - * was used to request the sizes for a given #GtkTreeModel row be + * However, it’s important that the same `GtkCellArea`Context which + * was used to request the sizes for a given `GtkTreeModel` row be * used when rendering or processing events for that row. * * In order to request the width of all the rows at the root level - * of a #GtkTreeModel one would do the following: + * of a `GtkTreeModel` one would do the following: * * |[<!-- language="C" --> * GtkTreeIter iter; @@ -93,17 +93,17 @@ * returned minimum and natural width of the area for each row * unless the cell-layouting object is actually interested in the * widths of individual rows. The overall width is however stored - * in the accompanying #GtkCellAreaContext object and can be consulted + * in the accompanying `GtkCellArea`Context object and can be consulted * at any time. * - * This can be useful since #GtkCellLayout widgets usually have to + * This can be useful since `GtkCellLayout` widgets usually have to * support requesting and rendering rows in treemodels with an - * exceedingly large amount of rows. The #GtkCellLayout widget in + * exceedingly large amount of rows. The `GtkCellLayout` widget in * that case would calculate the required width of the rows in an * idle or timeout source (see g_timeout_add()) and when the widget * is requested its actual width in [vfunc@Gtk.Widget.measure] * it can simply consult the width accumulated so far in the - * #GtkCellAreaContext object. + * `GtkCellArea`Context object. * * A simple example where rows are rendered from top to bottom and * take up the full width of the layouting widget would look like: @@ -127,17 +127,17 @@ * row sizes have been calculated (the amount of rows that Foo judged * was appropriate to request space for in a single timeout iteration) * before simply returning the amount of space required by the area via - * the #GtkCellAreaContext. + * the `GtkCellArea`Context. * * Requesting the height for width (or width for height) of an area is - * a similar task except in this case the #GtkCellAreaContext does not + * a similar task except in this case the `GtkCellArea`Context does not * store the data (actually, it does not know how much space the layouting * widget plans to allocate it for every row. It’s up to the layouting * widget to render each row of data with the appropriate height and - * width which was requested by the #GtkCellArea). + * width which was requested by the `GtkCellArea`). * * In order to request the height for width of all the rows at the - * root level of a #GtkTreeModel one would do the following: + * root level of a `GtkTreeModel` one would do the following: * * |[<!-- language="C" --> * GtkTreeIter iter; @@ -229,26 +229,26 @@ * * Passing events to the area is as simple as handling events on any * normal widget and then passing them to the gtk_cell_area_event() - * API as they come in. Usually #GtkCellArea is only interested in + * API as they come in. Usually `GtkCellArea` is only interested in * button events, however some customized derived areas can be implemented * who are interested in handling other events. Handling an event can - * trigger the #GtkCellArea::focus-changed signal to fire; as well as - * #GtkCellArea::add-editable in the case that an editable cell was + * trigger the `GtkCellArea`::focus-changed signal to fire; as well as + * `GtkCellArea`::add-editable in the case that an editable cell was * clicked and needs to start editing. You can call * gtk_cell_area_stop_editing() at any time to cancel any cell editing * that is currently in progress. * - * The #GtkCellArea drives keyboard focus from cell to cell in a way - * similar to #GtkWidget. For layouting widgets that support giving + * The `GtkCellArea` drives keyboard focus from cell to cell in a way + * similar to `GtkWidget`. For layouting widgets that support giving * focus to cells it’s important to remember to pass %GTK_CELL_RENDERER_FOCUSED * to the area functions for the row that has focus and to tell the * area to paint the focus at render time. * * Layouting widgets that accept focus on cells should implement the * [vfunc@Gtk.Widget.focus] virtual method. The layouting widget is always - * responsible for knowing where #GtkTreeModel rows are rendered inside + * responsible for knowing where `GtkTreeModel` rows are rendered inside * the widget, so at [vfunc@Gtk.Widget.focus] time the layouting widget - * should use the #GtkCellArea methods to navigate focus inside the area + * should use the `GtkCellArea` methods to navigate focus inside the area * and then observe the GtkDirectionType to pass the focus to adjacent * rows and areas. * @@ -318,13 +318,13 @@ * * # Cell Properties * - * The #GtkCellArea introduces cell properties for #GtkCellRenderers. + * The `GtkCellArea` introduces cell properties for `GtkCellRenderer`s. * This provides some general interfaces for defining the relationship - * cell areas have with their cells. For instance in a #GtkCellAreaBox + * cell areas have with their cells. For instance in a `GtkCellArea`Box * a cell might “expand” and receive extra space when the area is allocated * more than its full natural request, or a cell might be configured to “align” * with adjacent rows which were requested and rendered with the same - * #GtkCellAreaContext. + * `GtkCellArea`Context. * * Use gtk_cell_area_class_install_cell_property() to install cell * properties for a cell area class and gtk_cell_area_class_find_cell_property() @@ -671,9 +671,9 @@ gtk_cell_area_class_init (GtkCellAreaClass *class) /* Signals */ /** * GtkCellArea::apply-attributes: - * @area: the #GtkCellArea to apply the attributes to - * @model: the #GtkTreeModel to apply the attributes from - * @iter: the #GtkTreeIter indicating which row to apply the attributes of + * @area: the `GtkCellArea` to apply the attributes to + * @model: the `GtkTreeModel` to apply the attributes from + * @iter: the `GtkTreeIter` indicating which row to apply the attributes of * @is_expander: whether the view shows children for this row * @is_expanded: whether the view is currently showing the children of this row * @@ -696,12 +696,12 @@ gtk_cell_area_class_init (GtkCellAreaClass *class) /** * GtkCellArea::add-editable: - * @area: the #GtkCellArea where editing started - * @renderer: the #GtkCellRenderer that started the edited - * @editable: the #GtkCellEditable widget to add - * @cell_area: the #GtkWidget relative #GdkRectangle coordinates + * @area: the `GtkCellArea` where editing started + * @renderer: the `GtkCellRenderer` that started the edited + * @editable: the `GtkCellEditable` widget to add + * @cell_area: the `GtkWidget` relative `GdkRectangle` coordinates * where @editable should be added - * @path: the #GtkTreePath string this edit was initiated for + * @path: the `GtkTreePath` string this edit was initiated for * * Indicates that editing has started on @renderer and that @editable * should be added to the owning cell-layouting widget at @cell_area. @@ -722,9 +722,9 @@ gtk_cell_area_class_init (GtkCellAreaClass *class) /** * GtkCellArea::remove-editable: - * @area: the #GtkCellArea where editing finished - * @renderer: the #GtkCellRenderer that finished editeding - * @editable: the #GtkCellEditable widget to remove + * @area: the `GtkCellArea` where editing finished + * @renderer: the `GtkCellRenderer` that finished editeding + * @editable: the `GtkCellEditable` widget to remove * * Indicates that editing finished on @renderer and that @editable * should be removed from the owning cell-layouting widget. @@ -742,9 +742,9 @@ gtk_cell_area_class_init (GtkCellAreaClass *class) /** * GtkCellArea::focus-changed: - * @area: the #GtkCellArea where focus changed - * @renderer: the #GtkCellRenderer that has focus - * @path: the current #GtkTreePath string set for @area + * @area: the `GtkCellArea` where focus changed + * @renderer: the `GtkCellRenderer` that has focus + * @path: the current `GtkTreePath` string set for @area * * Indicates that focus changed on this @area. This signal * is emitted either as a result of focus handling or event @@ -1590,8 +1590,8 @@ gtk_cell_area_buildable_custom_tag_end (GtkBuildable *buildable, /** * gtk_cell_area_add: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to add to @area + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to add to @area * * Adds @renderer to @area with the default child cell properties. */ @@ -1607,8 +1607,8 @@ gtk_cell_area_add (GtkCellArea *area, /** * gtk_cell_area_remove: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to remove from @area + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to remove from @area * * Removes @renderer from @area. */ @@ -1659,8 +1659,8 @@ get_has_renderer (GtkCellRenderer *renderer, /** * gtk_cell_area_has_renderer: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to check + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to check * * Checks if @area contains @renderer. * @@ -1682,11 +1682,11 @@ gtk_cell_area_has_renderer (GtkCellArea *area, /** * gtk_cell_area_foreach: - * @area: a #GtkCellArea - * @callback: (scope call): the #GtkCellCallback to call + * @area: a `GtkCellArea` + * @callback: (scope call): the `GtkCellCallback` to call * @callback_data: user provided data pointer * - * Calls @callback for every #GtkCellRenderer in @area. + * Calls @callback for every `GtkCellRenderer` in @area. */ void gtk_cell_area_foreach (GtkCellArea *area, @@ -1701,15 +1701,15 @@ gtk_cell_area_foreach (GtkCellArea *area, /** * gtk_cell_area_foreach_alloc: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext for this row of data. - * @widget: the #GtkWidget that @area is rendering to + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context for this row of data. + * @widget: the `GtkWidget` that @area is rendering to * @cell_area: the @widget relative coordinates and size for @area * @background_area: the @widget relative coordinates of the background area - * @callback: (scope call): the #GtkCellAllocCallback to call + * @callback: (scope call): the `GtkCellAllocCallback` to call * @callback_data: user provided data pointer * - * Calls @callback for every #GtkCellRenderer in @area with the + * Calls @callback for every `GtkCellRenderer` in @area with the * allocated rectangle inside @cell_area. */ void @@ -1734,14 +1734,14 @@ gtk_cell_area_foreach_alloc (GtkCellArea *area, /** * gtk_cell_area_event: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext for this row of data. - * @widget: the #GtkWidget that @area is rendering to - * @event: the #GdkEvent to handle + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context for this row of data. + * @widget: the `GtkWidget` that @area is rendering to + * @event: the `GdkEvent` to handle * @cell_area: the @widget relative coordinates for @area - * @flags: the #GtkCellRendererState for @area in this row. + * @flags: the `GtkCellRenderer`State for @area in this row. * - * Delegates event handling to a #GtkCellArea. + * Delegates event handling to a `GtkCellArea`. * * Returns: %TRUE if the event was handled by @area. */ @@ -1773,13 +1773,13 @@ gtk_cell_area_event (GtkCellArea *area, /** * gtk_cell_area_snapshot: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext for this row of data. - * @widget: the #GtkWidget that @area is rendering to - * @snapshot: the #GtkSnapshot to draw to + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context for this row of data. + * @widget: the `GtkWidget` that @area is rendering to + * @snapshot: the `GtkSnapshot` to draw to * @background_area: the @widget relative coordinates for @area’s background * @cell_area: the @widget relative coordinates for @area - * @flags: the #GtkCellRendererState for @area in this row. + * @flags: the `GtkCellRenderer`State for @area in this row. * @paint_focus: whether @area should paint focus on focused cells for focused rows or not. * * Snapshots @area’s cells according to @area’s layout onto at @@ -1827,10 +1827,10 @@ get_cell_allocation (GtkCellRenderer *renderer, /** * gtk_cell_area_get_cell_allocation: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext used to hold sizes for @area. - * @widget: the #GtkWidget that @area is rendering on - * @renderer: the #GtkCellRenderer to get the allocation for + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context used to hold sizes for @area. + * @widget: the `GtkWidget` that @area is rendering on + * @renderer: the `GtkCellRenderer` to get the allocation for * @cell_area: the whole allocated area for @area in @widget * for this row * @allocation: (out): where to store the allocation for @renderer @@ -1879,9 +1879,9 @@ get_cell_by_position (GtkCellRenderer *renderer, /** * gtk_cell_area_get_cell_at_position: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext used to hold sizes for @area. - * @widget: the #GtkWidget that @area is rendering on + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context used to hold sizes for @area. + * @widget: the `GtkWidget` that @area is rendering on * @cell_area: the whole allocated area for @area in @widget * for this row * @x: the x position @@ -1889,10 +1889,10 @@ get_cell_by_position (GtkCellRenderer *renderer, * @alloc_area: (out) (optional): where to store the inner allocated area of the * returned cell renderer * - * Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally + * Gets the `GtkCellRenderer` at @x and @y coordinates inside @area and optionally * returns the full cell allocation for it inside @cell_area. * - * Returns: (transfer none): the #GtkCellRenderer at @x and @y. + * Returns: (transfer none): the `GtkCellRenderer` at @x and @y. */ GtkCellRenderer * gtk_cell_area_get_cell_at_position (GtkCellArea *area, @@ -1926,16 +1926,16 @@ gtk_cell_area_get_cell_at_position (GtkCellArea *area, *************************************************************/ /** * gtk_cell_area_create_context: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * - * Creates a #GtkCellAreaContext to be used with @area for - * all purposes. #GtkCellAreaContext stores geometry information + * Creates a `GtkCellArea`Context to be used with @area for + * all purposes. `GtkCellArea`Context stores geometry information * for rows for which it was operated on, it is important to use * the same context for the same row of data at all times (i.e. - * one should render and handle events with the same #GtkCellAreaContext + * one should render and handle events with the same `GtkCellArea`Context * which was used to request the size of those rows of data). * - * Returns: (transfer full): a newly created #GtkCellAreaContext which can be used with @area. + * Returns: (transfer full): a newly created `GtkCellArea`Context which can be used with @area. */ GtkCellAreaContext * gtk_cell_area_create_context (GtkCellArea *area) @@ -1947,22 +1947,22 @@ gtk_cell_area_create_context (GtkCellArea *area) /** * gtk_cell_area_copy_context: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext to copy + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context to copy * * This is sometimes needed for cases where rows need to share * alignments in one orientation but may be separately grouped * in the opposing orientation. * - * For instance, #GtkIconView creates all icons (rows) to have + * For instance, `GtkIconView` creates all icons (rows) to have * the same width and the cells theirin to have the same * horizontal alignments. However each row of icons may have - * a separate collective height. #GtkIconView uses this to + * a separate collective height. `GtkIconView` uses this to * request the heights of each row based on a context which * was already used to request all the row widths that are * to be displayed. * - * Returns: (transfer full): a newly created #GtkCellAreaContext copy of @context. + * Returns: (transfer full): a newly created `GtkCellArea`Context copy of @context. */ GtkCellAreaContext * gtk_cell_area_copy_context (GtkCellArea *area, @@ -1976,12 +1976,12 @@ gtk_cell_area_copy_context (GtkCellArea *area, /** * gtk_cell_area_get_request_mode: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * * Gets whether the area prefers a height-for-width layout * or a width-for-height layout. * - * Returns: The #GtkSizeRequestMode preferred by @area. + * Returns: The `GtkSizeRequestMode` preferred by @area. */ GtkSizeRequestMode gtk_cell_area_get_request_mode (GtkCellArea *area) @@ -1994,9 +1994,9 @@ gtk_cell_area_get_request_mode (GtkCellArea *area) /** * gtk_cell_area_get_preferred_width: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext to perform this request with - * @widget: the #GtkWidget where @area will be rendering + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context to perform this request with + * @widget: the `GtkWidget` where @area will be rendering * @minimum_width: (out) (optional): location to store the minimum width * @natural_width: (out) (optional): location to store the natural width * @@ -2024,9 +2024,9 @@ gtk_cell_area_get_preferred_width (GtkCellArea *area, /** * gtk_cell_area_get_preferred_height_for_width: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext which has already been requested for widths. - * @widget: the #GtkWidget where @area will be rendering + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context which has already been requested for widths. + * @widget: the `GtkWidget` where @area will be rendering * @width: the width for which to check the height of this area * @minimum_height: (out) (optional): location to store the minimum height * @natural_height: (out) (optional): location to store the natural height @@ -2066,9 +2066,9 @@ gtk_cell_area_get_preferred_height_for_width (GtkCellArea *area, /** * gtk_cell_area_get_preferred_height: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext to perform this request with - * @widget: the #GtkWidget where @area will be rendering + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context to perform this request with + * @widget: the `GtkWidget` where @area will be rendering * @minimum_height: (out) (optional): location to store the minimum height * @natural_height: (out) (optional): location to store the natural height * @@ -2096,9 +2096,9 @@ gtk_cell_area_get_preferred_height (GtkCellArea *area, /** * gtk_cell_area_get_preferred_width_for_height: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext which has already been requested for widths. - * @widget: the #GtkWidget where @area will be rendering + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context which has already been requested for widths. + * @widget: the `GtkWidget` where @area will be rendering * @height: the height for which to check the width of this area * @minimum_width: (out) (optional): location to store the minimum width * @natural_width: (out) (optional): location to store the natural width @@ -2141,13 +2141,13 @@ gtk_cell_area_get_preferred_width_for_height (GtkCellArea *area, /** * gtk_cell_area_attribute_connect: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to connect an attribute for + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to connect an attribute for * @attribute: the attribute name - * @column: the #GtkTreeModel column to fetch attribute values from + * @column: the `GtkTreeModel` column to fetch attribute values from * * Connects an @attribute to apply values from @column for the - * #GtkTreeModel in use. + * `GtkTreeModel` in use. */ void gtk_cell_area_attribute_connect (GtkCellArea *area, @@ -2207,8 +2207,8 @@ gtk_cell_area_attribute_connect (GtkCellArea *area, /** * gtk_cell_area_attribute_disconnect: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to disconnect an attribute for + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to disconnect an attribute for * @attribute: the attribute name * * Disconnects @attribute for the @renderer in @area so that @@ -2249,8 +2249,8 @@ gtk_cell_area_attribute_disconnect (GtkCellArea *area, /** * gtk_cell_area_attribute_get_column: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` * @attribute: an attribute on the renderer * * Returns the model column that an attribute has been mapped to, @@ -2286,9 +2286,9 @@ gtk_cell_area_attribute_get_column (GtkCellArea *area, /** * gtk_cell_area_apply_attributes: - * @area: a #GtkCellArea - * @tree_model: the #GtkTreeModel to pull values from - * @iter: the #GtkTreeIter in @tree_model to apply values for + * @area: a `GtkCellArea` + * @tree_model: the `GtkTreeModel` to pull values from + * @iter: the `GtkTreeIter` in @tree_model to apply values for * @is_expander: whether @iter has children * @is_expanded: whether @iter is expanded in the view and * children are visible @@ -2313,15 +2313,15 @@ gtk_cell_area_apply_attributes (GtkCellArea *area, /** * gtk_cell_area_get_current_path_string: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * - * Gets the current #GtkTreePath string for the currently - * applied #GtkTreeIter, this is implicitly updated when + * Gets the current `GtkTreePath` string for the currently + * applied `GtkTreeIter`, this is implicitly updated when * gtk_cell_area_apply_attributes() is called and can be - * used to interact with renderers from #GtkCellArea + * used to interact with renderers from `GtkCellArea` * subclasses. * - * Returns: The current #GtkTreePath string for the current + * Returns: The current `GtkTreePath` string for the current * attributes applied to @area. This string belongs to the area and * should not be freed. */ @@ -2341,9 +2341,9 @@ gtk_cell_area_get_current_path_string (GtkCellArea *area) *************************************************************/ /** * gtk_cell_area_class_install_cell_property: - * @aclass: a #GtkCellAreaClass + * @aclass: a `GtkCellAreaClass` * @property_id: the id for the property - * @pspec: the #GParamSpec for the property + * @pspec: the `GParamSpec` for the property * * Installs a cell property on a cell area class. */ @@ -2376,12 +2376,12 @@ gtk_cell_area_class_install_cell_property (GtkCellAreaClass *aclass, /** * gtk_cell_area_class_find_cell_property: - * @aclass: a #GtkCellAreaClass + * @aclass: a `GtkCellAreaClass` * @property_name: the name of the child property to find * * Finds a cell property of a cell area class by name. * - * Returns: (nullable) (transfer none): the #GParamSpec of the child property + * Returns: (transfer none): the `GParamSpec` of the child property */ GParamSpec* gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass, @@ -2398,13 +2398,13 @@ gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass, /** * gtk_cell_area_class_list_cell_properties: - * @aclass: a #GtkCellAreaClass + * @aclass: a `GtkCellAreaClass` * @n_properties: (out): location to return the number of cell properties found * * Returns all cell properties of a cell area class. * * Returns: (array length=n_properties) (transfer container): a newly - * allocated %NULL-terminated array of #GParamSpec*. The array + * allocated %NULL-terminated array of `GParamSpec`*. The array * must be freed with g_free(). */ GParamSpec** @@ -2427,8 +2427,8 @@ gtk_cell_area_class_list_cell_properties (GtkCellAreaClass *aclass, /** * gtk_cell_area_add_with_properties: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer to be placed inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` to be placed inside @area * @first_prop_name: the name of the first cell property to set * @...: a %NULL-terminated list of property names and values, starting * with @first_prop_name @@ -2466,8 +2466,8 @@ gtk_cell_area_add_with_properties (GtkCellArea *area, /** * gtk_cell_area_cell_set: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer which is a cell inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` which is a cell inside @area * @first_prop_name: the name of the first cell property to set * @...: a %NULL-terminated list of property names and values, starting * with @first_prop_name @@ -2492,8 +2492,8 @@ gtk_cell_area_cell_set (GtkCellArea *area, /** * gtk_cell_area_cell_get: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer which is inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` which is inside @area * @first_prop_name: the name of the first cell property to get * @...: return location for the first cell property, followed * optionally by more name/return location pairs, followed by %NULL @@ -2563,8 +2563,8 @@ area_set_cell_property (GtkCellArea *area, /** * gtk_cell_area_cell_set_valist: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer which inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` which inside @area * @first_property_name: the name of the first cell property to set * @var_args: a %NULL-terminated list of property names and values, starting * with @first_prop_name @@ -2623,8 +2623,8 @@ gtk_cell_area_cell_set_valist (GtkCellArea *area, /** * gtk_cell_area_cell_get_valist: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` inside @area * @first_property_name: the name of the first property to get * @var_args: return location for the first property, followed * optionally by more name/return location pairs, followed by %NULL @@ -2681,8 +2681,8 @@ gtk_cell_area_cell_get_valist (GtkCellArea *area, /** * gtk_cell_area_cell_set_property: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` inside @area * @property_name: the name of the cell property to set * @value: the value to set the cell property to * @@ -2717,8 +2717,8 @@ gtk_cell_area_cell_set_property (GtkCellArea *area, /** * gtk_cell_area_cell_get_property: - * @area: a #GtkCellArea - * @renderer: a #GtkCellRenderer inside @area + * @area: a `GtkCellArea` + * @renderer: a `GtkCellRenderer` inside @area * @property_name: the name of the property to get * @value: a location to return the value * @@ -2786,7 +2786,7 @@ gtk_cell_area_cell_get_property (GtkCellArea *area, /** * gtk_cell_area_is_activatable: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * * Returns whether the area can do anything when activated, * after applying new attributes to @area. @@ -2803,14 +2803,14 @@ gtk_cell_area_is_activatable (GtkCellArea *area) /** * gtk_cell_area_focus: - * @area: a #GtkCellArea - * @direction: the #GtkDirectionType + * @area: a `GtkCellArea` + * @direction: the `GtkDirectionType` * * This should be called by the @area’s owning layout widget * when focus is to be passed to @area, or moved within @area * for a given @direction and row data. * - * Implementing #GtkCellArea classes should implement this + * Implementing `GtkCellArea` classes should implement this * method to receive and navigate focus in its own way particular * to how it lays out cells. * @@ -2827,11 +2827,11 @@ gtk_cell_area_focus (GtkCellArea *area, /** * gtk_cell_area_activate: - * @area: a #GtkCellArea - * @context: the #GtkCellAreaContext in context with the current row data - * @widget: the #GtkWidget that @area is rendering on + * @area: a `GtkCellArea` + * @context: the `GtkCellArea`Context in context with the current row data + * @widget: the `GtkWidget` that @area is rendering on * @cell_area: the size and location of @area relative to @widget’s allocation - * @flags: the #GtkCellRendererState flags for @area for this row of data. + * @flags: the `GtkCellRenderer`State flags for @area for this row of data. * @edit_only: if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE * will be activated. * @@ -2857,13 +2857,13 @@ gtk_cell_area_activate (GtkCellArea *area, /** * gtk_cell_area_set_focus_cell: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to give focus to + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to give focus to * * Explicitly sets the currently focused cell to @renderer. * * This is generally called by implementations of - * #GtkCellAreaClass.focus() or #GtkCellAreaClass.event(), + * `GtkCellAreaClass.focus()` or `GtkCellAreaClass.event()`, * however it can also be used to implement functions such * as gtk_tree_view_set_cursor_on_cell(). */ @@ -2899,7 +2899,7 @@ gtk_cell_area_set_focus_cell (GtkCellArea *area, /** * gtk_cell_area_get_focus_cell: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * * Retrieves the currently focused cell for @area * @@ -2922,9 +2922,9 @@ gtk_cell_area_get_focus_cell (GtkCellArea *area) /** * gtk_cell_area_add_focus_sibling: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer expected to have focus - * @sibling: the #GtkCellRenderer to add to @renderer’s focus area + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` expected to have focus + * @sibling: the `GtkCellRenderer` to add to @renderer’s focus area * * Adds @sibling to @renderer’s focusable area, focus will be drawn * around @renderer and all of its siblings if @renderer can @@ -2969,9 +2969,9 @@ gtk_cell_area_add_focus_sibling (GtkCellArea *area, /** * gtk_cell_area_remove_focus_sibling: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer expected to have focus - * @sibling: the #GtkCellRenderer to remove from @renderer’s focus area + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` expected to have focus + * @sibling: the `GtkCellRenderer` to remove from @renderer’s focus area * * Removes @sibling from @renderer’s focus sibling list * (see gtk_cell_area_add_focus_sibling()). @@ -3002,9 +3002,9 @@ gtk_cell_area_remove_focus_sibling (GtkCellArea *area, /** * gtk_cell_area_is_focus_sibling: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer expected to have focus - * @sibling: the #GtkCellRenderer to check against @renderer’s sibling list + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` expected to have focus + * @sibling: the `GtkCellRenderer` to check against @renderer’s sibling list * * Returns whether @sibling is one of @renderer’s focus siblings * (see gtk_cell_area_add_focus_sibling()). @@ -3038,12 +3038,12 @@ gtk_cell_area_is_focus_sibling (GtkCellArea *area, /** * gtk_cell_area_get_focus_siblings: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer expected to have focus + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` expected to have focus * * Gets the focus sibling cell renderers for @renderer. * - * Returns: (element-type GtkCellRenderer) (transfer none): A #GList of #GtkCellRenderers. + * Returns: (element-type GtkCellRenderer) (transfer none): A `GList` of `GtkCellRenderer`s. * The returned list is internal and should not be freed. */ const GList * @@ -3060,19 +3060,19 @@ gtk_cell_area_get_focus_siblings (GtkCellArea *area, /** * gtk_cell_area_get_focus_from_sibling: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` * - * Gets the #GtkCellRenderer which is expected to be focusable + * Gets the `GtkCellRenderer` which is expected to be focusable * for which @renderer is, or may be a sibling. * - * This is handy for #GtkCellArea subclasses when handling events, + * This is handy for `GtkCellArea` subclasses when handling events, * after determining the renderer at the event location it can * then chose to activate the focus cell for which the event * cell may have been a sibling. * - * Returns: (nullable) (transfer none): the #GtkCellRenderer for which @renderer - * is a sibling + * Returns: (nullable) (transfer none): the `GtkCellRenderer` + * for which @renderer is a sibling */ GtkCellRenderer * gtk_cell_area_get_focus_from_sibling (GtkCellArea *area, @@ -3206,12 +3206,12 @@ gtk_cell_area_set_edit_widget (GtkCellArea *area, /** * gtk_cell_area_get_edited_cell: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * - * Gets the #GtkCellRenderer in @area that is currently + * Gets the `GtkCellRenderer` in @area that is currently * being edited. * - * Returns: (transfer none): The currently edited #GtkCellRenderer + * Returns: (transfer none): The currently edited `GtkCellRenderer` */ GtkCellRenderer * gtk_cell_area_get_edited_cell (GtkCellArea *area) @@ -3225,12 +3225,12 @@ gtk_cell_area_get_edited_cell (GtkCellArea *area) /** * gtk_cell_area_get_edit_widget: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * - * Gets the #GtkCellEditable widget currently used + * Gets the `GtkCellEditable` widget currently used * to edit the currently edited cell. * - * Returns: (transfer none): The currently active #GtkCellEditable widget + * Returns: (transfer none): The currently active `GtkCellEditable` widget */ GtkCellEditable * gtk_cell_area_get_edit_widget (GtkCellArea *area) @@ -3244,16 +3244,16 @@ gtk_cell_area_get_edit_widget (GtkCellArea *area) /** * gtk_cell_area_activate_cell: - * @area: a #GtkCellArea - * @widget: the #GtkWidget that @area is rendering onto - * @renderer: the #GtkCellRenderer in @area to activate - * @event: the #GdkEvent for which cell activation should occur - * @cell_area: the #GdkRectangle in @widget relative coordinates + * @area: a `GtkCellArea` + * @widget: the `GtkWidget` that @area is rendering onto + * @renderer: the `GtkCellRenderer` in @area to activate + * @event: the `GdkEvent` for which cell activation should occur + * @cell_area: the `GdkRectangle` in @widget relative coordinates * of @renderer for the current row. - * @flags: the #GtkCellRendererState for @renderer + * @flags: the `GtkCellRenderer`State for @renderer * - * This is used by #GtkCellArea subclasses when handling events - * to activate cells, the base #GtkCellArea class activates cells + * This is used by `GtkCellArea` subclasses when handling events + * to activate cells, the base `GtkCellArea` class activates cells * for keyboard events for free in its own GtkCellArea->activate() * implementation. * @@ -3340,7 +3340,7 @@ gtk_cell_area_activate_cell (GtkCellArea *area, /** * gtk_cell_area_stop_editing: - * @area: a #GtkCellArea + * @area: a `GtkCellArea` * @canceled: whether editing was canceled. * * Explicitly stops the editing of the currently edited cell. @@ -3394,14 +3394,14 @@ gtk_cell_area_stop_editing (GtkCellArea *area, /** * gtk_cell_area_inner_cell_area: - * @area: a #GtkCellArea - * @widget: the #GtkWidget that @area is rendering onto + * @area: a `GtkCellArea` + * @widget: the `GtkWidget` that @area is rendering onto * @cell_area: the @widget relative coordinates where one of @area’s cells * is to be placed * @inner_area: (out): the return location for the inner cell area * - * This is a convenience function for #GtkCellArea implementations - * to get the inner area where a given #GtkCellRenderer will be + * This is a convenience function for `GtkCellArea` implementations + * to get the inner area where a given `GtkCellRenderer` will be * rendered. It removes any padding previously added by gtk_cell_area_request_renderer(). */ void @@ -3431,16 +3431,16 @@ gtk_cell_area_inner_cell_area (GtkCellArea *area, /** * gtk_cell_area_request_renderer: - * @area: a #GtkCellArea - * @renderer: the #GtkCellRenderer to request size for - * @orientation: the #GtkOrientation in which to request size - * @widget: the #GtkWidget that @area is rendering onto + * @area: a `GtkCellArea` + * @renderer: the `GtkCellRenderer` to request size for + * @orientation: the `GtkOrientation` in which to request size + * @widget: the `GtkWidget` that @area is rendering onto * @for_size: the allocation contextual size to request for, or -1 if * the base request for the orientation is to be returned. * @minimum_size: (out) (optional): location to store the minimum size * @natural_size: (out) (optional): location to store the natural size * - * This is a convenience function for #GtkCellArea implementations + * This is a convenience function for `GtkCellArea` implementations * to request size for cell renderers. It’s important to use this * function to request size and then use gtk_cell_area_inner_cell_area() * at render and event time since this function will add padding diff --git a/gtk/gtkcellarea.h b/gtk/gtkcellarea.h index 0046f6e3e4..1ec3bc429e 100644 --- a/gtk/gtkcellarea.h +++ b/gtk/gtkcellarea.h @@ -45,10 +45,10 @@ typedef struct _GtkCellAreaContext GtkCellAreaContext; /** * GTK_CELL_AREA_WARN_INVALID_CELL_PROPERTY_ID: - * @object: the #GObject on which set_cell_property() or get_cell_property() + * @object: the `GObject` on which set_cell_property() or get_cell_property() * was called * @property_id: the numeric id of the property - * @pspec: the #GParamSpec of the property + * @pspec: the `GParamSpec` of the property * * This macro should be used to emit a standard warning about unexpected * properties in set_cell_property() and get_cell_property() implementations. @@ -62,7 +62,7 @@ typedef struct _GtkCellAreaContext GtkCellAreaContext; * @data: (closure): user-supplied data * * The type of the callback functions used for iterating over - * the cell renderers of a #GtkCellArea, see gtk_cell_area_foreach(). + * the cell renderers of a `GtkCellArea`, see gtk_cell_area_foreach(). * * Returns: %TRUE to stop iterating over cells. */ @@ -79,7 +79,7 @@ typedef gboolean (*GtkCellCallback) (GtkCellRenderer *renderer, * @data: (closure): user-supplied data * * The type of the callback functions used for iterating over the - * cell renderers and their allocated areas inside a #GtkCellArea, + * cell renderers and their allocated areas inside a `GtkCellArea`, * see gtk_cell_area_foreach_alloc(). * * Returns: %TRUE to stop iterating over cells. @@ -99,73 +99,73 @@ struct _GtkCellArea /** * GtkCellAreaClass: - * @add: adds a #GtkCellRenderer to the area. - * @remove: removes a #GtkCellRenderer from the area. - * @foreach: calls the #GtkCellCallback function on every #GtkCellRenderer in + * @add: adds a `GtkCellRenderer` to the area. + * @remove: removes a `GtkCellRenderer` from the area. + * @foreach: calls the `GtkCellCallback` function on every `GtkCellRenderer` in * the area with the provided user data until the callback returns %TRUE. - * @foreach_alloc: Calls the #GtkCellAllocCallback function on every - * #GtkCellRenderer in the area with the allocated area for the cell + * @foreach_alloc: Calls the `GtkCellAllocCallback` function on every + * `GtkCellRenderer` in the area with the allocated area for the cell * and the provided user data until the callback returns %TRUE. * @event: Handle an event in the area, this is generally used to activate * a cell at the event location for button events but can also be used - * to generically pass events to #GtkWidgets drawn onto the area. + * to generically pass events to `GtkWidget`s drawn onto the area. * @snapshot: Actually snapshot the area’s cells to the specified rectangle, * @background_area should be correctly distributed to the cells * corresponding background areas. * @apply_attributes: Apply the cell attributes to the cells. This is - * implemented as a signal and generally #GtkCellArea subclasses don't + * implemented as a signal and generally `GtkCellArea` subclasses don't * need to implement it since it is handled by the base class. - * @create_context: Creates and returns a class specific #GtkCellAreaContext - * to store cell alignment and allocation details for a said #GtkCellArea + * @create_context: Creates and returns a class specific `GtkCellAreaContext` + * to store cell alignment and allocation details for a said `GtkCellArea` * class. - * @copy_context: Creates a new #GtkCellAreaContext in the same state as + * @copy_context: Creates a new `GtkCellAreaContext` in the same state as * the passed @context with any cell alignment data and allocations intact. * @get_request_mode: This allows an area to tell its layouting widget whether * it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode. * @get_preferred_width: Calculates the minimum and natural width of the * areas cells with the current attributes applied while considering - * the particular layouting details of the said #GtkCellArea. While + * the particular layouting details of the said `GtkCellArea`. While * requests are performed over a series of rows, alignments and overall * minimum and natural sizes should be stored in the corresponding - * #GtkCellAreaContext. + * `GtkCellAreaContext`. * @get_preferred_height_for_width: Calculates the minimum and natural height * for the area if the passed @context would be allocated the given width. * When implementing this virtual method it is safe to assume that @context - * has already stored the aligned cell widths for every #GtkTreeModel row + * has already stored the aligned cell widths for every `GtkTreeModel` row * that @context will be allocated for since this information was stored - * at #GtkCellAreaClass.get_preferred_width() time. This virtual method + * at `GtkCellAreaClass.get_preferred_width()` time. This virtual method * should also store any necessary alignments of cell heights for the * case that the context is allocated a height. * @get_preferred_height: Calculates the minimum and natural height of the * areas cells with the current attributes applied. Essentially this is - * the same as #GtkCellAreaClass.get_preferred_width() only for areas + * the same as `GtkCellAreaClass.get_preferred_width()` only for areas * that are being requested as %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. * @get_preferred_width_for_height: Calculates the minimum and natural width * for the area if the passed @context would be allocated the given - * height. The same as #GtkCellAreaClass.get_preferred_height_for_width() + * height. The same as `GtkCellAreaClass.get_preferred_height_for_width()` * only for handling requests in the %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT * mode. * @set_cell_property: This should be implemented to handle changes in child - * cell properties for a given #GtkCellRenderer that were previously - * installed on the #GtkCellAreaClass with gtk_cell_area_class_install_cell_property(). + * cell properties for a given `GtkCellRenderer` that were previously + * installed on the `GtkCellAreaClass` with gtk_cell_area_class_install_cell_property(). * @get_cell_property: This should be implemented to report the values of - * child cell properties for a given child #GtkCellRenderer. + * child cell properties for a given child `GtkCellRenderer`. * @focus: This virtual method should be implemented to navigate focus from - * cell to cell inside the #GtkCellArea. The #GtkCellArea should move + * cell to cell inside the `GtkCellArea`. The `GtkCellArea` should move * focus from cell to cell inside the area and return %FALSE if focus * logically leaves the area with the following exceptions: When the * area contains no activatable cells, the entire area receives focus. * Focus should not be given to cells that are actually “focus siblings” * of other sibling cells (see gtk_cell_area_get_focus_from_sibling()). * Focus is set by calling gtk_cell_area_set_focus_cell(). - * @is_activatable: Returns whether the #GtkCellArea can respond to - * #GtkCellAreaClass.activate(), usually this does not need to be + * @is_activatable: Returns whether the `GtkCellArea` can respond to + * `GtkCellAreaClass.activate()`, usually this does not need to be * implemented since the base class takes care of this however it can - * be enhanced if the #GtkCellArea subclass can handle activation in - * other ways than activating its #GtkCellRenderers. + * be enhanced if the `GtkCellArea` subclass can handle activation in + * other ways than activating its `GtkCellRenderers`. * @activate: This is called when the layouting widget rendering the - * #GtkCellArea activates the focus cell (see gtk_cell_area_get_focus_cell()). + * `GtkCellArea` activates the focus cell (see gtk_cell_area_get_focus_cell()). */ struct _GtkCellAreaClass { diff --git a/gtk/gtkcellareabox.c b/gtk/gtkcellareabox.c index 791e8e37cd..b1049a7dae 100644 --- a/gtk/gtkcellareabox.c +++ b/gtk/gtkcellareabox.c @@ -25,21 +25,21 @@ * * A cell area that renders GtkCellRenderers into a row or a column * - * The #GtkCellAreaBox renders cell renderers into a row or a column - * depending on its #GtkOrientation. + * The `GtkCellAreaBox` renders cell renderers into a row or a column + * depending on its `GtkOrientation`. * * GtkCellAreaBox uses a notion of packing. Packing * refers to adding cell renderers with reference to a particular position - * in a #GtkCellAreaBox. There are two reference positions: the + * in a `GtkCellAreaBox`. There are two reference positions: the * start and the end of the box. - * When the #GtkCellAreaBox is oriented in the %GTK_ORIENTATION_VERTICAL + * When the `GtkCellAreaBox` is oriented in the %GTK_ORIENTATION_VERTICAL * orientation, the start is defined as the top of the box and the end is * defined as the bottom. In the %GTK_ORIENTATION_HORIZONTAL orientation * start is defined as the left side and the end is defined as the right * side. * - * Alignments of #GtkCellRenderers rendered in adjacent rows can be - * configured by configuring the #GtkCellAreaBox align child cell property + * Alignments of `GtkCellRenderer`s rendered in adjacent rows can be + * configured by configuring the `GtkCellAreaBox` align child cell property * with gtk_cell_area_cell_set_property() or by specifying the "align" * argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end(). */ @@ -2112,9 +2112,9 @@ _gtk_cell_area_box_group_visible (GtkCellAreaBox *box, /** * gtk_cell_area_box_new: * - * Creates a new #GtkCellAreaBox. + * Creates a new `GtkCellAreaBox`. * - * Returns: a newly created #GtkCellAreaBox + * Returns: a newly created `GtkCellAreaBox` */ GtkCellArea * gtk_cell_area_box_new (void) @@ -2124,8 +2124,8 @@ gtk_cell_area_box_new (void) /** * gtk_cell_area_box_pack_start: - * @box: a #GtkCellAreaBox - * @renderer: the #GtkCellRenderer to add + * @box: a `GtkCellAreaBox` + * @renderer: the `GtkCellRenderer` to add * @expand: whether @renderer should receive extra space when the area receives * more than its natural size * @align: whether @renderer should be aligned in adjacent rows @@ -2133,7 +2133,7 @@ gtk_cell_area_box_new (void) * * Adds @renderer to @box, packed with reference to the start of @box. * - * The @renderer is packed after any other #GtkCellRenderer packed + * The @renderer is packed after any other `GtkCellRenderer` packed * with reference to the start of @box. */ void @@ -2165,8 +2165,8 @@ gtk_cell_area_box_pack_start (GtkCellAreaBox *box, /** * gtk_cell_area_box_pack_end: - * @box: a #GtkCellAreaBox - * @renderer: the #GtkCellRenderer to add + * @box: a `GtkCellAreaBox` + * @renderer: the `GtkCellRenderer` to add * @expand: whether @renderer should receive extra space when the area receives * more than its natural size * @align: whether @renderer should be aligned in adjacent rows @@ -2175,7 +2175,7 @@ gtk_cell_area_box_pack_start (GtkCellAreaBox *box, * Adds @renderer to @box, packed with reference to the end of @box. * * The @renderer is packed after (away from end of) any other - * #GtkCellRenderer packed with reference to the end of @box. + * `GtkCellRenderer` packed with reference to the end of @box. */ void gtk_cell_area_box_pack_end (GtkCellAreaBox *box, @@ -2206,7 +2206,7 @@ gtk_cell_area_box_pack_end (GtkCellAreaBox *box, /** * gtk_cell_area_box_get_spacing: - * @box: a #GtkCellAreaBox + * @box: a `GtkCellAreaBox` * * Gets the spacing added between cell renderers. * @@ -2224,8 +2224,8 @@ gtk_cell_area_box_get_spacing (GtkCellAreaBox *box) /** * gtk_cell_area_box_set_spacing: - * @box: a #GtkCellAreaBox - * @spacing: the space to add between #GtkCellRenderers + * @box: a `GtkCellAreaBox` + * @spacing: the space to add between `GtkCellRenderer`s * * Sets the spacing to add between cell renderers in @box. */ diff --git a/gtk/gtkcellareacontext.c b/gtk/gtkcellareacontext.c index 058ee41e64..eec984c779 100644 --- a/gtk/gtkcellareacontext.c +++ b/gtk/gtkcellareacontext.c @@ -24,15 +24,15 @@ * * Stores geometrical information for a series of rows in a GtkCellArea * - * The #GtkCellAreaContext object is created by a given #GtkCellArea - * implementation via its #GtkCellAreaClass.create_context() virtual + * The `GtkCellAreaContext` object is created by a given `GtkCellArea` + * implementation via its `GtkCellAreaClass.create_context()` virtual * method and is used to store cell sizes and alignments for a series of - * #GtkTreeModel rows that are requested and rendered in the same context. + * `GtkTreeModel` rows that are requested and rendered in the same context. * - * #GtkCellLayout widgets can create any number of contexts in which to + * `GtkCellLayout` widgets can create any number of contexts in which to * request and render groups of data rows. However, it’s important that the - * same context which was used to request sizes for a given #GtkTreeModel - * row also be used for the same row when calling other #GtkCellArea APIs + * same context which was used to request sizes for a given `GtkTreeModel` + * row also be used for the same row when calling other `GtkCellArea` APIs * such as gtk_cell_area_render() and gtk_cell_area_event(). */ @@ -105,7 +105,7 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class) /** * GtkCellAreaContext:area: * - * The #GtkCellArea this context was created by + * The `GtkCellArea` this context was created by */ g_object_class_install_property (object_class, PROP_CELL_AREA, @@ -118,8 +118,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class) /** * GtkCellAreaContext:minimum-width: * - * The minimum width for the #GtkCellArea in this context - * for all #GtkTreeModel rows that this context was requested + * The minimum width for the `GtkCellArea` in this context + * for all `GtkTreeModel` rows that this context was requested * for using gtk_cell_area_get_preferred_width(). */ g_object_class_install_property (object_class, @@ -133,8 +133,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class) /** * GtkCellAreaContext:natural-width: * - * The natural width for the #GtkCellArea in this context - * for all #GtkTreeModel rows that this context was requested + * The natural width for the `GtkCellArea` in this context + * for all `GtkTreeModel` rows that this context was requested * for using gtk_cell_area_get_preferred_width(). */ g_object_class_install_property (object_class, @@ -148,8 +148,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class) /** * GtkCellAreaContext:minimum-height: * - * The minimum height for the #GtkCellArea in this context - * for all #GtkTreeModel rows that this context was requested + * The minimum height for the `GtkCellArea` in this context + * for all `GtkTreeModel` rows that this context was requested * for using gtk_cell_area_get_preferred_height(). */ g_object_class_install_property (object_class, @@ -163,8 +163,8 @@ gtk_cell_area_context_class_init (GtkCellAreaContextClass *class) /** * GtkCellAreaContext:natural-height: * - * The natural height for the #GtkCellArea in this context - * for all #GtkTreeModel rows that this context was requested + * The natural height for the `GtkCellArea` in this context + * for all `GtkTreeModel` rows that this context was requested * for using gtk_cell_area_get_preferred_height(). */ g_object_class_install_property (object_class, @@ -303,20 +303,20 @@ gtk_cell_area_context_real_allocate (GtkCellAreaContext *context, *************************************************************/ /** * gtk_cell_area_context_get_area: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * - * Fetches the #GtkCellArea this @context was created by. + * Fetches the `GtkCellArea` this @context was created by. * * This is generally unneeded by layouting widgets; however, * it is important for the context implementation itself to * fetch information about the area it is being used for. * - * For instance at #GtkCellAreaContextClass.allocate() time + * For instance at `GtkCellAreaContextClass.allocate()` time * it’s important to know details about any cell spacing - * that the #GtkCellArea is configured with in order to + * that the `GtkCellArea` is configured with in order to * compute a proper allocation. * - * Returns: (transfer none): the #GtkCellArea this context was created by. + * Returns: (transfer none): the `GtkCellArea` this context was created by. */ GtkCellArea * gtk_cell_area_context_get_area (GtkCellAreaContext *context) @@ -330,12 +330,12 @@ gtk_cell_area_context_get_area (GtkCellAreaContext *context) /** * gtk_cell_area_context_reset: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * * Resets any previously cached request and allocation * data. * - * When underlying #GtkTreeModel data changes its + * When underlying `GtkTreeModel` data changes its * important to reset the context if the content * size is allowed to shrink. If the content size * is only allowed to grow (this is usually an option @@ -365,10 +365,10 @@ gtk_cell_area_context_reset (GtkCellAreaContext *context) /** * gtk_cell_area_context_allocate: - * @context: a #GtkCellAreaContext - * @width: the allocated width for all #GtkTreeModel rows rendered + * @context: a `GtkCellAreaContext` + * @width: the allocated width for all `GtkTreeModel` rows rendered * with @context, or -1 - * @height: the allocated height for all #GtkTreeModel rows rendered + * @height: the allocated height for all `GtkTreeModel` rows rendered * with @context, or -1 * * Allocates a width and/or a height for all rows which are to be @@ -379,8 +379,8 @@ gtk_cell_area_context_reset (GtkCellAreaContext *context) * side vertically or horizontally and share either the same width * or the same height. Sometimes they are allocated in both horizontal * and vertical orientations producing a homogeneous effect of the - * rows. This is generally the case for #GtkTreeView when - * #GtkTreeView:fixed-height-mode is enabled. + * rows. This is generally the case for `GtkTreeView` when + * `GtkTreeView:fixed-height-mode` is enabled. */ void gtk_cell_area_context_allocate (GtkCellAreaContext *context, @@ -394,7 +394,7 @@ gtk_cell_area_context_allocate (GtkCellAreaContext *context, /** * gtk_cell_area_context_get_preferred_width: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @minimum_width: (out) (optional): location to store the minimum width * @natural_width: (out) (optional): location to store the natural width * @@ -402,7 +402,7 @@ gtk_cell_area_context_allocate (GtkCellAreaContext *context, * requested with this context. * * After gtk_cell_area_context_reset() is called and/or before ever - * requesting the size of a #GtkCellArea, the returned values are 0. + * requesting the size of a `GtkCellArea`, the returned values are 0. */ void gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context, @@ -422,7 +422,7 @@ gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context, /** * gtk_cell_area_context_get_preferred_height: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @minimum_height: (out) (optional): location to store the minimum height * @natural_height: (out) (optional): location to store the natural height * @@ -430,7 +430,7 @@ gtk_cell_area_context_get_preferred_width (GtkCellAreaContext *context, * requested with this context. * * After gtk_cell_area_context_reset() is called and/or before ever - * requesting the size of a #GtkCellArea, the returned values are 0. + * requesting the size of a `GtkCellArea`, the returned values are 0. */ void gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context, @@ -450,7 +450,7 @@ gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context, /** * gtk_cell_area_context_get_preferred_height_for_width: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @width: a proposed width for allocation * @minimum_height: (out) (optional): location to store the minimum height * @natural_height: (out) (optional): location to store the natural height @@ -459,7 +459,7 @@ gtk_cell_area_context_get_preferred_height (GtkCellAreaContext *context, * which have been requested for the same said @width with this context. * * After gtk_cell_area_context_reset() is called and/or before ever - * requesting the size of a #GtkCellArea, the returned values are -1. + * requesting the size of a `GtkCellArea`, the returned values are -1. */ void gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *context, @@ -478,7 +478,7 @@ gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *contex /** * gtk_cell_area_context_get_preferred_width_for_height: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @height: a proposed height for allocation * @minimum_width: (out) (optional): location to store the minimum width * @natural_width: (out) (optional): location to store the natural width @@ -487,7 +487,7 @@ gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *contex * have been requested for the same said @height with this context. * * After gtk_cell_area_context_reset() is called and/or before ever - * requesting the size of a #GtkCellArea, the returned values are -1. + * requesting the size of a `GtkCellArea`, the returned values are -1. */ void gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *context, @@ -506,7 +506,7 @@ gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *contex /** * gtk_cell_area_context_get_allocation: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @width: (out) (optional): location to store the allocated width * @height: (out) (optional): location to store the allocated height * @@ -534,15 +534,15 @@ gtk_cell_area_context_get_allocation (GtkCellAreaContext *context, /** * gtk_cell_area_context_push_preferred_width: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @minimum_width: the proposed new minimum width for @context * @natural_width: the proposed new natural width for @context * * Causes the minimum and/or natural width to grow if the new * proposed sizes exceed the current minimum and natural width. * - * This is used by #GtkCellAreaContext implementations during - * the request process over a series of #GtkTreeModel rows to + * This is used by `GtkCellAreaContext` implementations during + * the request process over a series of `GtkTreeModel` rows to * progressively push the requested width over a series of * gtk_cell_area_get_preferred_width() requests. */ @@ -576,15 +576,15 @@ gtk_cell_area_context_push_preferred_width (GtkCellAreaContext *context, /** * gtk_cell_area_context_push_preferred_height: - * @context: a #GtkCellAreaContext + * @context: a `GtkCellAreaContext` * @minimum_height: the proposed new minimum height for @context * @natural_height: the proposed new natural height for @context * * Causes the minimum and/or natural height to grow if the new * proposed sizes exceed the current minimum and natural height. * - * This is used by #GtkCellAreaContext implementations during - * the request process over a series of #GtkTreeModel rows to + * This is used by `GtkCellAreaContext` implementations during + * the request process over a series of `GtkTreeModel` rows to * progressively push the requested height over a series of * gtk_cell_area_get_preferred_height() requests. */ diff --git a/gtk/gtkcelleditable.c b/gtk/gtkcelleditable.c index 3833dede31..9c413c4bd5 100644 --- a/gtk/gtkcelleditable.c +++ b/gtk/gtkcelleditable.c @@ -20,8 +20,8 @@ * * Interface for widgets that can be used for editing cells * - * The #GtkCellEditable interface must be implemented for widgets to be usable - * to edit the contents of a #GtkTreeView cell. It provides a way to specify how + * The `GtkCellEditable` interface must be implemented for widgets to be usable + * to edit the contents of a `GtkTreeView` cell. It provides a way to specify how * temporary widgets should be configured for editing, get the new value, etc. */ @@ -57,14 +57,14 @@ gtk_cell_editable_default_init (GtkCellEditableInterface *iface) * This signal is a sign for the cell renderer to update its * value from the @cell_editable. * - * Implementations of #GtkCellEditable are responsible for + * Implementations of `GtkCellEditable` are responsible for * emitting this signal when they are done editing, e.g. - * #GtkEntry emits this signal when the user presses Enter. Typical things to + * `GtkEntry` emits this signal when the user presses Enter. Typical things to * do in a handler for ::editing-done are to capture the edited value, - * disconnect the @cell_editable from signals on the #GtkCellRenderer, etc. + * disconnect the @cell_editable from signals on the `GtkCellRenderer`, etc. * * gtk_cell_editable_editing_done() is a convenience method - * for emitting #GtkCellEditable::editing-done. + * for emitting `GtkCellEditable::editing-done`. */ g_signal_new (I_("editing-done"), GTK_TYPE_CELL_EDITABLE, @@ -82,14 +82,14 @@ gtk_cell_editable_default_init (GtkCellEditableInterface *iface) * editing, and the @cell_editable widget is being removed and may * subsequently be destroyed. * - * Implementations of #GtkCellEditable are responsible for + * Implementations of `GtkCellEditable` are responsible for * emitting this signal when they are done editing. It must - * be emitted after the #GtkCellEditable::editing-done signal, + * be emitted after the `GtkCellEditable::editing-done` signal, * to give the cell renderer a chance to update the cell's value * before the widget is removed. * * gtk_cell_editable_remove_widget() is a convenience method - * for emitting #GtkCellEditable::remove-widget. + * for emitting `GtkCellEditable::remove-widget`. */ g_signal_new (I_("remove-widget"), GTK_TYPE_CELL_EDITABLE, @@ -102,17 +102,17 @@ gtk_cell_editable_default_init (GtkCellEditableInterface *iface) /** * gtk_cell_editable_start_editing: - * @cell_editable: A #GtkCellEditable - * @event: (nullable): The #GdkEvent that began the editing process, or + * @cell_editable: A `GtkCellEditable` + * @event: (nullable): The `GdkEvent` that began the editing process, or * %NULL if editing was initiated programmatically - * + * * Begins editing on a @cell_editable. * - * The #GtkCellRenderer for the cell creates and returns a #GtkCellEditable from - * gtk_cell_renderer_start_editing(), configured for the #GtkCellRenderer type. + * The `GtkCellRenderer` for the cell creates and returns a `GtkCellEditable` from + * gtk_cell_renderer_start_editing(), configured for the `GtkCellRenderer` type. * * gtk_cell_editable_start_editing() can then set up @cell_editable suitably for - * editing a cell, e.g. making the Esc key emit #GtkCellEditable::editing-done. + * editing a cell, e.g. making the Esc key emit `GtkCellEditable::editing-done`. * * Note that the @cell_editable is created on-demand for the current edit; its * lifetime is temporary and does not persist across other edits and/or cells. @@ -128,10 +128,10 @@ gtk_cell_editable_start_editing (GtkCellEditable *cell_editable, /** * gtk_cell_editable_editing_done: - * @cell_editable: A #GtkCellEditable - * - * Emits the #GtkCellEditable::editing-done signal. - **/ + * @cell_editable: A `GtkCellEditable` + * + * Emits the `GtkCellEditable::editing-done` signal. + */ void gtk_cell_editable_editing_done (GtkCellEditable *cell_editable) { @@ -142,9 +142,9 @@ gtk_cell_editable_editing_done (GtkCellEditable *cell_editable) /** * gtk_cell_editable_remove_widget: - * @cell_editable: A #GtkCellEditable - * - * Emits the #GtkCellEditable::remove-widget signal. + * @cell_editable: A `GtkCellEditable` + * + * Emits the `GtkCellEditable::remove-widget` signal. **/ void gtk_cell_editable_remove_widget (GtkCellEditable *cell_editable) diff --git a/gtk/gtkcelllayout.c b/gtk/gtkcelllayout.c index c30497daee..e8c9a0c805 100644 --- a/gtk/gtkcelllayout.c +++ b/gtk/gtkcelllayout.c @@ -20,12 +20,12 @@ * * An interface for packing cells * - * #GtkCellLayout is an interface to be implemented by all objects which - * want to provide a #GtkTreeViewColumn like API for packing cells, + * `GtkCellLayout` is an interface to be implemented by all objects which + * want to provide a `GtkTreeViewColumn` like API for packing cells, * setting attributes and data funcs. * * One of the notable features provided by implementations of - * GtkCellLayout are attributes. Attributes let you set the properties + * `GtkCellLayout` are attributes. Attributes let you set the properties * in flexible ways. They can just be set to constant values like regular * properties. But they can also be mapped to a column of the underlying * tree model with gtk_cell_layout_set_attributes(), which means that the value @@ -37,8 +37,8 @@ * # GtkCellLayouts as GtkBuildable * * Implementations of GtkCellLayout which also implement the GtkBuildable - * interface (#GtkCellView, #GtkIconView, #GtkComboBox, - * #GtkEntryCompletion, #GtkTreeViewColumn) accept GtkCellRenderer objects + * interface (`GtkCellView`, `GtkIconView`, `GtkComboBox`, + * `GtkEntryCompletion`, `GtkTreeViewColumn`) accept `GtkCellRenderer` objects * as <child> elements in UI definitions. They support a custom <attributes> * element for their children, which can contain multiple <attribute> * elements. Each <attribute> element has a name attribute which specifies @@ -57,7 +57,7 @@ * </object> * ]| * - * Furthermore for implementations of GtkCellLayout that use a #GtkCellArea + * Furthermore for implementations of GtkCellLayout that use a `GtkCellArea` * to lay out cells (all GtkCellLayouts in GTK use a GtkCellArea) * [cell properties][cell-properties] can also be defined in the format by * specifying the custom <cell-packing> attribute which can contain multiple @@ -79,9 +79,9 @@ * * # Subclassing GtkCellLayout implementations * - * When subclassing a widget that implements #GtkCellLayout like - * #GtkIconView or #GtkComboBox, there are some considerations related - * to the fact that these widgets internally use a #GtkCellArea. + * When subclassing a widget that implements `GtkCellLayout` like + * `GtkIconView` or `GtkComboBox`, there are some considerations related + * to the fact that these widgets internally use a `GtkCellArea`. * The cell area is exposed as a construct-only property by these * widgets. This means that it is possible to e.g. do * @@ -349,8 +349,8 @@ gtk_cell_layout_default_get_cells (GtkCellLayout *cell_layout) /** * gtk_cell_layout_pack_start: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` * @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout * * Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, @@ -372,8 +372,8 @@ gtk_cell_layout_pack_start (GtkCellLayout *cell_layout, /** * gtk_cell_layout_pack_end: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` * @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout * * Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the @@ -395,7 +395,7 @@ gtk_cell_layout_pack_end (GtkCellLayout *cell_layout, /** * gtk_cell_layout_clear: - * @cell_layout: a #GtkCellLayout + * @cell_layout: a `GtkCellLayout` * * Unsets all the mappings on all renderers on @cell_layout and * removes all renderers from @cell_layout. @@ -432,8 +432,8 @@ gtk_cell_layout_set_attributesv (GtkCellLayout *cell_layout, /** * gtk_cell_layout_set_attributes: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` * @...: a %NULL-terminated list of attributes * * Sets the attributes in list as the attributes of @cell_layout. @@ -459,8 +459,8 @@ gtk_cell_layout_set_attributes (GtkCellLayout *cell_layout, /** * gtk_cell_layout_add_attribute: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` * @attribute: an attribute on the renderer * @column: the column position on the model to get the attribute from * @@ -469,7 +469,7 @@ gtk_cell_layout_set_attributes (GtkCellLayout *cell_layout, * The @column is the column of the model to get a value from, and the * @attribute is the parameter on @cell to be set from the value. So for * example if column 2 of the model contains strings, you could have the - * “text” attribute of a #GtkCellRendererText get its values from column 2. + * “text” attribute of a `GtkCellRendererText` get its values from column 2. */ void gtk_cell_layout_add_attribute (GtkCellLayout *cell_layout, @@ -487,13 +487,13 @@ gtk_cell_layout_add_attribute (GtkCellLayout *cell_layout, /** * gtk_cell_layout_set_cell_data_func: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer - * @func: (nullable): the #GtkCellLayoutDataFunc to use + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` + * @func: (nullable): the `GtkCellLayout`DataFunc to use * @func_data: (closure): user data for @func * @destroy: destroy notify for @func_data * - * Sets the #GtkCellLayoutDataFunc to use for @cell_layout. + * Sets the `GtkCellLayout`DataFunc to use for @cell_layout. * * This function is used instead of the standard attributes mapping * for setting the column value, and should set the value of @cell_layout’s @@ -517,8 +517,8 @@ gtk_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout, /** * gtk_cell_layout_clear_attributes: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer to clear the attribute mapping on + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` to clear the attribute mapping on * * Clears all existing attributes previously set with * gtk_cell_layout_set_attributes(). @@ -535,8 +535,8 @@ gtk_cell_layout_clear_attributes (GtkCellLayout *cell_layout, /** * gtk_cell_layout_reorder: - * @cell_layout: a #GtkCellLayout - * @cell: a #GtkCellRenderer to reorder + * @cell_layout: a `GtkCellLayout` + * @cell: a `GtkCellRenderer` to reorder * @position: new position to insert @cell at * * Re-inserts @cell at @position. @@ -557,7 +557,7 @@ gtk_cell_layout_reorder (GtkCellLayout *cell_layout, /** * gtk_cell_layout_get_cells: - * @cell_layout: a #GtkCellLayout + * @cell_layout: a `GtkCellLayout` * * Returns the cell renderers which have been added to @cell_layout. * @@ -576,10 +576,10 @@ gtk_cell_layout_get_cells (GtkCellLayout *cell_layout) /** * gtk_cell_layout_get_area: - * @cell_layout: a #GtkCellLayout + * @cell_layout: a `GtkCellLayout` * - * Returns the underlying #GtkCellArea which might be @cell_layout - * if called on a #GtkCellArea or might be %NULL if no #GtkCellArea + * Returns the underlying `GtkCellArea` which might be @cell_layout + * if called on a `GtkCellArea` or might be %NULL if no `GtkCellArea` * is used by @cell_layout. * * Returns: (transfer none) (nullable): the cell area used by @cell_layout diff --git a/gtk/gtkcelllayout.h b/gtk/gtkcelllayout.h index 5ec03ddf6a..47bc01dae3 100644 --- a/gtk/gtkcelllayout.h +++ b/gtk/gtkcelllayout.h @@ -40,10 +40,10 @@ typedef struct _GtkCellLayoutIface GtkCellLayoutIface; /* keep in sync with GtkTreeCellDataFunc */ /** * GtkCellLayoutDataFunc: - * @cell_layout: a #GtkCellLayout + * @cell_layout: a `GtkCellLayout` * @cell: the cell renderer whose value is to be set * @tree_model: the model - * @iter: a #GtkTreeIter indicating the row to set the value for + * @iter: a `GtkTreeIter` indicating the row to set the value for * @data: (closure): user data passed to gtk_cell_layout_set_cell_data_func() * * A function which should set the value of @cell_layout’s cell renderer(s) @@ -63,16 +63,16 @@ typedef void (* GtkCellLayoutDataFunc) (GtkCellLayout *cell_layout, * removes all renderers from cell_layout. * @add_attribute: Adds an attribute mapping to the list in * cell_layout. - * @set_cell_data_func: Sets the #GtkCellLayoutDataFunc to use for + * @set_cell_data_func: Sets the `GtkCellLayout`DataFunc to use for * cell_layout. * @clear_attributes: Clears all existing attributes previously set * with gtk_cell_layout_set_attributes(). * @reorder: Re-inserts cell at position. * @get_cells: Get the cell renderers which have been added to * cell_layout. - * @get_area: Get the underlying #GtkCellArea which might be - * cell_layout if called on a #GtkCellArea or might be NULL if no - * #GtkCellArea is used by cell_layout. + * @get_area: Get the underlying `GtkCellArea` which might be + * cell_layout if called on a `GtkCellArea` or might be NULL if no + * `GtkCellArea` is used by cell_layout. */ struct _GtkCellLayoutIface { diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c index 72021a8f0e..c462c007c5 100644 --- a/gtk/gtkcellrenderer.c +++ b/gtk/gtkcellrenderer.c @@ -32,38 +32,38 @@ * * An object for rendering a single cell * - * The #GtkCellRenderer is a base class of a set of objects used for - * rendering a cell to a #cairo_t. These objects are used primarily by - * the #GtkTreeView widget, though they aren’t tied to them in any - * specific way. It is worth noting that #GtkCellRenderer is not a - * #GtkWidget and cannot be treated as such. + * The `GtkCellRenderer` is a base class of a set of objects used for + * rendering a cell to a `cairo_t`. These objects are used primarily by + * the `GtkTreeView` widget, though they aren’t tied to them in any + * specific way. It is worth noting that `GtkCellRenderer` is not a + * `GtkWidget` and cannot be treated as such. * - * The primary use of a #GtkCellRenderer is for drawing a certain graphical - * elements on a #cairo_t. Typically, one cell renderer is used to + * The primary use of a `GtkCellRenderer` is for drawing a certain graphical + * elements on a `cairo_t`. Typically, one cell renderer is used to * draw many cells on the screen. To this extent, it isn’t expected that a * CellRenderer keep any permanent state around. Instead, any state is set - * just prior to use using #GObjects property system. Then, the + * just prior to use using `GObject`s property system. Then, the * cell is measured using gtk_cell_renderer_get_preferred_size(). Finally, the cell * is rendered in the correct location using gtk_cell_renderer_snapshot(). * * There are a number of rules that must be followed when writing a new - * #GtkCellRenderer. First and foremost, it’s important that a certain set + * `GtkCellRenderer`. First and foremost, it’s important that a certain set * of properties will always yield a cell renderer of the same size, - * barring a style change. The #GtkCellRenderer also has a number of + * barring a style change. The `GtkCellRenderer` also has a number of * generic properties that are expected to be honored by all children. * * Beyond merely rendering a cell, cell renderers can optionally * provide active user interface elements. A cell renderer can be - * “activatable” like #GtkCellRendererToggle, + * “activatable” like `GtkCellRenderer`Toggle, * which toggles when it gets activated by a mouse click, or it can be - * “editable” like #GtkCellRendererText, which + * “editable” like `GtkCellRenderer`Text, which * allows the user to edit the text using a widget implementing the - * #GtkCellEditable interface, e.g. #GtkEntry. + * `GtkCellEditable` interface, e.g. `GtkEntry`. * To make a cell renderer activatable or editable, you have to - * implement the #GtkCellRendererClass.activate or - * #GtkCellRendererClass.start_editing virtual functions, respectively. + * implement the `GtkCellRenderer`Class.activate or + * `GtkCellRenderer`Class.start_editing virtual functions, respectively. * - * Many properties of #GtkCellRenderer and its subclasses have a + * Many properties of `GtkCellRenderer` and its subclasses have a * corresponding “set” property, e.g. “cell-background-set” corresponds * to “cell-background”. These “set” properties reflect whether a property * has been set or not. You should not set them independently. @@ -228,13 +228,13 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) /** * GtkCellRenderer::editing-started: * @renderer: the object which received the signal - * @editable: the #GtkCellEditable + * @editable: the `GtkCellEditable` * @path: the path identifying the edited cell * * This signal gets emitted when a cell starts to be edited. * The intended use of this signal is to do special setup - * on @editable, e.g. adding a #GtkEntryCompletion or setting - * up additional columns in a #GtkComboBox. + * on @editable, e.g. adding a `GtkEntryCompletion` or setting + * up additional columns in a `GtkComboBox`. * * See gtk_cell_editable_start_editing() for information on the lifecycle of * the @editable and a way to do setup that doesn’t depend on the @renderer. @@ -387,7 +387,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class) /** * GtkCellRenderer:cell-background-rgba: * - * Cell background as a #GdkRGBA + * Cell background as a `GdkRGBA` */ g_object_class_install_property (object_class, PROP_CELL_BACKGROUND_RGBA, @@ -654,17 +654,17 @@ set_cell_bg_color (GtkCellRenderer *cell, /** * gtk_cell_renderer_snapshot: - * @cell: a #GtkCellRenderer - * @snapshot: a #GtkSnapshot to draw to + * @cell: a `GtkCellRenderer` + * @snapshot: a `GtkSnapshot` to draw to * @widget: the widget owning @window * @background_area: entire cell area (including tree expanders and maybe * padding on the sides) * @cell_area: area normally rendered by a cell renderer * @flags: flags that affect rendering * - * Invokes the virtual render function of the #GtkCellRenderer. The three + * Invokes the virtual render function of the `GtkCellRenderer`. The three * passed-in rectangles are areas in @cr. Most renderers will draw within - * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer + * @cell_area; the xalign, yalign, xpad, and ypad fields of the `GtkCellRenderer` * should be honored with respect to @cell_area. @background_area includes the * blank space around the cell, and also the area containing the tree expander; * so the @background_area rectangles for all cells tile to cover the entire @@ -728,17 +728,17 @@ gtk_cell_renderer_snapshot (GtkCellRenderer *cell, /** * gtk_cell_renderer_activate: - * @cell: a #GtkCellRenderer - * @event: a #GdkEvent + * @cell: a `GtkCellRenderer` + * @event: a `GdkEvent` * @widget: widget that received the event - * @path: widget-dependent string representation of the event location; - * e.g. for #GtkTreeView, a string representation of #GtkTreePath + * @path: widget-dependent string representation of the event location; + * e.g. for `GtkTreeView`, a string representation of `GtkTreePath` * @background_area: background area as passed to gtk_cell_renderer_render() * @cell_area: cell area as passed to gtk_cell_renderer_render() * @flags: render flags * - * Passes an activate event to the cell renderer for possible processing. - * Some cell renderers may use events; for example, #GtkCellRendererToggle + * Passes an activate event to the cell renderer for possible processing. + * Some cell renderers may use events; for example, `GtkCellRendererToggle` * toggles when it gets a mouse click. * * Returns: %TRUE if the event was consumed/handled @@ -775,19 +775,19 @@ gtk_cell_renderer_activate (GtkCellRenderer *cell, /** * gtk_cell_renderer_start_editing: - * @cell: a #GtkCellRenderer - * @event: (nullable): a #GdkEvent + * @cell: a `GtkCellRenderer` + * @event: (nullable): a `GdkEvent` * @widget: widget that received the event * @path: widget-dependent string representation of the event location; - * e.g. for #GtkTreeView, a string representation of #GtkTreePath + * e.g. for `GtkTreeView`, a string representation of `GtkTreePath` * @background_area: background area as passed to gtk_cell_renderer_render() * @cell_area: cell area as passed to gtk_cell_renderer_render() * @flags: render flags * - * Starts editing the contents of this @cell, through a new #GtkCellEditable - * widget created by the #GtkCellRendererClass.start_editing virtual function. + * Starts editing the contents of this @cell, through a new `GtkCellEditable` + * widget created by the `GtkCellRenderer`Class.start_editing virtual function. * - * Returns: (nullable) (transfer none): A new #GtkCellEditable for editing this + * Returns: (nullable) (transfer none): A new `GtkCellEditable` for editing this * @cell, or %NULL if editing is not possible **/ GtkCellEditable * @@ -836,7 +836,7 @@ gtk_cell_renderer_start_editing (GtkCellRenderer *cell, /** * gtk_cell_renderer_set_fixed_size: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @width: the width of the cell renderer, or -1 * @height: the height of the cell renderer, or -1 * @@ -876,12 +876,12 @@ gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_fixed_size: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @width: (out) (optional): location to fill in with the fixed width of the cell * @height: (out) (optional): location to fill in with the fixed height of the cell * * Fills in @width and @height with the appropriate size of @cell. - **/ + */ void gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell, int *width, @@ -901,7 +901,7 @@ gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell, /** * gtk_cell_renderer_set_alignment: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @xalign: the x alignment of the cell renderer * @yalign: the y alignment of the cell renderer * @@ -942,12 +942,12 @@ gtk_cell_renderer_set_alignment (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_alignment: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @xalign: (out) (optional): location to fill in with the x alignment of the cell * @yalign: (out) (optional): location to fill in with the y alignment of the cell * * Fills in @xalign and @yalign with the appropriate values of @cell. - **/ + */ void gtk_cell_renderer_get_alignment (GtkCellRenderer *cell, float *xalign, @@ -967,7 +967,7 @@ gtk_cell_renderer_get_alignment (GtkCellRenderer *cell, /** * gtk_cell_renderer_set_padding: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @xpad: the x padding of the cell renderer * @ypad: the y padding of the cell renderer * @@ -1007,12 +1007,12 @@ gtk_cell_renderer_set_padding (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_padding: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @xpad: (out) (optional): location to fill in with the x padding of the cell * @ypad: (out) (optional): location to fill in with the y padding of the cell * * Fills in @xpad and @ypad with the appropriate values of @cell. - **/ + */ void gtk_cell_renderer_get_padding (GtkCellRenderer *cell, int *xpad, @@ -1032,7 +1032,7 @@ gtk_cell_renderer_get_padding (GtkCellRenderer *cell, /** * gtk_cell_renderer_set_visible: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @visible: the visibility of the cell * * Sets the cell renderer’s visibility. @@ -1056,7 +1056,7 @@ gtk_cell_renderer_set_visible (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_visible: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * * Returns the cell renderer’s visibility. * @@ -1072,7 +1072,7 @@ gtk_cell_renderer_get_visible (GtkCellRenderer *cell) /** * gtk_cell_renderer_set_sensitive: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @sensitive: the sensitivity of the cell * * Sets the cell renderer’s sensitivity. @@ -1096,7 +1096,7 @@ gtk_cell_renderer_set_sensitive (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_sensitive: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * * Returns the cell renderer’s sensitivity. * @@ -1113,7 +1113,7 @@ gtk_cell_renderer_get_sensitive (GtkCellRenderer *cell) /** * gtk_cell_renderer_is_activatable: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * * Checks whether the cell renderer can do something when activated. * @@ -1136,16 +1136,16 @@ gtk_cell_renderer_is_activatable (GtkCellRenderer *cell) /** * gtk_cell_renderer_stop_editing: - * @cell: A #GtkCellRenderer + * @cell: A `GtkCellRenderer` * @canceled: %TRUE if the editing has been canceled - * + * * Informs the cell renderer that the editing is stopped. - * If @canceled is %TRUE, the cell renderer will emit the - * #GtkCellRenderer::editing-canceled signal. + * If @canceled is %TRUE, the cell renderer will emit the + * `GtkCellRenderer`::editing-canceled signal. * - * This function should be called by cell renderer implementations - * in response to the #GtkCellEditable::editing-done signal of - * #GtkCellEditable. + * This function should be called by cell renderer implementations + * in response to the `GtkCellEditable::editing-done` signal of + * `GtkCellEditable`. **/ void gtk_cell_renderer_stop_editing (GtkCellRenderer *cell, @@ -1344,12 +1344,12 @@ _gtk_cell_renderer_calc_offset (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_request_mode: - * @cell: a #GtkCellRenderer instance + * @cell: a `GtkCellRenderer` instance * * Gets whether the cell renderer prefers a height-for-width layout * or a width-for-height layout. * - * Returns: The #GtkSizeRequestMode preferred by this renderer. + * Returns: The `GtkSizeRequestMode` preferred by this renderer. */ GtkSizeRequestMode gtk_cell_renderer_get_request_mode (GtkCellRenderer *cell) @@ -1361,8 +1361,8 @@ gtk_cell_renderer_get_request_mode (GtkCellRenderer *cell) /** * gtk_cell_renderer_get_preferred_width: - * @cell: a #GtkCellRenderer instance - * @widget: the #GtkWidget this cell will be rendering to + * @cell: a `GtkCellRenderer` instance + * @widget: the `GtkWidget` this cell will be rendering to * @minimum_size: (out) (optional): location to store the minimum size * @natural_size: (out) (optional): location to store the natural size * @@ -1407,8 +1407,8 @@ gtk_cell_renderer_get_preferred_width (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_preferred_height: - * @cell: a #GtkCellRenderer instance - * @widget: the #GtkWidget this cell will be rendering to + * @cell: a `GtkCellRenderer` instance + * @widget: the `GtkWidget` this cell will be rendering to * @minimum_size: (out) (optional): location to store the minimum size * @natural_size: (out) (optional): location to store the natural size * @@ -1453,8 +1453,8 @@ gtk_cell_renderer_get_preferred_height (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_preferred_width_for_height: - * @cell: a #GtkCellRenderer instance - * @widget: the #GtkWidget this cell will be rendering to + * @cell: a `GtkCellRenderer` instance + * @widget: the `GtkWidget` this cell will be rendering to * @height: the size which is available for allocation * @minimum_width: (out) (optional): location for storing the minimum size * @natural_width: (out) (optional): location for storing the preferred size @@ -1501,8 +1501,8 @@ gtk_cell_renderer_get_preferred_width_for_height (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_preferred_height_for_width: - * @cell: a #GtkCellRenderer instance - * @widget: the #GtkWidget this cell will be rendering to + * @cell: a `GtkCellRenderer` instance + * @widget: the `GtkWidget` this cell will be rendering to * @width: the size which is available for allocation * @minimum_height: (out) (optional): location for storing the minimum size * @natural_height: (out) (optional): location for storing the preferred size @@ -1549,8 +1549,8 @@ gtk_cell_renderer_get_preferred_height_for_width (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_preferred_size: - * @cell: a #GtkCellRenderer instance - * @widget: the #GtkWidget this cell will be rendering to + * @cell: a `GtkCellRenderer` instance + * @widget: the `GtkWidget` this cell will be rendering to * @minimum_size: (out) (optional): location for storing the minimum size * @natural_size: (out) (optional): location for storing the natural size * @@ -1608,8 +1608,8 @@ gtk_cell_renderer_get_preferred_size (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_aligned_area: - * @cell: a #GtkCellRenderer instance - * @widget: the #GtkWidget this cell will be rendering to + * @cell: a `GtkCellRenderer` instance + * @widget: the `GtkWidget` this cell will be rendering to * @flags: render flags * @cell_area: cell area which would be passed to gtk_cell_renderer_render() * @aligned_area: (out): the return location for the space inside @cell_area @@ -1643,13 +1643,13 @@ gtk_cell_renderer_get_aligned_area (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_state: - * @cell: (nullable): a #GtkCellRenderer - * @widget: (nullable): a #GtkWidget + * @cell: (nullable): a `GtkCellRenderer` + * @widget: (nullable): a `GtkWidget` * @cell_state: cell renderer state * - * Translates the cell renderer state to #GtkStateFlags, + * Translates the cell renderer state to `GtkStateFlags`, * based on the cell renderer and widget sensitivity, and - * the given #GtkCellRendererState. + * the given `GtkCellRenderer`State. * * Returns: the widget state flags applying to @cell **/ @@ -1692,10 +1692,10 @@ gtk_cell_renderer_get_state (GtkCellRenderer *cell, /** * gtk_cell_renderer_set_is_expander: - * @cell: a #GtkCellRenderer + * @cell: a `GtkCellRenderer` * @is_expander: whether @cell is an expander * - * Sets whether the given #GtkCellRenderer is an expander. + * Sets whether the given `GtkCellRenderer` is an expander. */ void gtk_cell_renderer_set_is_expander (GtkCellRenderer *cell, @@ -1717,9 +1717,9 @@ gtk_cell_renderer_set_is_expander (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_is_expander: - * @cell: a #GtkCellRenderer + * @cell: a `GtkCellRenderer` * - * Checks whether the given #GtkCellRenderer is an expander. + * Checks whether the given `GtkCellRenderer` is an expander. * * Returns: %TRUE if @cell is an expander, and %FALSE otherwise */ @@ -1735,10 +1735,10 @@ gtk_cell_renderer_get_is_expander (GtkCellRenderer *cell) /** * gtk_cell_renderer_set_is_expanded: - * @cell: a #GtkCellRenderer + * @cell: a `GtkCellRenderer` * @is_expanded: whether @cell should be expanded * - * Sets whether the given #GtkCellRenderer is expanded. + * Sets whether the given `GtkCellRenderer` is expanded. */ void gtk_cell_renderer_set_is_expanded (GtkCellRenderer *cell, @@ -1760,9 +1760,9 @@ gtk_cell_renderer_set_is_expanded (GtkCellRenderer *cell, /** * gtk_cell_renderer_get_is_expanded: - * @cell: a #GtkCellRenderer + * @cell: a `GtkCellRenderer` * - * Checks whether the given #GtkCellRenderer is expanded. + * Checks whether the given `GtkCellRenderer` is expanded. * * Returns: %TRUE if the cell renderer is expanded */ diff --git a/gtk/gtkcellrenderer.h b/gtk/gtkcellrenderer.h index ca59826a02..a0a5129c47 100644 --- a/gtk/gtkcellrenderer.h +++ b/gtk/gtkcellrenderer.h @@ -99,9 +99,9 @@ struct _GtkCellRenderer * @get_preferred_height: Called to get a renderer’s natural height. * @get_preferred_width_for_height: Called to get a renderer’s natural width for height. * @get_aligned_area: Called to get the aligned area used by @cell inside @cell_area. - * @snapshot: Called to snapshot the content of the #GtkCellRenderer. - * @activate: Called to activate the content of the #GtkCellRenderer. - * @start_editing: Called to initiate editing the content of the #GtkCellRenderer. + * @snapshot: Called to snapshot the content of the `GtkCellRenderer`. + * @activate: Called to activate the content of the `GtkCellRenderer`. + * @start_editing: Called to initiate editing the content of the `GtkCellRenderer`. * @editing_canceled: Signal gets emitted when the user cancels the process of editing a cell. * @editing_started: Signal gets emitted when a cell starts to be edited. */ diff --git a/gtk/gtkcellrendereraccel.c b/gtk/gtkcellrendereraccel.c index 550b242b0e..c4762ad798 100644 --- a/gtk/gtkcellrendereraccel.c +++ b/gtk/gtkcellrendereraccel.c @@ -37,7 +37,7 @@ * * Renders a keyboard accelerator in a cell * - * #GtkCellRendererAccel displays a keyboard accelerator (i.e. a key + * `GtkCellRendererAccel` displays a keyboard accelerator (i.e. a key * combination like `Control + a`). If the cell renderer is editable, * the accelerator can be changed by simply typing the new combination. */ @@ -270,7 +270,7 @@ gtk_cell_renderer_accel_class_init (GtkCellRendererAccelClass *cell_accel_class) /** * gtk_cell_renderer_accel_new: * - * Creates a new #GtkCellRendererAccel. + * Creates a new `GtkCellRendererAccel`. * * Returns: the new cell renderer */ diff --git a/gtk/gtkcellrenderercombo.c b/gtk/gtkcellrenderercombo.c index 682ce5751a..d902da5f31 100644 --- a/gtk/gtkcellrenderercombo.c +++ b/gtk/gtkcellrenderercombo.c @@ -33,16 +33,16 @@ * * Renders a combobox in a cell * - * #GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from - * which it is derived. But while #GtkCellRendererText offers a simple entry to - * edit the text, #GtkCellRendererCombo offers a #GtkComboBox + * `GtkCellRendererCombo` renders text in a cell like `GtkCellRendererText` from + * which it is derived. But while `GtkCellRendererText` offers a simple entry to + * edit the text, `GtkCellRendererCombo` offers a `GtkComboBox` * widget to edit the text. The values to display in the combo box are taken from - * the tree model specified in the #GtkCellRendererCombo:model property. + * the tree model specified in the `GtkCellRendererCombo`:model property. * * The combo cell renderer takes care of adding a text cell renderer to the combo * box and sets it to display the column specified by its - * #GtkCellRendererCombo:text-column property. Further properties of the combo box - * can be set in a handler for the #GtkCellRenderer::editing-started signal. + * `GtkCellRendererCombo`:text-column property. Further properties of the combo box + * can be set in a handler for the `GtkCellRenderer::editing-started` signal. */ typedef struct _GtkCellRendererComboPrivate GtkCellRendererComboPrivate; @@ -146,7 +146,7 @@ gtk_cell_renderer_combo_class_init (GtkCellRendererComboClass *klass) * not the model backing the tree view to which * this cell renderer is attached. * - * #GtkCellRendererCombo automatically adds a text cell renderer for + * `GtkCellRendererCombo` automatically adds a text cell renderer for * this column to its combo box. */ g_object_class_install_property (object_class, @@ -221,16 +221,16 @@ gtk_cell_renderer_combo_init (GtkCellRendererCombo *self) } /** - * gtk_cell_renderer_combo_new: - * - * Creates a new #GtkCellRendererCombo. - * Adjust how text is drawn using object properties. - * Object properties can be set globally (with g_object_set()). - * Also, with #GtkTreeViewColumn, you can bind a property to a value - * in a #GtkTreeModel. For example, you can bind the “text” property - * on the cell renderer to a string value in the model, thus rendering - * a different string in each row of the #GtkTreeView. - * + * gtk_cell_renderer_combo_new: + * + * Creates a new `GtkCellRendererCombo`. + * Adjust how text is drawn using object properties. + * Object properties can be set globally (with g_object_set()). + * Also, with `GtkTreeViewColumn`, you can bind a property to a value + * in a `GtkTreeModel`. For example, you can bind the “text” property + * on the cell renderer to a string value in the model, thus rendering + * a different string in each row of the `GtkTreeView`. + * * Returns: the new cell renderer */ GtkCellRenderer * diff --git a/gtk/gtkcellrendererpixbuf.c b/gtk/gtkcellrendererpixbuf.c index 403595ef46..a90405458d 100644 --- a/gtk/gtkcellrendererpixbuf.c +++ b/gtk/gtkcellrendererpixbuf.c @@ -35,17 +35,17 @@ * * Renders a pixbuf in a cell * - * A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows - * to render either a given #GdkPixbuf (set via the - * #GtkCellRendererPixbuf:pixbuf property) or a named icon (set via the - * #GtkCellRendererPixbuf:icon-name property). + * A `GtkCellRendererPixbuf` can be used to render an image in a cell. It allows + * to render either a given `GdkPixbuf` (set via the + * `GtkCellRendererPixbuf:pixbuf` property) or a named icon (set via the + * `GtkCellRendererPixbuf:icon-name` property). * - * To support the tree view, #GtkCellRendererPixbuf also supports rendering two - * alternative pixbufs, when the #GtkCellRenderer:is-expander property is %TRUE. - * If the #GtkCellRenderer:is-expanded property is %TRUE and the - * #GtkCellRendererPixbuf:pixbuf-expander-open property is set to a pixbuf, it - * renders that pixbuf, if the #GtkCellRenderer:is-expanded property is %FALSE - * and the #GtkCellRendererPixbuf:pixbuf-expander-closed property is set to a + * To support the tree view, `GtkCellRendererPixbuf` also supports rendering two + * alternative pixbufs, when the `GtkCellRenderer:is-expander` property is %TRUE. + * If the `GtkCellRenderer:is-expanded property` is %TRUE and the + * `GtkCellRendererPixbuf:pixbuf-expander-open` property is set to a pixbuf, it + * renders that pixbuf, if the `GtkCellRenderer:is-expanded` property is %FALSE + * and the `GtkCellRendererPixbuf:pixbuf-expander-closed` property is set to a * pixbuf, it renders that one. */ @@ -230,7 +230,7 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class) /** * GtkCellRendererPixbuf:icon-size: * - * The #GtkIconSize value that specifies the size of the rendered icon. + * The `GtkIconSize` value that specifies the size of the rendered icon. */ g_object_class_install_property (object_class, PROP_ICON_SIZE, @@ -415,13 +415,13 @@ gtk_cell_renderer_pixbuf_set_property (GObject *object, /** * gtk_cell_renderer_pixbuf_new: * - * Creates a new #GtkCellRendererPixbuf. Adjust rendering + * Creates a new `GtkCellRendererPixbuf`. Adjust rendering * parameters using object properties. Object properties can be set - * globally (with g_object_set()). Also, with #GtkTreeViewColumn, you - * can bind a property to a value in a #GtkTreeModel. For example, you + * globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you + * can bind a property to a value in a `GtkTreeModel`. For example, you * can bind the “pixbuf” property on the cell renderer to a pixbuf value * in the model, thus rendering a different image in each row of the - * #GtkTreeView. + * `GtkTreeView`. * * Returns: the new cell renderer **/ diff --git a/gtk/gtkcellrendererprogress.c b/gtk/gtkcellrendererprogress.c index a2ce5a783d..8139a3b058 100644 --- a/gtk/gtkcellrendererprogress.c +++ b/gtk/gtkcellrendererprogress.c @@ -39,7 +39,7 @@ * * Renders numbers as progress bars * - * #GtkCellRendererProgress renders a numeric value as a progress par in a cell. + * `GtkCellRendererProgress` renders a numeric value as a progress par in a cell. * Additionally, it can display a text on top of the progress bar. */ @@ -727,7 +727,7 @@ gtk_cell_renderer_progress_init (GtkCellRendererProgress *cellprogress) /** * gtk_cell_renderer_progress_new: * - * Creates a new #GtkCellRendererProgress. + * Creates a new `GtkCellRendererProgress`. * * Returns: the new cell renderer **/ diff --git a/gtk/gtkcellrendererspin.c b/gtk/gtkcellrendererspin.c index 22a7bb6b5c..5636abbd41 100644 --- a/gtk/gtkcellrendererspin.c +++ b/gtk/gtkcellrendererspin.c @@ -35,19 +35,19 @@ * * Renders a spin button in a cell * - * #GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from - * which it is derived. But while #GtkCellRendererText offers a simple entry to - * edit the text, #GtkCellRendererSpin offers a #GtkSpinButton widget. Of course, + * `GtkCellRendererSpin` renders text in a cell like `GtkCellRendererText` from + * which it is derived. But while `GtkCellRendererText` offers a simple entry to + * edit the text, `GtkCellRendererSpin` offers a `GtkSpinButton` widget. Of course, * that means that the text has to be parseable as a floating point number. * * The range of the spinbutton is taken from the adjustment property of the * cell renderer, which can be set explicitly or mapped to a column in the - * tree model, like all properties of cell renders. #GtkCellRendererSpin - * also has properties for the #GtkCellRendererSpin:climb-rate and the number - * of #GtkCellRendererSpin:digits to display. Other #GtkSpinButton properties - * can be set in a handler for the #GtkCellRenderer::editing-started signal. + * tree model, like all properties of cell renders. `GtkCellRendererSpin` + * also has properties for the `GtkCellRendererSpin:climb-rate` and the number + * of `GtkCellRendererSpin:digits` to display. Other `GtkSpinButton` properties + * can be set in a handler for the `GtkCellRenderer::editing-started` signal. * - * The #GtkCellRendererSpin cell renderer was added in GTK 2.10. + * The `GtkCellRendererSpin` cell renderer was added in GTK 2.10. */ typedef struct _GtkCellRendererSpinClass GtkCellRendererSpinClass; @@ -372,9 +372,9 @@ gtk_cell_renderer_spin_start_editing (GtkCellRenderer *cell, /** * gtk_cell_renderer_spin_new: * - * Creates a new #GtkCellRendererSpin. + * Creates a new `GtkCellRendererSpin`. * - * Returns: a new #GtkCellRendererSpin + * Returns: a new `GtkCellRendererSpin` */ GtkCellRenderer * gtk_cell_renderer_spin_new (void) diff --git a/gtk/gtkcellrendererspinner.c b/gtk/gtkcellrendererspinner.c index 64a08c10af..a92488919f 100644 --- a/gtk/gtkcellrendererspinner.c +++ b/gtk/gtkcellrendererspinner.c @@ -43,13 +43,13 @@ * * Renders a spinning animation in a cell * - * GtkCellRendererSpinner renders a spinning animation in a cell, very - * similar to #GtkSpinner. It can often be used as an alternative - * to a #GtkCellRendererProgress for displaying indefinite activity, + * `GtkCellRendererSpinner` renders a spinning animation in a cell, very + * similar to `GtkSpinner`. It can often be used as an alternative + * to a `GtkCellRendererProgress` for displaying indefinite activity, * instead of actual progress. * - * To start the animation in a cell, set the #GtkCellRendererSpinner:active - * property to %TRUE and increment the #GtkCellRendererSpinner:pulse property + * To start the animation in a cell, set the `GtkCellRendererSpinner:active` + * property to %TRUE and increment the `GtkCellRendererSpinner:pulse` property * at regular intervals. The usual way to set the cell renderer properties * for each cell is to bind them to columns in your tree model using e.g. * gtk_tree_view_column_add_attribute(). @@ -189,7 +189,7 @@ gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass) * Pulse of the spinner. Increment this value to draw the next frame of the * spinner animation. Usually, you would update this value in a timeout. * - * By default, the #GtkSpinner widget draws one full cycle of the animation, + * By default, the `GtkSpinner` widget draws one full cycle of the animation, * consisting of 12 frames, in 750 milliseconds. */ g_object_class_install_property (object_class, @@ -203,7 +203,7 @@ gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass) /** * GtkCellRendererSpinner:size: * - * The #GtkIconSize value that specifies the size of the rendered spinner. + * The `GtkIconSize` value that specifies the size of the rendered spinner. */ g_object_class_install_property (object_class, PROP_SIZE, @@ -229,7 +229,7 @@ gtk_cell_renderer_spinner_init (GtkCellRendererSpinner *cell) * Returns a new cell renderer which will show a spinner to indicate * activity. * - * Returns: a new #GtkCellRenderer + * Returns: a new `GtkCellRenderer` */ GtkCellRenderer * gtk_cell_renderer_spinner_new (void) diff --git a/gtk/gtkcellrenderertext.c b/gtk/gtkcellrenderertext.c index 1fc2efb0b2..a7f347d72d 100644 --- a/gtk/gtkcellrenderertext.c +++ b/gtk/gtkcellrenderertext.c @@ -38,12 +38,12 @@ * * Renders text in a cell * - * A #GtkCellRendererText renders a given text in its cell, using the font, color and + * A `GtkCellRendererText` renders a given text in its cell, using the font, color and * style information provided by its properties. The text will be ellipsized if it is - * too long and the #GtkCellRendererText:ellipsize property allows it. + * too long and the `GtkCellRendererText:ellipsize` property allows it. * - * If the #GtkCellRenderer:mode is %GTK_CELL_RENDERER_MODE_EDITABLE, - * the #GtkCellRendererText allows to edit its text using an entry. + * If the `GtkCellRenderer:mode` is %GTK_CELL_RENDERER_MODE_EDITABLE, + * the `GtkCellRendererText` allows to edit its text using an entry. */ @@ -286,7 +286,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class) /** * GtkCellRendererText:background-rgba: * - * Background color as a #GdkRGBA + * Background color as a `GdkRGBA` */ text_cell_renderer_props[PROP_BACKGROUND_RGBA] = g_param_spec_boxed ("background-rgba", @@ -304,7 +304,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class) /** * GtkCellRendererText:foreground-rgba: * - * Foreground color as a #GdkRGBA + * Foreground color as a `GdkRGBA` */ text_cell_renderer_props[PROP_FOREGROUND_RGBA] = g_param_spec_boxed ("foreground-rgba", @@ -473,7 +473,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class) * For cell renderers that ellipsize or wrap text; this property * controls the maximum reported width of the cell. The * cell should not receive any greater allocation unless it is - * set to expand in its #GtkCellLayout and all of the cell's siblings + * set to expand in its `GtkCellLayout` and all of the cell's siblings * have received their natural width. **/ text_cell_renderer_props[PROP_MAX_WIDTH_CHARS] = @@ -522,7 +522,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class) * Specifies how to align the lines of text with respect to each other. * * Note that this property describes how to align the lines of text in - * case there are several of them. The "xalign" property of #GtkCellRenderer, + * case there are several of them. The "xalign" property of `GtkCellRenderer`, * on the other hand, sets the horizontal alignment of the whole text. */ text_cell_renderer_props[PROP_ALIGN] = @@ -536,8 +536,8 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class) /** * GtkCellRendererText:placeholder-text: * - * The text that will be displayed in the #GtkCellRenderer if - * #GtkCellRendererText:editable is %TRUE and the cell is empty. + * The text that will be displayed in the `GtkCellRenderer` if + * `GtkCellRendererText:editable` is %TRUE and the cell is empty. */ text_cell_renderer_props[PROP_PLACEHOLDER_TEXT] = g_param_spec_string ("placeholder-text", @@ -1388,13 +1388,13 @@ gtk_cell_renderer_text_set_property (GObject *object, /** * gtk_cell_renderer_text_new: * - * Creates a new #GtkCellRendererText. Adjust how text is drawn using + * Creates a new `GtkCellRendererText`. Adjust how text is drawn using * object properties. Object properties can be - * set globally (with g_object_set()). Also, with #GtkTreeViewColumn, - * you can bind a property to a value in a #GtkTreeModel. For example, + * set globally (with g_object_set()). Also, with `GtkTreeViewColumn`, + * you can bind a property to a value in a `GtkTreeModel`. For example, * you can bind the “text” property on the cell renderer to a string * value in the model, thus rendering a different string in each row - * of the #GtkTreeView + * of the `GtkTreeView`. * * Returns: the new cell renderer **/ @@ -1847,7 +1847,7 @@ gtk_cell_renderer_text_start_editing (GtkCellRenderer *cell, /** * gtk_cell_renderer_text_set_fixed_height_from_font: - * @renderer: A #GtkCellRendererText + * @renderer: A `GtkCellRendererText` * @number_of_rows: Number of rows of text each cell renderer is allocated, or -1 * * Sets the height of a renderer to explicitly be determined by the “font” and diff --git a/gtk/gtkcellrenderertoggle.c b/gtk/gtkcellrenderertoggle.c index c1fa15e402..3f2f7e1556 100644 --- a/gtk/gtkcellrenderertoggle.c +++ b/gtk/gtkcellrenderertoggle.c @@ -37,10 +37,10 @@ * * Renders a toggle button in a cell * - * #GtkCellRendererToggle renders a toggle button in a cell. The + * `GtkCellRendererToggle` renders a toggle button in a cell. The * button is drawn as a radio or a checkbutton, depending on the - * #GtkCellRendererToggle:radio property. - * When activated, it emits the #GtkCellRendererToggle::toggled signal. + * `GtkCellRendererToggle:radio` property. + * When activated, it emits the `GtkCellRendererToggle::toggled` signal. */ @@ -226,7 +226,7 @@ gtk_cell_renderer_toggle_class_init (GtkCellRendererToggleClass *class) /** * GtkCellRendererToggle::toggled: * @cell_renderer: the object which received the signal - * @path: string representation of #GtkTreePath describing the + * @path: string representation of `GtkTreePath` describing the * event location * * The ::toggled signal is emitted when the cell is toggled. @@ -324,10 +324,10 @@ gtk_cell_renderer_toggle_set_property (GObject *object, /** * gtk_cell_renderer_toggle_new: * - * Creates a new #GtkCellRendererToggle. Adjust rendering + * Creates a new `GtkCellRendererToggle`. Adjust rendering * parameters using object properties. Object properties can be set - * globally (with g_object_set()). Also, with #GtkTreeViewColumn, you - * can bind a property to a value in a #GtkTreeModel. For example, you + * globally (with g_object_set()). Also, with `GtkTreeViewColumn`, you + * can bind a property to a value in a `GtkTreeModel`. For example, you * can bind the “active” property on the cell renderer to a boolean value * in the model, thus causing the check button to reflect the state of * the model. @@ -531,15 +531,15 @@ gtk_cell_renderer_toggle_activate (GtkCellRenderer *cell, /** * gtk_cell_renderer_toggle_set_radio: - * @toggle: a #GtkCellRendererToggle + * @toggle: a `GtkCellRendererToggle` * @radio: %TRUE to make the toggle look like a radio button * * If @radio is %TRUE, the cell renderer renders a radio toggle * (i.e. a toggle in a group of mutually-exclusive toggles). * If %FALSE, it renders a check toggle (a standalone boolean option). * This can be set globally for the cell renderer, or changed just - * before rendering each cell in the model (for #GtkTreeView, you set - * up a per-row setting using #GtkTreeViewColumn to associate model + * before rendering each cell in the model (for `GtkTreeView`, you set + * up a per-row setting using `GtkTreeViewColumn` to associate model * columns with cell renderer properties). **/ void @@ -555,7 +555,7 @@ gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle, /** * gtk_cell_renderer_toggle_get_radio: - * @toggle: a #GtkCellRendererToggle + * @toggle: a `GtkCellRendererToggle` * * Returns whether we’re rendering radio toggles rather than checkboxes. * @@ -573,7 +573,7 @@ gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle) /** * gtk_cell_renderer_toggle_get_active: - * @toggle: a #GtkCellRendererToggle + * @toggle: a `GtkCellRendererToggle` * * Returns whether the cell renderer is active. See * gtk_cell_renderer_toggle_set_active(). @@ -592,7 +592,7 @@ gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle) /** * gtk_cell_renderer_toggle_set_active: - * @toggle: a #GtkCellRendererToggle. + * @toggle: a `GtkCellRendererToggle`. * @setting: the value to set. * * Activates or deactivates a cell renderer. @@ -608,7 +608,7 @@ gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle, /** * gtk_cell_renderer_toggle_get_activatable: - * @toggle: a #GtkCellRendererToggle + * @toggle: a `GtkCellRendererToggle` * * Returns whether the cell renderer is activatable. See * gtk_cell_renderer_toggle_set_activatable(). @@ -627,7 +627,7 @@ gtk_cell_renderer_toggle_get_activatable (GtkCellRendererToggle *toggle) /** * gtk_cell_renderer_toggle_set_activatable: - * @toggle: a #GtkCellRendererToggle. + * @toggle: a `GtkCellRendererToggle`. * @setting: the value to set. * * Makes the cell renderer activatable. diff --git a/gtk/gtkcellview.c b/gtk/gtkcellview.c index 57a8b82b4e..29a8b3119e 100644 --- a/gtk/gtkcellview.c +++ b/gtk/gtkcellview.c @@ -38,15 +38,15 @@ * * A widget displaying a single row of a GtkTreeModel * - * A #GtkCellView displays a single row of a #GtkTreeModel using a #GtkCellArea - * and #GtkCellAreaContext. A #GtkCellAreaContext can be provided to the - * #GtkCellView at construction time in order to keep the cellview in context + * A `GtkCellView` displays a single row of a `GtkTreeModel` using a `GtkCellArea` + * and `GtkCellAreaContext`. A `GtkCellAreaContext` can be provided to the + * `GtkCellView` at construction time in order to keep the cellview in context * of a group of cell views, this ensures that the renderers displayed will * be properly aligned with each other (like the aligned cells in the menus - * of #GtkComboBox). + * of `GtkComboBox`). * - * #GtkCellView is #GtkOrientable in order to decide in which orientation - * the underlying #GtkCellAreaContext should be allocated. Taking the #GtkComboBox + * `GtkCellView` is `GtkOrientable` in order to decide in which orientation + * the underlying `GtkCellAreaContext` should be allocated. Taking the `GtkComboBox` * menu as an example, cellviews should be oriented horizontally if the menus are * listed top-to-bottom and thus all share the same width but may have separate * individual heights (left-to-right menus should be allocated vertically since @@ -205,10 +205,10 @@ gtk_cell_view_class_init (GtkCellViewClass *klass) /** * GtkCellView:cell-area: * - * The #GtkCellArea rendering cells + * The `GtkCellArea` rendering cells * * If no area is specified when creating the cell view with gtk_cell_view_new_with_context() - * a horizontally oriented #GtkCellAreaBox will be used. + * a horizontally oriented `GtkCellArea`Box will be used. * * since 3.0 */ @@ -223,13 +223,13 @@ gtk_cell_view_class_init (GtkCellViewClass *klass) /** * GtkCellView:cell-area-context: * - * The #GtkCellAreaContext used to compute the geometry of the cell view. + * The `GtkCellAreaContext` used to compute the geometry of the cell view. * * A group of cell views can be assigned the same context in order to * ensure the sizes and cell alignments match across all the views with * the same context. * - * #GtkComboBox menus uses this to assign the same context to all cell views + * `GtkComboBox` menus uses this to assign the same context to all cell views * in the menu items for a single menu (each submenu creates its own * context since the size of each submenu does not depend on parent * or sibling menus). @@ -817,9 +817,9 @@ row_changed_cb (GtkTreeModel *model, /** * gtk_cell_view_new: * - * Creates a new #GtkCellView widget. + * Creates a new `GtkCellView` widget. * - * Returns: A newly created #GtkCellView widget. + * Returns: A newly created `GtkCellView` widget. */ GtkWidget * gtk_cell_view_new (void) @@ -834,18 +834,18 @@ gtk_cell_view_new (void) /** * gtk_cell_view_new_with_context: - * @area: the #GtkCellArea to layout cells - * @context: the #GtkCellAreaContext in which to calculate cell geometry + * @area: the `GtkCellArea` to layout cells + * @context: the `GtkCellAreaContext` in which to calculate cell geometry * - * Creates a new #GtkCellView widget with a specific #GtkCellArea - * to layout cells and a specific #GtkCellAreaContext. + * Creates a new `GtkCellView` widget with a specific `GtkCellArea` + * to layout cells and a specific `GtkCellAreaContext`. * * Specifying the same context for a handful of cells lets * the underlying area synchronize the geometry for those cells, * in this way alignments with cellviews for other rows are * possible. * - * Returns: A newly created #GtkCellView widget. + * Returns: A newly created `GtkCellView` widget. */ GtkWidget * gtk_cell_view_new_with_context (GtkCellArea *area, @@ -864,10 +864,10 @@ gtk_cell_view_new_with_context (GtkCellArea *area, * gtk_cell_view_new_with_text: * @text: the text to display in the cell view * - * Creates a new #GtkCellView widget, adds a #GtkCellRendererText + * Creates a new `GtkCellView` widget, adds a `GtkCellRendererText` * to it, and makes it show @text. * - * Returns: A newly created #GtkCellView widget. + * Returns: A newly created `GtkCellView` widget. */ GtkWidget * gtk_cell_view_new_with_text (const char *text) @@ -894,11 +894,11 @@ gtk_cell_view_new_with_text (const char *text) * gtk_cell_view_new_with_markup: * @markup: the text to display in the cell view * - * Creates a new #GtkCellView widget, adds a #GtkCellRendererText + * Creates a new `GtkCellView` widget, adds a `GtkCellRendererText` * to it, and makes it show @markup. The text can be * marked up with the [Pango text markup language][PangoMarkupFormat]. * - * Returns: A newly created #GtkCellView widget. + * Returns: A newly created `GtkCellView` widget. */ GtkWidget * gtk_cell_view_new_with_markup (const char *markup) @@ -925,10 +925,10 @@ gtk_cell_view_new_with_markup (const char *markup) * gtk_cell_view_new_with_texture: * @texture: the image to display in the cell view * - * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf + * Creates a new `GtkCellView` widget, adds a `GtkCellRendererPixbuf` * to it, and makes it show @texture. * - * Returns: A newly created #GtkCellView widget. + * Returns: A newly created `GtkCellView` widget. */ GtkWidget * gtk_cell_view_new_with_texture (GdkTexture *texture) @@ -953,7 +953,7 @@ gtk_cell_view_new_with_texture (GdkTexture *texture) /** * gtk_cell_view_set_value: - * @cell_view: a #GtkCellView widget + * @cell_view: a `GtkCellView` widget * @renderer: one of the renderers of @cell_view * @property: the name of the property of @renderer to set * @value: the new value to set the property to @@ -976,8 +976,8 @@ gtk_cell_view_set_value (GtkCellView *cell_view, /** * gtk_cell_view_set_model: - * @cell_view: a #GtkCellView - * @model: (nullable): a #GtkTreeModel + * @cell_view: a `GtkCellView` + * @model: (nullable): a `GtkTreeModel` * * Sets the model for @cell_view. If @cell_view already has a model * set, it will remove it before setting the new model. If @model is @@ -1018,12 +1018,12 @@ gtk_cell_view_set_model (GtkCellView *cell_view, /** * gtk_cell_view_get_model: - * @cell_view: a #GtkCellView + * @cell_view: a `GtkCellView` * * Returns the model for @cell_view. If no model is used %NULL is * returned. * - * Returns: (nullable) (transfer none): a #GtkTreeModel used + * Returns: (nullable) (transfer none): a `GtkTreeModel` used */ GtkTreeModel * gtk_cell_view_get_model (GtkCellView *cell_view) @@ -1037,15 +1037,15 @@ gtk_cell_view_get_model (GtkCellView *cell_view) /** * gtk_cell_view_set_displayed_row: - * @cell_view: a #GtkCellView - * @path: (nullable): a #GtkTreePath or %NULL to unset. + * @cell_view: a `GtkCellView` + * @path: (nullable): a `GtkTreePath` or %NULL to unset. * * Sets the row of the model that is currently displayed - * by the #GtkCellView. If the path is unset, then the + * by the `GtkCellView`. If the path is unset, then the * contents of the cellview “stick” at their last value; * this is not normally a desired result, but may be * a needed intermediate state if say, the model for - * the #GtkCellView becomes temporarily empty. + * the `GtkCellView` becomes temporarily empty. **/ void gtk_cell_view_set_displayed_row (GtkCellView *cell_view, @@ -1071,9 +1071,9 @@ gtk_cell_view_set_displayed_row (GtkCellView *cell_view, /** * gtk_cell_view_get_displayed_row: - * @cell_view: a #GtkCellView + * @cell_view: a `GtkCellView` * - * Returns a #GtkTreePath referring to the currently + * Returns a `GtkTreePath` referring to the currently * displayed row. If no row is currently displayed, * %NULL is returned. * @@ -1094,7 +1094,7 @@ gtk_cell_view_get_displayed_row (GtkCellView *cell_view) /** * gtk_cell_view_get_draw_sensitive: - * @cell_view: a #GtkCellView + * @cell_view: a `GtkCellView` * * Gets whether @cell_view is configured to draw all of its * cells in a sensitive state. @@ -1114,11 +1114,11 @@ gtk_cell_view_get_draw_sensitive (GtkCellView *cell_view) /** * gtk_cell_view_set_draw_sensitive: - * @cell_view: a #GtkCellView + * @cell_view: a `GtkCellView` * @draw_sensitive: whether to draw all cells in a sensitive state. * * Sets whether @cell_view should draw all of its - * cells in a sensitive state, this is used by #GtkComboBox menus + * cells in a sensitive state, this is used by `GtkComboBox` menus * to ensure that rows with insensitive cells that contain * children appear sensitive in the parent menu item. */ @@ -1140,13 +1140,13 @@ gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view, /** * gtk_cell_view_get_fit_model: - * @cell_view: a #GtkCellView + * @cell_view: a `GtkCellView` * * Gets whether @cell_view is configured to request space - * to fit the entire #GtkTreeModel. + * to fit the entire `GtkTreeModel`. * * Returns: whether @cell_view requests space to fit - * the entire #GtkTreeModel. + * the entire `GtkTreeModel`. */ gboolean gtk_cell_view_get_fit_model (GtkCellView *cell_view) @@ -1160,12 +1160,12 @@ gtk_cell_view_get_fit_model (GtkCellView *cell_view) /** * gtk_cell_view_set_fit_model: - * @cell_view: a #GtkCellView + * @cell_view: a `GtkCellView` * @fit_model: whether @cell_view should request space for the whole model. * - * Sets whether @cell_view should request space to fit the entire #GtkTreeModel. + * Sets whether @cell_view should request space to fit the entire `GtkTreeModel`. * - * This is used by #GtkComboBox to ensure that the cell view displayed on + * This is used by `GtkComboBox` to ensure that the cell view displayed on * the combo box’s button always gets enough space and does not resize * when selection changes. */ diff --git a/gtk/gtkcolumnlistitemfactoryprivate.h b/gtk/gtkcolumnlistitemfactoryprivate.h index 557ca11875..acddf2f56e 100644 --- a/gtk/gtkcolumnlistitemfactoryprivate.h +++ b/gtk/gtkcolumnlistitemfactoryprivate.h @@ -35,7 +35,7 @@ G_BEGIN_DECLS /** * GtkColumnListItemFactory: * - * The object for the #GtkColumnListItemFactory. + * The object for the `GtkColumnListItemFactory`. **/ typedef struct _GtkColumnListItemFactory GtkColumnListItemFactory; typedef struct _GtkColumnListItemFactoryClass GtkColumnListItemFactoryClass; diff --git a/gtk/gtkcolumnview.c b/gtk/gtkcolumnview.c index 5bb6f2e8d5..7aeb8a285a 100644 --- a/gtk/gtkcolumnview.c +++ b/gtk/gtkcolumnview.c @@ -1371,7 +1371,7 @@ gtk_column_view_get_model (GtkColumnView *self) /** * gtk_column_view_set_model: (attributes org.gtk.Method.set_property=model) - * @self: a #GtkColumnView + * @self: a `GtkColumnView` * @model: (nullable) (transfer none): the model to use * * Sets the model to use. diff --git a/gtk/gtkcolumnviewcolumn.c b/gtk/gtkcolumnviewcolumn.c index 32eb8dd7b5..ad62b34eca 100644 --- a/gtk/gtkcolumnviewcolumn.c +++ b/gtk/gtkcolumnviewcolumn.c @@ -876,7 +876,7 @@ gtk_column_view_column_set_header_menu (GtkColumnViewColumn *self, * Gets the menu model that is used to create the context menu * for the column header. * - * Returns: (transfer none) (nullable): the #GMenuModel + * Returns: (transfer none) (nullable): the `GMenuModel` */ GMenuModel * gtk_column_view_column_get_header_menu (GtkColumnViewColumn *self) diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c index 69e8ea949a..e65ebf4ef1 100644 --- a/gtk/gtkcombobox.c +++ b/gtk/gtkcombobox.c @@ -731,7 +731,7 @@ gtk_combo_box_class_init (GtkComboBoxClass *klass) P_("Entry Text Column"), P_("The column in the combo box’s model to associate " "with strings from the entry if the combo was " - "created with #GtkComboBox:has-entry = %TRUE"), + "created with GtkComboBox:has-entry = %TRUE"), -1, G_MAXINT, -1, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY)); diff --git a/gtk/gtkconstraint.c b/gtk/gtkconstraint.c index 191015f232..b0fd0cceec 100644 --- a/gtk/gtkconstraint.c +++ b/gtk/gtkconstraint.c @@ -182,9 +182,9 @@ gtk_constraint_class_init (GtkConstraintClass *klass) * * The target of the constraint. * - * The constraint will set the #GtkConstraint:target-attribute of the - * target using the #GtkConstraint:source-attribute of the source - * widget. + * The constraint will set the [property@Gtk.Constraint:target-attribute] + * property of the target using the [property@Gtk.Constraint:source-attribute] + * property of the source widget. * * */ @@ -196,10 +196,11 @@ gtk_constraint_class_init (GtkConstraintClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY); + /** * GtkConstraint:target-attribute: (attributes org.gtk.Property.get=gtk_constraint_get_target_attribute) * - * The attribute of the #GtkConstraint:target set by the constraint. + * The attribute of the [property@Gtk.Constraint:target] set by the constraint. */ obj_props[PROP_TARGET_ATTRIBUTE] = g_param_spec_enum ("target-attribute", @@ -210,6 +211,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY); + /** * GtkConstraint:relation: (attributes org.gtk.Property.get=gtk_constraint_get_relation) * @@ -224,14 +226,15 @@ gtk_constraint_class_init (GtkConstraintClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY); + /** * GtkConstraint:source: (attributes org.gtk.Property.get=gtk_constraint_get_source) * * The source of the constraint. * * The constraint will set the [property@Gtk.Constraint:target-attribute] - * of the target using the [property@Gtk.Constraint:source-attribute] - * of the source. + * property of the target using the [property@Gtk.Constraint:source-attribute] + * property of the source. */ obj_props[PROP_SOURCE] = g_param_spec_object ("source", @@ -256,6 +259,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY); + /** * GtkConstraint:multiplier: (attributes org.gtk.Property.get=gtk_constraint_get_multiplier) * @@ -270,6 +274,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY); + /** * GtkConstraint:constant: (attributes org.gtk.Property.get=gtk_constraint_get_constant) * @@ -283,6 +288,7 @@ gtk_constraint_class_init (GtkConstraintClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY); + /** * GtkConstraint:strength: (attributes org.gtk.Property.get=gtk_constraint_get_strength) * @@ -400,7 +406,7 @@ gtk_constraint_new_constant (gpointer target, * If the targe is set to `NULL` at creation, the constraint will use * the widget using the [class@Gtk.ConstraintLayout] as the target. * - * Returns: (transfer none) (nullable): a #GtkConstraintTarget + * Returns: (transfer none) (nullable): a `GtkConstraintTarget` */ GtkConstraintTarget * gtk_constraint_get_target (GtkConstraint *constraint) @@ -428,7 +434,7 @@ gtk_constraint_get_target_attribute (GtkConstraint *constraint) /** * gtk_constraint_get_source: (attributes org.gtk.Method.get_property=source) - * @constraint: a #GtkConstraint + * @constraint: a `GtkConstraint` * * Retrieves the [iface@Gtk.ConstraintTarget] used as the source for the * constraint. diff --git a/gtk/gtkconstraintexpression.c b/gtk/gtkconstraintexpression.c index 42dffdc7d8..6c571ae14c 100644 --- a/gtk/gtkconstraintexpression.c +++ b/gtk/gtkconstraintexpression.c @@ -70,14 +70,14 @@ gtk_constraint_variable_init (GtkConstraintVariable *variable, * gtk_constraint_variable_new_dummy: * @name: the name of the variable * - * Allocates and initializes a new #GtkConstraintVariable for a "dummy" + * Allocates and initializes a new `GtkConstraintVariable` for a "dummy" * symbol. Dummy symbols are typically used as markers inside a solver, * and will not be factored in the solution when pivoting the tableau * of the constraint equations. * - * Only #GtkConstraintSolver should use this function. + * Only `GtkConstraintSolver` should use this function. * - * Returns: a newly allocated #GtkConstraintVariable + * Returns: a newly allocated `GtkConstraintVariable` */ GtkConstraintVariable * gtk_constraint_variable_new_dummy (const char *name) @@ -98,13 +98,13 @@ gtk_constraint_variable_new_dummy (const char *name) * gtk_constraint_variable_new_objective: * @name: the name of the variable * - * Allocates and initializes a new #GtkConstraintVariable for an objective + * Allocates and initializes a new `GtkConstraintVariable` for an objective * symbol. This is the constant value we wish to find as the result of the * simplex optimization. * - * Only #GtkConstraintSolver should use this function. + * Only `GtkConstraintSolver` should use this function. * - * Returns: a newly allocated #GtkConstraintVariable + * Returns: a newly allocated `GtkConstraintVariable` */ GtkConstraintVariable * gtk_constraint_variable_new_objective (const char *name) @@ -125,7 +125,7 @@ gtk_constraint_variable_new_objective (const char *name) * gtk_constraint_variable_new_slack: * @name: the name of the variable * - * Allocates and initializes a new #GtkConstraintVariable for a "slack" + * Allocates and initializes a new `GtkConstraintVariable` for a "slack" * symbol. Slack variables are introduced inside the tableau to turn * inequalities, like: * @@ -139,9 +139,9 @@ gtk_constraint_variable_new_objective (const char *name) * expr - slack = 0 * ]| * - * Only #GtkConstraintSolver should use this function. + * Only `GtkConstraintSolver` should use this function. * - * Returns: a newly allocated #GtkConstraintVariable + * Returns: a newly allocated `GtkConstraintVariable` */ GtkConstraintVariable * gtk_constraint_variable_new_slack (const char *name) @@ -163,15 +163,15 @@ gtk_constraint_variable_new_slack (const char *name) * @prefix: (nullable): an optional prefix string for @name * @name: (nullable): an optional name for the variable * - * Allocates and initializes a new #GtkConstraintVariable for a regular + * Allocates and initializes a new `GtkConstraintVariable` for a regular * symbol. All variables introduced by constraints are regular variables. * - * Only #GtkConstraintSolver should use this function; a constraint layout - * manager should ask the #GtkConstraintSolver to create a variable, using + * Only `GtkConstraintSolver` should use this function; a constraint layout + * manager should ask the `GtkConstraintSolver` to create a variable, using * gtk_constraint_solver_create_variable(), which will insert the variable * in the solver's tableau. * - * Returns: a newly allocated #GtkConstraintVariable + * Returns: a newly allocated `GtkConstraintVariable` */ GtkConstraintVariable * gtk_constraint_variable_new (const char *prefix, @@ -191,11 +191,11 @@ gtk_constraint_variable_new (const char *prefix, /*< private > * gtk_constraint_variable_ref: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * * Acquires a reference to @variable. * - * Returns: (transfer full): the given #GtkConstraintVariable, with its reference + * Returns: (transfer full): the given `GtkConstraintVariable`, with its reference * count increased */ GtkConstraintVariable * @@ -208,7 +208,7 @@ gtk_constraint_variable_ref (GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_unref: - * @variable: (transfer full): a #GtkConstraintVariable + * @variable: (transfer full): a `GtkConstraintVariable` * * Releases a reference to @variable. */ @@ -222,9 +222,9 @@ gtk_constraint_variable_unref (GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_set_value: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * - * Sets the current value of a #GtkConstraintVariable. + * Sets the current value of a `GtkConstraintVariable`. */ void gtk_constraint_variable_set_value (GtkConstraintVariable *variable, @@ -235,9 +235,9 @@ gtk_constraint_variable_set_value (GtkConstraintVariable *variable, /*< private > * gtk_constraint_variable_get_value: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * - * Retrieves the current value of a #GtkConstraintVariable + * Retrieves the current value of a `GtkConstraintVariable` * * Returns: the value of the variable */ @@ -249,7 +249,7 @@ gtk_constraint_variable_get_value (const GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_to_string: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * * Turns @variable into a string, for debugging purposes. * @@ -311,7 +311,7 @@ gtk_constraint_variable_to_string (const GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_is_external: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * * Checks whether the @variable was introduced from outside the solver. * @@ -325,7 +325,7 @@ gtk_constraint_variable_is_external (const GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_is_pivotable: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * * Checks whether the @variable can be used as a pivot. * @@ -339,7 +339,7 @@ gtk_constraint_variable_is_pivotable (const GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_is_restricted: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * * Checks whether the @variable's use is restricted. * @@ -353,7 +353,7 @@ gtk_constraint_variable_is_restricted (const GtkConstraintVariable *variable) /*< private > * gtk_constraint_variable_is_dummy: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * * Checks whether the @variable is a dummy symbol. * @@ -380,9 +380,9 @@ struct _GtkConstraintVariableSet { /*< private > * gtk_constraint_variable_set_free: - * @set: a #GtkConstraintVariableSet + * @set: a `GtkConstraintVariable`Set * - * Frees the resources associated to a #GtkConstraintVariableSet/ + * Frees the resources associated to a `GtkConstraintVariable`Set/ */ void gtk_constraint_variable_set_free (GtkConstraintVariableSet *set) @@ -397,7 +397,7 @@ gtk_constraint_variable_set_free (GtkConstraintVariableSet *set) /*< private > * gtk_constraint_variable_set_new: * - * Creates a new #GtkConstraintVariableSet. + * Creates a new `GtkConstraintVariable`Set. * * Returns: the newly created variable set */ @@ -428,8 +428,8 @@ sort_by_variable_id (gconstpointer a, /*< private > * gtk_constraint_variable_set_add: - * @set: a #GtkConstraintVariableSet - * @variable: a #GtkConstraintVariable + * @set: a `GtkConstraintVariable`Set + * @variable: a `GtkConstraintVariable` * * Adds @variable to the given @set, if the @variable is not already * in it. @@ -463,8 +463,8 @@ gtk_constraint_variable_set_add (GtkConstraintVariableSet *set, /*< private > * gtk_constraint_variable_set_remove: - * @set: a #GtkConstraintVariableSet - * @variable: a #GtkConstraintVariable + * @set: a `GtkConstraintVariable`Set + * @variable: a `GtkConstraintVariable` * * Removes @variable from the @set. * @@ -493,7 +493,7 @@ gtk_constraint_variable_set_remove (GtkConstraintVariableSet *set, /*< private > * gtk_constraint_variable_set_size: - * @set: a #GtkConstraintVariableSet + * @set: a `GtkConstraintVariable`Set * * Retrieves the size of the @set. * @@ -520,7 +520,7 @@ gtk_constraint_variable_set_is_singleton (GtkConstraintVariableSet *set) /*< private > * GtkConstraintVariableSetIter: * - * An iterator type for #GtkConstraintVariableSet. + * An iterator type for `GtkConstraintVariable`Set. */ /* Keep in sync with GtkConstraintVariableSetIter */ typedef struct { @@ -533,8 +533,8 @@ typedef struct { /*< private > * gtk_constraint_variable_set_iter_init: - * @iter: a #GtkConstraintVariableSetIter - * @set: the #GtkConstraintVariableSet to iterate + * @iter: a `GtkConstraintVariable`SetIter + * @set: the `GtkConstraintVariable`Set to iterate * * Initializes @iter for iterating over @set. */ @@ -554,10 +554,10 @@ gtk_constraint_variable_set_iter_init (GtkConstraintVariableSetIter *iter, /*< private > * gtk_constraint_variable_set_iter_next: - * @iter: a #GtkConstraintVariableSetIter + * @iter: a `GtkConstraintVariable`SetIter * @variable_p: (out): the next variable in the set * - * Advances the @iter to the next variable in the #GtkConstraintVariableSet. + * Advances the @iter to the next variable in the `GtkConstraintVariable`Set. * * Returns: %TRUE if the iterator was advanced, and %FALSE otherwise */ @@ -583,15 +583,15 @@ gtk_constraint_variable_set_iter_next (GtkConstraintVariableSetIter *iter, /*< private > * gtk_constraint_variable_pair_new: - * @first: a #GtkConstraintVariable - * @second: a #GtkConstraintVariable + * @first: a `GtkConstraintVariable` + * @second: a `GtkConstraintVariable` * - * Creates a new #GtkConstraintVariablePair, containing @first and @second. + * Creates a new `GtkConstraintVariable`Pair, containing @first and @second. * - * The #GtkConstraintVariablePair acquires a reference over the two - * given #GtkConstraintVariables. + * The `GtkConstraintVariable`Pair acquires a reference over the two + * given `GtkConstraintVariable`s. * - * Returns: a new #GtkConstraintVariablePair + * Returns: a new `GtkConstraintVariable`Pair */ GtkConstraintVariablePair * gtk_constraint_variable_pair_new (GtkConstraintVariable *first, @@ -607,7 +607,7 @@ gtk_constraint_variable_pair_new (GtkConstraintVariable *first, /*< private > * gtk_constraint_variable_pair_free: - * @pair: a #GtkConstraintVariablePair + * @pair: a `GtkConstraintVariable`Pair * * Frees the resources associated by @pair. */ @@ -626,7 +626,7 @@ gtk_constraint_variable_pair_free (GtkConstraintVariablePair *pair) /*< private > * Term: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * @coefficient: the coefficient applied to the @variable * @next: the next term in the expression * @prev: the previous term in the expression; @@ -692,12 +692,12 @@ struct _GtkConstraintExpression /*< private > * gtk_constraint_expression_add_term: - * @self: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable + * @self: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` * @coefficient: a coefficient for @variable * * Adds a new term formed by (@variable, @coefficient) into a - * #GtkConstraintExpression. + * `GtkConstraintExpression`. * * The @expression acquires a reference on @variable. */ @@ -790,7 +790,7 @@ gtk_constraint_expression_remove_term (GtkConstraintExpression *self, * gtk_constraint_expression_new: * @constant: a constant for the expression * - * Creates a new #GtkConstraintExpression with the given @constant. + * Creates a new `GtkConstraintExpression` with the given @constant. * * Returns: (transfer full): the newly created expression */ @@ -810,9 +810,9 @@ gtk_constraint_expression_new (double constant) /*< private > * gtk_constraint_expression_new_from_variable: - * @variable: a #GtkConstraintVariable + * @variable: a `GtkConstraintVariable` * - * Creates a new #GtkConstraintExpression with the given @variable. + * Creates a new `GtkConstraintExpression` with the given @variable. * * Returns: (transfer full): the newly created expression */ @@ -828,7 +828,7 @@ gtk_constraint_expression_new_from_variable (GtkConstraintVariable *variable) /*< private > * gtk_constraint_expression_ref: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * * Acquires a reference on @expression. * @@ -858,7 +858,7 @@ gtk_constraint_expression_clear (gpointer data) /*< private > * gtk_constraint_expression_unref: - * @expression: (transfer full): a #GtkConstraintExpression + * @expression: (transfer full): a `GtkConstraintExpression` * * Releases a reference on @expression. */ @@ -870,7 +870,7 @@ gtk_constraint_expression_unref (GtkConstraintExpression *expression) /*< private > * gtk_constraint_expression_is_constant: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * * Checks whether @expression is a constant value, with no variable terms. * @@ -884,7 +884,7 @@ gtk_constraint_expression_is_constant (const GtkConstraintExpression *expression /*< private > * gtk_constraint_expression_set_constant: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * @constant: the value of the constant * * Sets the value of the constant part of @expression. @@ -900,7 +900,7 @@ gtk_constraint_expression_set_constant (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_get_constant: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * * Retrieves the constant value of @expression. * @@ -935,11 +935,11 @@ gtk_constraint_expression_clone (GtkConstraintExpression *expression) /*< private > * gtk_constraint_expression_add_variable: - * @expression: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable to add to @expression + * @expression: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` to add to @expression * @coefficient: the coefficient of @variable - * @subject: (nullable): a #GtkConstraintVariable - * @solver: (nullable): a #GtkConstraintSolver + * @subject: (nullable): a `GtkConstraintVariable` + * @solver: (nullable): a `GtkConstraintSolver` * * Adds a `(@coefficient × @variable)` term to @expression. * @@ -998,8 +998,8 @@ gtk_constraint_expression_add_variable (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_remove_variable: - * @expression: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable + * @expression: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` * * Removes @variable from @expression. */ @@ -1015,8 +1015,8 @@ gtk_constraint_expression_remove_variable (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_set_variable: - * @expression: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable + * @expression: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` * @coefficient: a coefficient for @variable * * Sets the @coefficient for @variable inside an @expression. @@ -1048,8 +1048,8 @@ gtk_constraint_expression_set_variable (GtkConstraintExpression *expression, * @a_expr: first operand * @b_expr: second operand * @n: the multiplication factor for @b_expr - * @subject: (nullable): a #GtkConstraintVariable - * @solver: (nullable): a #GtkConstraintSolver + * @subject: (nullable): a `GtkConstraintVariable` + * @solver: (nullable): a `GtkConstraintSolver` * * Adds `(@n × @b_expr)` to @a_expr. * @@ -1066,7 +1066,7 @@ gtk_constraint_expression_set_variable (GtkConstraintExpression *expression, * a.x + a.width - b.x - b.width = 0 * ]| * - * If @solver is not %NULL, this function will notify a #GtkConstraintSolver + * If @solver is not %NULL, this function will notify a `GtkConstraintSolver` * of every variable that was added or removed from @a_expr. */ void @@ -1096,12 +1096,12 @@ gtk_constraint_expression_add_expression (GtkConstraintExpression *a_expr, /*< private > * gtk_constraint_expression_plus_constant: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * @constant: a constant value * * Adds a @constant value to the @expression. * - * This is the equivalent of creating a new #GtkConstraintExpression for + * This is the equivalent of creating a new `GtkConstraintExpression` for * the @constant and calling gtk_constraint_expression_add_expression(). * * Returns: the @expression @@ -1121,12 +1121,12 @@ gtk_constraint_expression_plus_constant (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_minus_constant: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * @constant: a constant value * * Removes a @constant value from the @expression. * - * This is the equivalent of creating a new #GtkConstraintExpression for + * This is the equivalent of creating a new `GtkConstraintExpression` for * the inverse of @constant and calling gtk_constraint_expression_add_expression(). * * Returns: the @expression @@ -1140,8 +1140,8 @@ gtk_constraint_expression_minus_constant (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_plus_variable: - * @expression: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable + * @expression: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` * * Adds a @variable to the @expression. * @@ -1162,8 +1162,8 @@ gtk_constraint_expression_plus_variable (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_minus_variable: - * @expression: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable + * @expression: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` * * Subtracts a @variable from the @expression. * @@ -1184,7 +1184,7 @@ gtk_constraint_expression_minus_variable (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_multiply_by: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * @factor: the multiplication factor * * Multiplies the constant part and the coefficient of all terms @@ -1217,7 +1217,7 @@ gtk_constraint_expression_multiply_by (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_divide_by: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * @factor: the division factor * * Divides the constant part and the coefficient of all terms @@ -1237,12 +1237,12 @@ gtk_constraint_expression_divide_by (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_new_subject: - * @expression: a #GtkConstraintExpression - * @subject: a #GtkConstraintVariable part of @expression + * @expression: a `GtkConstraintExpression` + * @subject: a `GtkConstraintVariable` part of @expression * * Modifies @expression to have a new @subject. * - * A #GtkConstraintExpression is a linear expression in the form of + * A `GtkConstraintExpression` is a linear expression in the form of * `@expression = 0`. If @expression contains @subject, for instance: * * |[ @@ -1283,9 +1283,9 @@ gtk_constraint_expression_new_subject (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_change_subject: - * @expression: a #GtkConstraintExpression - * @old_subject: the old subject #GtkConstraintVariable of @expression - * @new_subject: the new subject #GtkConstraintVariable of @expression + * @expression: a `GtkConstraintExpression` + * @old_subject: the old subject `GtkConstraintVariable` of @expression + * @new_subject: the new subject `GtkConstraintVariable` of @expression * * Turns an @expression in the form of: * @@ -1318,8 +1318,8 @@ gtk_constraint_expression_change_subject (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_get_coefficient: - * @expression: a #GtkConstraintExpression - * @variable: a #GtkConstraintVariable + * @expression: a `GtkConstraintExpression` + * @variable: a `GtkConstraintVariable` * * Retrieves the coefficient of the term for @variable inside @expression. * @@ -1346,15 +1346,15 @@ gtk_constraint_expression_get_coefficient (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_substitute_out: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * @out_var: the variable to replace * @expr: the expression used to replace @out_var - * @subject: (nullable): a #GtkConstraintVariable - * @solver: (nullable): a #GtkConstraintSolver + * @subject: (nullable): a `GtkConstraintVariable` + * @solver: (nullable): a `GtkConstraintSolver` * * Replaces every term containing @out_var inside @expression with @expr. * - * If @solver is not %NULL, this function will notify the #GtkConstraintSolver + * If @solver is not %NULL, this function will notify the `GtkConstraintSolver` * for every variable added to or removed from @expression. */ void @@ -1412,12 +1412,12 @@ gtk_constraint_expression_substitute_out (GtkConstraintExpression *expression, /*< private > * gtk_constraint_expression_get_pivotable_variable: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * - * Retrieves the first #GtkConstraintVariable in @expression that + * Retrieves the first `GtkConstraintVariable` in @expression that * is marked as pivotable. * - * Returns: (transfer none) (nullable): a #GtkConstraintVariable + * Returns: (transfer none) (nullable): a `GtkConstraintVariable` */ GtkConstraintVariable * gtk_constraint_expression_get_pivotable_variable (GtkConstraintExpression *expression) @@ -1446,7 +1446,7 @@ gtk_constraint_expression_get_pivotable_variable (GtkConstraintExpression *expre /*< private > * gtk_constraint_expression_to_string: - * @expression: a #GtkConstraintExpression + * @expression: a `GtkConstraintExpression` * * Creates a string containing @expression. * @@ -1513,8 +1513,8 @@ typedef struct { /*< private > * gtk_constraint_expression_iter_init: - * @iter: a #GtkConstraintExpressionIter - * @expression: a #GtkConstraintExpression + * @iter: a `GtkConstraintExpression`Iter + * @expression: a `GtkConstraintExpression` * * Initializes an iterator over @expression. */ @@ -1531,11 +1531,11 @@ gtk_constraint_expression_iter_init (GtkConstraintExpressionIter *iter, /*< private > * gtk_constraint_expression_iter_next: - * @iter: a valid #GtkConstraintExpressionIter + * @iter: a valid `GtkConstraintExpression`Iter * @variable: (out): the variable of the next term * @coefficient: (out): the coefficient of the next term * - * Moves the given #GtkConstraintExpressionIter forwards to the next + * Moves the given `GtkConstraintExpression`Iter forwards to the next * term in the expression, starting from the first term. * * Returns: %TRUE if the iterator was moved, and %FALSE if the iterator @@ -1566,11 +1566,11 @@ gtk_constraint_expression_iter_next (GtkConstraintExpressionIter *iter, /*< private > * gtk_constraint_expression_iter_prev: - * @iter: a valid #GtkConstraintExpressionIter + * @iter: a valid `GtkConstraintExpression`Iter * @variable: (out): the variable of the previous term * @coefficient: (out): the coefficient of the previous term * - * Moves the given #GtkConstraintExpressionIter backwards to the previous + * Moves the given `GtkConstraintExpression`Iter backwards to the previous * term in the expression, starting from the last term. * * Returns: %TRUE if the iterator was moved, and %FALSE if the iterator @@ -1618,11 +1618,11 @@ typedef struct /*< private > * gtk_constraint_expression_builder_init: - * @builder: a #GtkConstraintExpressionBuilder - * @solver: a #GtkConstraintSolver + * @builder: a `GtkConstraintExpression`Builder + * @solver: a `GtkConstraintSolver` * - * Initializes the given #GtkConstraintExpressionBuilder for the - * given #GtkConstraintSolver. + * Initializes the given `GtkConstraintExpression`Builder for the + * given `GtkConstraintSolver`. * * You can use the @builder to construct expressions to be added to the * @solver, in the form of constraints. @@ -1666,8 +1666,8 @@ gtk_constraint_expression_builder_init (GtkConstraintExpressionBuilder *builder, /*< private > * gtk_constraint_expression_builder_term: - * @builder: a #GtkConstraintExpressionBuilder - * @term: a #GtkConstraintVariable + * @builder: a `GtkConstraintExpression`Builder + * @term: a `GtkConstraintVariable` * * Adds a variable @term to the @builder. */ @@ -1712,7 +1712,7 @@ gtk_constraint_expression_builder_term (GtkConstraintExpressionBuilder *builder, /*< private > * gtk_constraint_expression_builder_plus: - * @builder: a #GtkConstraintExpressionBuilder + * @builder: a `GtkConstraintExpression`Builder * * Adds a plus operator to the @builder. */ @@ -1726,7 +1726,7 @@ gtk_constraint_expression_builder_plus (GtkConstraintExpressionBuilder *builder) /*< private > * gtk_constraint_expression_builder_minus: - * @builder: a #GtkConstraintExpressionBuilder + * @builder: a `GtkConstraintExpression`Builder * * Adds a minus operator to the @builder. */ @@ -1740,7 +1740,7 @@ gtk_constraint_expression_builder_minus (GtkConstraintExpressionBuilder *builder /*< private > * gtk_constraint_expression_builder_divide_by: - * @builder: a #GtkConstraintExpressionBuilder + * @builder: a `GtkConstraintExpression`Builder * * Adds a division operator to the @builder. */ @@ -1754,7 +1754,7 @@ gtk_constraint_expression_builder_divide_by (GtkConstraintExpressionBuilder *bui /*< private > * gtk_constraint_expression_builder_multiply_by: - * @builder: a #GtkConstraintExpressionBuilder + * @builder: a `GtkConstraintExpression`Builder * * Adds a multiplication operator to the @builder. */ @@ -1769,7 +1769,7 @@ gtk_constraint_expression_builder_multiply_by (GtkConstraintExpressionBuilder *b /*< private > * gtk_constraint_expression_builder_constant: - * @builder: a #GtkConstraintExpressionBuilder + * @builder: a `GtkConstraintExpression`Builder * @value: a constant value * * Adds a constant value to the @builder. @@ -1811,7 +1811,7 @@ gtk_constraint_expression_builder_constant (GtkConstraintExpressionBuilder *buil /*< private > * gtk_constraint_expression_builder_finish: - * @builder: a #GtkConstraintExpressionBuilder + * @builder: a `GtkConstraintExpression`Builder * * Closes the given expression builder, and returns the expression. * diff --git a/gtk/gtkconstraintexpressionprivate.h b/gtk/gtkconstraintexpressionprivate.h index 942915ad38..a35d3ddb2f 100644 --- a/gtk/gtkconstraintexpressionprivate.h +++ b/gtk/gtkconstraintexpressionprivate.h @@ -253,7 +253,7 @@ gtk_constraint_expression_builder_finish (GtkConstraintExpressionBuilder *builde /*< private > * GtkConstraintExpressionIter: * - * An iterator object for terms inside a #GtkConstraintExpression. + * An iterator object for terms inside a `GtkConstraintExpression`. */ typedef struct { /*< private >*/ diff --git a/gtk/gtkconstraintlayout.c b/gtk/gtkconstraintlayout.c index fed8b7431d..d819bef364 100644 --- a/gtk/gtkconstraintlayout.c +++ b/gtk/gtkconstraintlayout.c @@ -106,7 +106,7 @@ * There can be "constant" and "multiplier" attributes. * * Additionally, the "constraints" element can also contain a description - * of the #GtkConstraintGuides used by the layout: + * of the `GtkConstraintGuides` used by the layout: * * ```xml * <constraints> @@ -736,10 +736,10 @@ get_layout_attribute (GtkConstraintLayout *self, * @self: a `GtkConstraintLayout` * @constraint: a [class@Gtk.Constraint] * - * Turns a #GtkConstraint into a #GtkConstraintRef inside the + * Turns a `GtkConstraint` into a `GtkConstraintRef` inside the * constraint solver associated to @self. * - * If @self does not have a #GtkConstraintSolver, because it + * If @self does not have a `GtkConstraintSolver`, because it * has not been rooted yet, we just store the @constraint instance, * and we're going to call this function when the layout manager * gets rooted. diff --git a/gtk/gtkconstraintsolver.c b/gtk/gtkconstraintsolver.c index 5f1d0abce2..14117e08ba 100644 --- a/gtk/gtkconstraintsolver.c +++ b/gtk/gtkconstraintsolver.c @@ -637,9 +637,9 @@ gtk_constraint_solver_remove_row (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_substitute_out: - * @self: a #GtkConstraintSolver - * @old_variable: a #GtkConstraintVariable - * @expression: a #GtkConstraintExpression + * @self: a `GtkConstraintSolver` + * @old_variable: a `GtkConstraintVariable` + * @expression: a `GtkConstraintExpression` * * Replaces @old_variable in every row of the tableau with @expression. */ @@ -678,11 +678,11 @@ gtk_constraint_solver_substitute_out (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_pivot: - * @self: a #GtkConstraintSolver - * @entry_var: a #GtkConstraintVariable - * @exit_var: a #GtkConstraintVariable + * @self: a `GtkConstraintSolver` + * @entry_var: a `GtkConstraintVariable` + * @exit_var: a `GtkConstraintVariable` * - * Pivots the #GtkConstraintSolver. + * Pivots the `GtkConstraintSolver`. * * This function will move @entry_var into the basis of the tableau, * making it a basic variable; and move @exit_var out of the basis of @@ -824,8 +824,8 @@ gtk_constraint_solver_optimize (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_new_expression: - * @self: a #GtkConstraintSolver - * @constraint: a #GtkConstraintRef + * @self: a `GtkConstraintSolver` + * @constraint: a `GtkConstraintRef` * @eplus_p: (out) (optional): the positive error variable * @eminus_p: (out) (optional): the negative error variable * @prev_constant_p: the constant part of the @constraint's expression @@ -1368,9 +1368,9 @@ gtk_constraint_solver_add_constraint_internal (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_new: * - * Creates a new #GtkConstraintSolver instance. + * Creates a new `GtkConstraintSolver` instance. * - * Returns: the newly created #GtkConstraintSolver + * Returns: the newly created `GtkConstraintSolver` */ GtkConstraintSolver * gtk_constraint_solver_new (void) @@ -1380,7 +1380,7 @@ gtk_constraint_solver_new (void) /*< private > * gtk_constraint_solver_freeze: - * @solver: a #GtkConstraintSolver + * @solver: a `GtkConstraintSolver` * * Freezes the solver; any constraint addition or removal will not * be automatically solved until gtk_constraint_solver_thaw() is @@ -1399,9 +1399,9 @@ gtk_constraint_solver_freeze (GtkConstraintSolver *solver) /*< private > * gtk_constraint_solver_thaw: - * @solver: a #GtkConstraintSolver + * @solver: a `GtkConstraintSolver` * - * Thaws a frozen #GtkConstraintSolver. + * Thaws a frozen `GtkConstraintSolver`. */ void gtk_constraint_solver_thaw (GtkConstraintSolver *solver) @@ -1420,13 +1420,13 @@ gtk_constraint_solver_thaw (GtkConstraintSolver *solver) /*< private > * gtk_constraint_solver_note_added_variable: - * @self: a #GtkConstraintSolver - * @variable: a #GtkConstraintVariable - * @subject: a #GtkConstraintVariable + * @self: a `GtkConstraintSolver` + * @variable: a `GtkConstraintVariable` + * @subject: a `GtkConstraintVariable` * - * Adds a new @variable into the tableau of a #GtkConstraintSolver. + * Adds a new @variable into the tableau of a `GtkConstraintSolver`. * - * This function is typically called by #GtkConstraintExpression, and + * This function is typically called by `GtkConstraintExpression`, and * should never be directly called. */ void @@ -1440,13 +1440,13 @@ gtk_constraint_solver_note_added_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_note_removed_variable: - * @self: a #GtkConstraintSolver - * @variable: a #GtkConstraintVariable - * @subject: a #GtkConstraintVariable + * @self: a `GtkConstraintSolver` + * @variable: a `GtkConstraintVariable` + * @subject: a `GtkConstraintVariable` * - * Removes a @variable from the tableau of a #GtkConstraintSolver. + * Removes a @variable from the tableau of a `GtkConstraintSolver`. * - * This function is typically called by #GtkConstraintExpression, and + * This function is typically called by `GtkConstraintExpression`, and * should never be directly called. */ void @@ -1463,7 +1463,7 @@ gtk_constraint_solver_note_removed_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_create_variable: - * @self: a #GtkConstraintSolver + * @self: a `GtkConstraintSolver` * @prefix: (nullable): the prefix of the variable * @name: (nullable): the name of the variable * @value: the initial value of the variable @@ -1490,7 +1490,7 @@ gtk_constraint_solver_create_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_resolve: - * @solver: a #GtkConstraintSolver + * @solver: a `GtkConstraintSolver` * * Resolves the constraints currently stored in @solver. */ @@ -1519,7 +1519,7 @@ gtk_constraint_solver_resolve (GtkConstraintSolver *solver) /*< private > * gtk_constraint_solver_add_constraint: - * @self: a #GtkConstraintSolver + * @self: a `GtkConstraintSolver` * @variable: the subject of the constraint * @relation: the relation of the constraint * @expression: the expression of the constraint @@ -1531,7 +1531,7 @@ gtk_constraint_solver_resolve (GtkConstraintSolver *solver) * variable relation expression (strength) * |] * - * into the #GtkConstraintSolver. + * into the `GtkConstraintSolver`. * * Returns: (transfer none): a reference to the newly created * constraint; you can use the reference to remove the @@ -1597,8 +1597,8 @@ gtk_constraint_solver_add_constraint (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_add_stay_variable: - * @self: a #GtkConstraintSolver - * @variable: a stay #GtkConstraintVariable + * @self: a `GtkConstraintSolver` + * @variable: a stay `GtkConstraintVariable` * @strength: the strength of the constraint * * Adds a constraint on a stay @variable with the given @strength. @@ -1646,7 +1646,7 @@ gtk_constraint_solver_add_stay_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_remove_stay_variable: - * @self: a #GtkConstraintSolver + * @self: a `GtkConstraintSolver` * @variable: a stay variable * * Removes the stay constraint associated to @variable. @@ -1675,14 +1675,14 @@ gtk_constraint_solver_remove_stay_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_add_edit_variable: - * @self: a #GtkConstraintSolver + * @self: a `GtkConstraintSolver` * @variable: an edit variable * @strength: the strength of the constraint * * Adds an editable constraint to the @solver. * * Editable constraints can be used to suggest values to a - * #GtkConstraintSolver inside an edit phase, for instance: if + * `GtkConstraintSolver` inside an edit phase, for instance: if * you want to change the value of a variable without necessarily * insert a new constraint every time. * @@ -1717,7 +1717,7 @@ gtk_constraint_solver_add_edit_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_remove_edit_variable: - * @self: a #GtkConstraintSolver + * @self: a `GtkConstraintSolver` * @variable: an edit variable * * Removes the edit constraint associated to @variable. @@ -1746,7 +1746,7 @@ gtk_constraint_solver_remove_edit_variable (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_remove_constraint: - * @self: a #GtkConstraintSolver + * @self: a `GtkConstraintSolver` * @constraint: a constraint reference * * Removes a @constraint from the @solver. @@ -1956,8 +1956,8 @@ no_columns: /*< private > * gtk_constraint_solver_suggest_value: - * @self: a #GtkConstraintSolver - * @variable: a #GtkConstraintVariable + * @self: a `GtkConstraintSolver` + * @variable: a `GtkConstraintVariable` * @value: the suggested value for @variable * * Suggests a new @value for an edit @variable. @@ -1995,8 +1995,8 @@ gtk_constraint_solver_suggest_value (GtkConstraintSolver *self, /*< private > * gtk_constraint_solver_has_stay_variable: - * @solver: a #GtkConstraintSolver - * @variable: a #GtkConstraintVariable + * @solver: a `GtkConstraintSolver` + * @variable: a `GtkConstraintVariable` * * Checks whether @variable is a stay variable. * @@ -2014,8 +2014,8 @@ gtk_constraint_solver_has_stay_variable (GtkConstraintSolver *solver, /*< private > * gtk_constraint_solver_has_edit_variable: - * @solver: a #GtkConstraintSolver - * @variable: a #GtkConstraintVariable + * @solver: a `GtkConstraintSolver` + * @variable: a `GtkConstraintVariable` * * Checks whether @variable is an edit variable. * @@ -2033,7 +2033,7 @@ gtk_constraint_solver_has_edit_variable (GtkConstraintSolver *solver, /*< private > * gtk_constraint_solver_begin_edit: - * @solver: a #GtkConstraintSolver + * @solver: a `GtkConstraintSolver` * * Begins the edit phase for a constraint system. * @@ -2073,7 +2073,7 @@ edit_info_free (gpointer data) /*< private > * gtk_constraint_solver_end_edit: - * @solver: a #GtkConstraintSolver + * @solver: a `GtkConstraintSolver` * * Ends the edit phase for a constraint system, and clears * all the edit variables introduced. diff --git a/gtk/gtkconstrainttypesprivate.h b/gtk/gtkconstrainttypesprivate.h index 052280ae98..8f6bd5e0ed 100644 --- a/gtk/gtkconstrainttypesprivate.h +++ b/gtk/gtkconstrainttypesprivate.h @@ -33,9 +33,9 @@ typedef struct _GtkConstraintExpressionBuilder GtkConstraintExpressionBuilder; /*< private > * GtkConstraintRef: * - * A reference to a constraint stored inside the solver; while #GtkConstraint - * represent the public API, a #GtkConstraintRef represents data stored inside - * the solver. A #GtkConstraintRef is completely opaque, and should only be + * A reference to a constraint stored inside the solver; while `GtkConstraint` + * represent the public API, a `GtkConstraintRef` represents data stored inside + * the solver. A `GtkConstraintRef` is completely opaque, and should only be * used to remove a constraint from the solver. */ typedef struct _GtkConstraintRef GtkConstraintRef; diff --git a/gtk/gtkcountingbloomfilterprivate.h b/gtk/gtkcountingbloomfilterprivate.h index 9d7078a587..73cc429d20 100644 --- a/gtk/gtkcountingbloomfilterprivate.h +++ b/gtk/gtkcountingbloomfilterprivate.h @@ -82,7 +82,7 @@ static inline gboolean gtk_counting_bloom_filter_may_contain (const GtkCounti /* * gtk_counting_bloom_filter_add: - * @self: a #GtkCountingBloomFilter + * @self: a `GtkCountingBloomFilter` * @hash: a hash value to add to the filter * * Adds the hash value to the filter. @@ -105,7 +105,7 @@ gtk_counting_bloom_filter_add (GtkCountingBloomFilter *self, /* * gtk_counting_bloom_filter_remove: - * @self: a #GtkCountingBloomFilter + * @self: a `GtkCountingBloomFilter` * @hash: a hash value to remove from the filter * * Removes a hash value from the filter that has previously @@ -127,7 +127,7 @@ gtk_counting_bloom_filter_remove (GtkCountingBloomFilter *self, /* * gtk_counting_bloom_filter_may_contain: - * @self: a #GtkCountingBloomFilter + * @self: a `GtkCountingBloomFilter` * @hash: the hash value to check * * Checks if @hash may be contained in @self. diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c index 0baa6f9b68..c81132e6e8 100644 --- a/gtk/gtkcssprovider.c +++ b/gtk/gtkcssprovider.c @@ -62,7 +62,7 @@ * [method@Gtk.CssProvider.load_from_file] or * [method@Gtk.CssProvider.load_from_resource] * and adding the provider with [method@Gtk.StyleContext.add_provider] or - * [func@Gtk.StyleContext.add_provider_for_display]. + * [type_func@Gtk.StyleContext.add_provider_for_display]. * In addition, certain files will be read when GTK is initialized. * First, the file `$XDG_CONFIG_HOME/gtk-4.0/gtk.css` is loaded if it diff --git a/gtk/gtkcssstyle.c b/gtk/gtkcssstyle.c index 91830266a5..0f890a005d 100644 --- a/gtk/gtkcssstyle.c +++ b/gtk/gtkcssstyle.c @@ -308,8 +308,8 @@ gtk_css_style_get_static_style (GtkCssStyle *style) /* * gtk_css_style_print: - * @style: a #GtkCssStyle - * @string: the #GString to print to + * @style: a `GtkCssStyle` + * @string: the `GString` to print to * @indent: level of indentation to use * @skip_initial: %TRUE to skip properties that have their initial value * diff --git a/gtk/gtkcssvalue.c b/gtk/gtkcssvalue.c index fc79819ee1..e7f41fdac9 100644 --- a/gtk/gtkcssvalue.c +++ b/gtk/gtkcssvalue.c @@ -315,7 +315,7 @@ _gtk_css_value_print (const GtkCssValue *value, /** * gtk_css_value_is_dynamic: - * @value: a #GtkCssValue + * @value: a `GtkCssValue` * * A "dynamic" value has a different value at different times. This means that * the value needs to be animated when time is progressing. @@ -339,7 +339,7 @@ gtk_css_value_is_dynamic (const GtkCssValue *value) /** * gtk_css_value_get_dynamic_value: - * @value: a #GtkCssValue + * @value: a `GtkCssValue` * @monotonic_time: the timestamp for which to get the dynamic value * * Gets the dynamic value for a given timestamp. If @monotonic_time is 0, diff --git a/gtk/gtkcustomlayout.h b/gtk/gtkcustomlayout.h index 0dccb7d718..6c5ade39a1 100644 --- a/gtk/gtkcustomlayout.h +++ b/gtk/gtkcustomlayout.h @@ -42,7 +42,7 @@ typedef GtkSizeRequestMode (* GtkCustomRequestModeFunc) (GtkWidget *widget); * @minimum_baseline: (out): the measured minimum baseline of the widget * @natural_baseline: (out): the measured natural baseline of the widget * - * A function to be used by #GtkCustomLayout to measure a widget. + * A function to be used by `GtkCustomLayout` to measure a widget. */ typedef void (* GtkCustomMeasureFunc) (GtkWidget *widget, GtkOrientation orientation, diff --git a/gtk/gtkcustompaperunixdialog.c b/gtk/gtkcustompaperunixdialog.c index 815d2d262e..62218142f6 100644 --- a/gtk/gtkcustompaperunixdialog.c +++ b/gtk/gtkcustompaperunixdialog.c @@ -390,7 +390,7 @@ gtk_custom_paper_unix_dialog_finalize (GObject *object) * * Creates a new custom paper dialog. * - * Returns: the new #GtkCustomPaperUnixDialog + * Returns: the new `GtkCustomPaperUnixDialog` */ GtkWidget * _gtk_custom_paper_unix_dialog_new (GtkWindow *parent, diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c index 31e7f98684..db3ecb60e0 100644 --- a/gtk/gtkdialog.c +++ b/gtk/gtkdialog.c @@ -146,7 +146,7 @@ * on the “use-header-bar“ property. The response id has to be associated * with the action widget using the <action-widgets> element. * - * An example of a #GtkDialog UI definition fragment: + * An example of a `GtkDialog` UI definition fragment: * ```xml * <object class="GtkDialog" id="dialog1"> * <child type="action"> @@ -1414,7 +1414,7 @@ gtk_dialog_get_header_bar (GtkDialog *dialog) * * Returns the content area of @dialog. * - * Returns: (type Gtk.Box) (transfer none): the content area #GtkBox. + * Returns: (type Gtk.Box) (transfer none): the content area `GtkBox`. */ GtkWidget * gtk_dialog_get_content_area (GtkDialog *dialog) diff --git a/gtk/gtkdirectorylist.c b/gtk/gtkdirectorylist.c index b83721f504..25aa6cf67c 100644 --- a/gtk/gtkdirectorylist.c +++ b/gtk/gtkdirectorylist.c @@ -659,7 +659,7 @@ gtk_directory_list_update_monitoring (GtkDirectoryList *self) /** * gtk_directory_list_set_file: (attributes org.gtk.Method.set_property=file) * @self: a `GtkDirectoryList` - * @file: (nullable): the #GFile to be enumerated + * @file: (nullable): the `GFile` to be enumerated * * Sets the @file to be enumerated and starts the enumeration. * diff --git a/gtk/gtkdragsource.c b/gtk/gtkdragsource.c index ef70d6793c..b3df700065 100644 --- a/gtk/gtkdragsource.c +++ b/gtk/gtkdragsource.c @@ -708,7 +708,7 @@ gtk_drag_source_set_actions (GtkDragSource *source, /** * gtk_drag_source_set_icon: * @source: a `GtkDragSource` - * @paintable: (nullable): the #GdkPaintable to use as icon + * @paintable: (nullable): the `GdkPaintable` to use as icon * @hot_x: the hotspot X coordinate on the icon * @hot_y: the hotspot Y coordinate on the icon * @@ -776,7 +776,7 @@ gtk_drag_source_drag_cancel (GtkDragSource *source) /** * gtk_drag_check_threshold: (method) - * @widget: a #GtkWidget + * @widget: a `GtkWidget` * @start_x: X coordinate of start of drag * @start_y: Y coordinate of start of drag * @current_x: current X coordinate diff --git a/gtk/gtkdrawingarea.h b/gtk/gtkdrawingarea.h index 4d49c3f27e..3f0ee3eab0 100644 --- a/gtk/gtkdrawingarea.h +++ b/gtk/gtkdrawingarea.h @@ -47,7 +47,7 @@ typedef struct _GtkDrawingAreaClass GtkDrawingAreaClass; /** * GtkDrawingAreaDrawFunc: - * @drawing_area: the #GtkDrawingArea to redraw + * @drawing_area: the `GtkDrawingArea` to redraw * @cr: the context to draw to * @width: the actual width of the contents. This value will be at least * as wide as GtkDrawingArea:width. diff --git a/gtk/gtkdroptarget.c b/gtk/gtkdroptarget.c index b2dc6f0eed..24ff0427c2 100644 --- a/gtk/gtkdroptarget.c +++ b/gtk/gtkdroptarget.c @@ -793,7 +793,7 @@ gtk_drop_target_class_init (GtkDropTargetClass *class) /** * GtkDropTarget::drop: * @self: the `GtkDropTarget` - * @value: the #GValue being dropped + * @value: the `GValue` being dropped * @x: the x coordinate of the current pointer position * @y: the y coordinate of the current pointer position * diff --git a/gtk/gtkdroptargetasync.c b/gtk/gtkdroptargetasync.c index b8f360d1da..1afd86d922 100644 --- a/gtk/gtkdroptargetasync.c +++ b/gtk/gtkdroptargetasync.c @@ -404,7 +404,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class) /** * GtkDropTargetAsync::accept: * @self: the `GtkDropTargetAsync` - * @drop: the #GdkDrop + * @drop: the `GdkDrop` * * Emitted on the drop site when a drop operation is about to begin. * @@ -437,7 +437,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class) /** * GtkDropTargetAsync::drag-enter: * @self: the `GtkDropTargetAsync` - * @drop: the #GdkDrop + * @drop: the `GdkDrop` * @x: the x coordinate of the current pointer position * @y: the y coordinate of the current pointer position * @@ -460,7 +460,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class) /** * GtkDropTargetAsync::drag-motion: * @self: the `GtkDropTargetAsync` - * @drop: the #GdkDrop + * @drop: the `GdkDrop` * @x: the x coordinate of the current pointer position * @y: the y coordinate of the current pointer position * @@ -481,7 +481,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class) /** * GtkDropTargetAsync::drag-leave: * @self: the `GtkDropTargetAsync` - * @drop: the #GdkDrop + * @drop: the `GdkDrop` * * Emitted on the drop site when the pointer leaves the widget. * @@ -501,7 +501,7 @@ gtk_drop_target_async_class_init (GtkDropTargetAsyncClass *class) /** * GtkDropTargetAsync::drop: * @self: the `GtkDropTargetAsync` - * @drop: the #GdkDrop + * @drop: the `GdkDrop` * @x: the x coordinate of the current pointer position * @y: the y coordinate of the current pointer position * @@ -648,7 +648,7 @@ gtk_drop_target_async_get_actions (GtkDropTargetAsync *self) /** * gtk_drop_target_async_reject_drop: * @self: a `GtkDropTargetAsync` - * @drop: the #GdkDrop of an ongoing drag operation + * @drop: the `GdkDrop` of an ongoing drag operation * * Sets the @drop as not accepted on this drag site. * diff --git a/gtk/gtkeditable.c b/gtk/gtkeditable.c index 8095bca07f..c8386afe21 100644 --- a/gtk/gtkeditable.c +++ b/gtk/gtkeditable.c @@ -66,7 +66,7 @@ * ## Implementing GtkEditable * * The most likely scenario for implementing `GtkEditable` on your own widget - * is that you will embed a #GtkText inside a complex widget, and want to + * is that you will embed a `GtkText` inside a complex widget, and want to * delegate the editable functionality to that text widget. `GtkEditable` * provides some utility functions to make this easy. * diff --git a/gtk/gtkeditablelabel.c b/gtk/gtkeditablelabel.c index c993350e92..b75b6a531d 100644 --- a/gtk/gtkeditablelabel.c +++ b/gtk/gtkeditablelabel.c @@ -386,7 +386,7 @@ gtk_editable_label_class_init (GtkEditableLabelClass *class) * The default bindings for this action are clicking * on the widget and the Enter key. * - * This action is disabled when #GtkEditableLabel:editing + * This action is disabled when `GtkEditableLabel:editing` * is %FALSE. */ gtk_widget_class_install_action (widget_class, "editing.start", NULL, start_editing); @@ -397,12 +397,12 @@ gtk_editable_label_class_init (GtkEditableLabelClass *class) * * Switch the widget out of editing mode. If @commit * is %TRUE, then the results of the editing are taken - * as the new value of #GtkEditable:text. + * as the new value of `GtkEditable:text`. * * The default binding for this action is the Escape * key. * - * This action is disabled when #GtkEditableLabel:editing + * This action is disabled when `GtkEditableLabel:editing` * is %FALSE. */ gtk_widget_class_install_action (widget_class, "editing.stop", "b", stop_editing); diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c index 267b174e5b..3210426350 100644 --- a/gtk/gtkentry.c +++ b/gtk/gtkentry.c @@ -140,7 +140,7 @@ * The `GtkEntry` implementation of the `GtkBuildable` interface supports a * custom <attributes> element, which supports any number of <attribute> * elements. The <attribute> element has attributes named “name“, “value“, - * “start“ and “end“ and allows you to specify #PangoAttribute values for + * “start“ and “end“ and allows you to specify `PangoAttribute` values for * this label. * * An example of a UI definition fragment specifying Pango attributes: @@ -333,7 +333,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkEntry, gtk_entry, GTK_TYPE_WIDGET, gtk_entry_cell_editable_init)) /* Implement the GtkAccessible interface, in order to obtain focus - * state from the #GtkText widget that we are wrapping. The GtkText + * state from the GtkText widget that we are wrapping. The GtkText * widget is ignored for accessibility purposes (it has role NONE), * and any a11y text functionality is implemented for GtkEntry and * similar wrappers (GtkPasswordEntry, GtkSpinButton, etc). @@ -957,7 +957,7 @@ gtk_entry_class_init (GtkEntryClass *class) * * This is mainly useful to change the size or weight of the text. * - * The #PangoAttribute's @start_index and @end_index must refer to the + * The `PangoAttribute`'s @start_index and @end_index must refer to the * [class@Gtk.EntryBuffer] text, i.e. without the preedit string. */ entry_props[PROP_ATTRIBUTES] = @@ -2918,7 +2918,7 @@ gtk_entry_get_icon_at_pos (GtkEntry *entry, * gtk_entry_set_icon_drag_source: * @entry: a `GtkEntry` * @icon_pos: icon position - * @provider: a #GdkContentProvider + * @provider: a `GdkContentProvider` * @actions: a bitmask of the allowed drag actions * * Sets up the icon at the given position as drag source. diff --git a/gtk/gtkentry.h b/gtk/gtkentry.h index c256fb24bf..c55538f57a 100644 --- a/gtk/gtkentry.h +++ b/gtk/gtkentry.h @@ -75,10 +75,10 @@ struct _GtkEntry /** * GtkEntryClass: * @parent_class: The parent class. - * @activate: Class handler for the #GtkEntry::activate signal. The default + * @activate: Class handler for the `GtkEntry::activate` signal. The default * implementation activates the gtk.activate-default action. * - * Class structure for #GtkEntry. All virtual functions have a default + * Class structure for `GtkEntry`. All virtual functions have a default * implementation. Derived classes may set the virtual function pointers for the * signal handlers to %NULL, but must keep @get_text_area_size and * @get_frame_size non-%NULL; either use the default implementation, or provide diff --git a/gtk/gtkentrybuffer.c b/gtk/gtkentrybuffer.c index b96b895742..2d2f68b3d8 100644 --- a/gtk/gtkentrybuffer.c +++ b/gtk/gtkentrybuffer.c @@ -378,7 +378,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass) /** * GtkEntryBuffer::inserted-text: - * @buffer: a #GtkEntryBuffer + * @buffer: a `GtkEntryBuffer` * @position: the position the text was inserted at. * @chars: The text that was inserted. * @n_chars: The number of characters that were inserted. @@ -398,7 +398,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass) /** * GtkEntryBuffer::deleted-text: - * @buffer: a #GtkEntryBuffer + * @buffer: a `GtkEntryBuffer` * @position: the position the text was deleted at. * @n_chars: The number of characters that were deleted. * @@ -466,7 +466,7 @@ gtk_entry_buffer_get_length (GtkEntryBuffer *buffer) /** * gtk_entry_buffer_get_bytes: - * @buffer: a #GtkEntryBuffer + * @buffer: a `GtkEntryBuffer` * * Retrieves the length in bytes of the buffer. * @@ -582,7 +582,7 @@ gtk_entry_buffer_set_max_length (GtkEntryBuffer *buffer, * Retrieves the maximum allowed length of the text in @buffer. * * Returns: the maximum allowed number of characters - * in #GtkEntryBuffer, or 0 if there is no maximum. + * in `GtkEntryBuffer`, or 0 if there is no maximum. */ int gtk_entry_buffer_get_max_length (GtkEntryBuffer *buffer) diff --git a/gtk/gtkentrycompletion.c b/gtk/gtkentrycompletion.c index f64b851a30..ff3c41dee8 100644 --- a/gtk/gtkentrycompletion.c +++ b/gtk/gtkentrycompletion.c @@ -205,7 +205,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass) * * Applications may connect to this signal in order to insert only a * smaller part of the @prefix into the entry - e.g. the entry used in - * the #GtkFileChooser inserts only the part of the prefix up to the + * the `GtkFileChooser` inserts only the part of the prefix up to the * next '/'. * * Returns: %TRUE if the signal has been handled @@ -838,7 +838,7 @@ gtk_entry_completion_new (void) /** * gtk_entry_completion_new_with_area: - * @area: the #GtkCellArea used to layout cells + * @area: the `GtkCellArea` used to layout cells * * Creates a new `GtkEntryCompletion` object using the * specified @area. diff --git a/gtk/gtkentrycompletion.h b/gtk/gtkentrycompletion.h index de5024363f..90347b25ac 100644 --- a/gtk/gtkentrycompletion.h +++ b/gtk/gtkentrycompletion.h @@ -39,9 +39,9 @@ typedef struct _GtkEntryCompletion GtkEntryCompletion; /** * GtkEntryCompletionMatchFunc: - * @completion: the #GtkEntryCompletion + * @completion: the `GtkEntryCompletion` * @key: the string to match, normalized and case-folded - * @iter: a #GtkTreeIter indicating the row to match + * @iter: a `GtkTreeIter` indicating the row to match * @user_data: user data given to gtk_entry_completion_set_match_func() * * A function which decides whether the row indicated by @iter matches diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h index 60dc3e431d..31b0c8fb46 100644 --- a/gtk/gtkenums.h +++ b/gtk/gtkenums.h @@ -927,7 +927,7 @@ typedef enum * @GTK_LIMIT_NONE: Events are handled regardless of what their * target is. * @GTK_LIMIT_SAME_NATIVE: Events are only handled if their target - * is in the same #GtkNative as the event controllers widget. Note + * is in the same `GtkNative` as the event controllers widget. Note * that some event types have two targets (origin and destination). * * Describes limits of a `GtkEventController` for handling events @@ -976,7 +976,7 @@ typedef enum * @GTK_SHORTCUT_SCOPE_LOCAL: Shortcuts are handled inside * the widget the controller belongs to. * @GTK_SHORTCUT_SCOPE_MANAGED: Shortcuts are handled by - * the first ancestor that is a #GtkShortcutManager + * the first ancestor that is a `GtkShortcutManager` * @GTK_SHORTCUT_SCOPE_GLOBAL: Shortcuts are handled by * the root widget. * @@ -994,7 +994,7 @@ typedef enum * GtkPickFlags: * @GTK_PICK_DEFAULT: The default behavior, include widgets that are receiving events * @GTK_PICK_INSENSITIVE: Include widgets that are insensitive - * @GTK_PICK_NON_TARGETABLE: Include widgets that are marked as non-targetable. See #GtkWidget:can-target + * @GTK_PICK_NON_TARGETABLE: Include widgets that are marked as non-targetable. See `GtkWidget:can-target` * * Flags that influence the behavior of gtk_widget_pick(). */ @@ -1027,7 +1027,7 @@ typedef enum { * * The strength of a constraint, expressed as a symbolic constant. * - * The strength of a #GtkConstraint can be expressed with any positive + * The strength of a `GtkConstraint` can be expressed with any positive * integer; the values of this enumeration can be used for readability. */ typedef enum { @@ -1160,7 +1160,7 @@ typedef enum { * @GTK_ACCESSIBLE_ROLE_GRID: A grid of items. * @GTK_ACCESSIBLE_ROLE_GRID_CELL: An item in a grid or tree grid. * @GTK_ACCESSIBLE_ROLE_GROUP: An element that groups multiple widgets. GTK uses - * this role for various containers, like #GtkBox, #GtkViewport, and #GtkHeaderBar. + * this role for various containers, like `GtkBox`, `GtkViewport`, and `GtkHeaderBar`. * @GTK_ACCESSIBLE_ROLE_HEADING: Unused * @GTK_ACCESSIBLE_ROLE_IMG: An image. * @GTK_ACCESSIBLE_ROLE_INPUT: Abstract role. @@ -1322,22 +1322,22 @@ typedef enum { * GtkAccessibleState: * @GTK_ACCESSIBLE_STATE_BUSY: A “busy” state. This state has boolean values * @GTK_ACCESSIBLE_STATE_CHECKED: A “checked” state; indicates the current - * state of a #GtkCheckButton. Value type: #GtkAccessibleTristate + * state of a `GtkCheckButton`. Value type: `GtkAccessibleTristate` * @GTK_ACCESSIBLE_STATE_DISABLED: A “disabled” state; corresponds to the - * #GtkWidget:sensitive property on #GtkWidget. It indicates a UI element + * `GtkWidget:sensitive` property on `GtkWidget`. It indicates a UI element * that is perceivable, but not editable or operable. Value type: boolean * @GTK_ACCESSIBLE_STATE_EXPANDED: An “expanded” state; corresponds to the - * #GtkExpander:expanded property on #GtkExpander. Value type: boolean + * `GtkExpander:expanded` property on `GtkExpander`. Value type: boolean * or undefined * @GTK_ACCESSIBLE_STATE_HIDDEN: A “hidden” state; corresponds to the - * #GtkWidget:visible property on #GtkWidget. You can use this state + * `GtkWidget:visible` property on `GtkWidget`. You can use this state * explicitly on UI elements that should not be exposed to an assistive * technology. Value type: boolean * See also: %GTK_ACCESSIBLE_STATE_DISABLED * @GTK_ACCESSIBLE_STATE_INVALID: An “invalid” state; set when a widget - * is showing an error. Value type: #GtkAccessibleInvalidState + * is showing an error. Value type: `GtkAccessibleInvalidState` * @GTK_ACCESSIBLE_STATE_PRESSED: A “pressed” state; indicates the current - * state of a #GtkToggleButton. Value type: #GtkAccessibleTristate + * state of a `GtkToggleButton`. Value type: `GtkAccessibleTristate` * enumeration * @GTK_ACCESSIBLE_STATE_SELECTED: A “selected” state; set when a widget * is selected. Value type: boolean or undefined @@ -1368,7 +1368,7 @@ typedef enum { * @GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE: Indicates whether inputting text * could trigger display of one or more predictions of the user's intended * value for a combobox, searchbox, or textbox and specifies how predictions - * would be presented if they were made. Value type: #GtkAccessibleAutocomplete + * would be presented if they were made. Value type: `GtkAccessibleAutocomplete` * @GTK_ACCESSIBLE_PROPERTY_DESCRIPTION: Defines a string value that describes * or annotates the current element. Value type: string * @GTK_ACCESSIBLE_PROPERTY_HAS_POPUP: Indicates the availability and type of @@ -1390,7 +1390,7 @@ typedef enum { * boolean * @GTK_ACCESSIBLE_PROPERTY_ORIENTATION: Indicates whether the element's * orientation is horizontal, vertical, or unknown/ambiguous. Value type: - * #GtkOrientation + * `GtkOrientation` * @GTK_ACCESSIBLE_PROPERTY_PLACEHOLDER: Defines a short hint (a word or short * phrase) intended to aid the user with data entry when the control has no * value. A hint could be a sample value or a brief description of the expected @@ -1403,7 +1403,7 @@ typedef enum { * author-localized description for the role of an element. Value type: string * @GTK_ACCESSIBLE_PROPERTY_SORT: Indicates if items in a table or grid are * sorted in ascending or descending order. Possible property values are in - * the #GtkAccessibleSort enumeration. Value type: #GtkAccessibleSort + * the `GtkAccessibleSort` enumeration. Value type: `GtkAccessibleSort` * @GTK_ACCESSIBLE_PROPERTY_VALUE_MAX: Defines the maximum allowed value for a * range widget. Value type: double * @GTK_ACCESSIBLE_PROPERTY_VALUE_MIN: Defines the minimum allowed value for a diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c index b4841c10fa..987bfcd7ae 100644 --- a/gtk/gtkeventcontroller.c +++ b/gtk/gtkeventcontroller.c @@ -377,8 +377,8 @@ gtk_event_controller_handle_event (GtkEventController *controller, /*< private > * gtk_event_controller_handle_crossing: - * @controller: a #GtkEventController - * @crossing: a #GtkCrossingData + * @controller: a `GtkEventController` + * @crossing: a `GtkCrossingData` * @x: translated event coordinates * @y: translated event coordinates * @@ -410,7 +410,7 @@ gtk_event_controller_handle_crossing (GtkEventController *controller, * gtk_event_controller_get_widget: (attributes org.gtk.Method.get_property=widget) * @controller: a `GtkEventController` * - * Returns the #GtkWidget this controller relates to. + * Returns the `GtkWidget` this controller relates to. * * Returns: (transfer none): a `GtkWidget` **/ diff --git a/gtk/gtkeventcontrollerkey.c b/gtk/gtkeventcontrollerkey.c index f9c9797863..bf5f8f5dcb 100644 --- a/gtk/gtkeventcontrollerkey.c +++ b/gtk/gtkeventcontrollerkey.c @@ -194,7 +194,7 @@ gtk_event_controller_key_class_init (GtkEventControllerKeyClass *klass) * @controller: the object which received the signal. * @keyval: the pressed key. * @keycode: the raw code of the pressed key. - * @state: the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType. + * @state: the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`. * * Emitted whenever a key is pressed. * @@ -216,7 +216,7 @@ gtk_event_controller_key_class_init (GtkEventControllerKeyClass *klass) * @controller: the object which received the signal. * @keyval: the released key. * @keycode: the raw code of the released key. - * @state: the bitmask, representing the state of modifier keys and pointer buttons. See #GdkModifierType. + * @state: the bitmask, representing the state of modifier keys and pointer buttons. See `GdkModifierType`. * * Emitted whenever a key is released. */ @@ -236,7 +236,7 @@ gtk_event_controller_key_class_init (GtkEventControllerKeyClass *klass) * @controller: the object which received the signal. * @keyval: the released key. * @state: the bitmask, representing the new state of modifier keys and - * pointer buttons. See #GdkModifierType. + * pointer buttons. See `GdkModifierType`. * * Emitted whenever the state of modifier keys and pointer buttons change. */ diff --git a/gtk/gtkeventcontrollerprivate.h b/gtk/gtkeventcontrollerprivate.h index 50349cc366..8ca60b0218 100644 --- a/gtk/gtkeventcontrollerprivate.h +++ b/gtk/gtkeventcontrollerprivate.h @@ -65,7 +65,7 @@ typedef struct _GtkCrossingData GtkCrossingData; * @new_descendent: the direct child of the receiving widget that * is an ancestor of @new_target, or %NULL if @new_target is not * a descendent of the receiving widget - * @drop: the #GdkDrop if this is info for a drop operation + * @drop: the `GdkDrop` if this is info for a drop operation * * The struct that is passed to gtk_event_controller_handle_crossing(). * diff --git a/gtk/gtkexpander.c b/gtk/gtkexpander.c index 173726ea2f..e3c5203abe 100644 --- a/gtk/gtkexpander.c +++ b/gtk/gtkexpander.c @@ -924,7 +924,7 @@ gtk_expander_set_expanded (GtkExpander *expander, * gtk_expander_get_expanded: (attributes org.gtk.Method.get_property=expanded) * @expander:a `GtkExpander` * - * Queries a #GtkExpander and returns its current state. + * Queries a `GtkExpander` and returns its current state. * * Returns %TRUE if the child widget is revealed. * diff --git a/gtk/gtkexpression.c b/gtk/gtkexpression.c index 17a511ff4f..bb8bdb177f 100644 --- a/gtk/gtkexpression.c +++ b/gtk/gtkexpression.c @@ -244,14 +244,14 @@ G_DEFINE_BOXED_TYPE (GtkExpressionWatch, gtk_expression_watch, * GTK_DEFINE_EXPRESSION_TYPE: * @TypeName: the type name, in camel case * @type_name: the type name, in snake case - * @type_info: the address of the #GtkExpressionTypeInfo for the expression type + * @type_info: the address of the `GtkExpressionTypeInfo` for the expression type * - * Registers a new #GtkExpression subclass with the given @TypeName and @type_info. + * Registers a new `GtkExpression` subclass with the given @TypeName and @type_info. * * Similarly to %G_DEFINE_TYPE, this macro will generate a `get_type()` * function that registers the event type. * - * You can specify code to be run after the type registration; the #GType of + * You can specify code to be run after the type registration; the `GType` of * the event is available in the `gtk_define_expression_type_id` variable. */ #define GTK_DEFINE_EXPRESSION_TYPE(TypeName, type_name, type_info) \ diff --git a/gtk/gtkexpression.h b/gtk/gtkexpression.h index a2c2421cad..4cea8fb57a 100644 --- a/gtk/gtkexpression.h +++ b/gtk/gtkexpression.h @@ -160,7 +160,7 @@ GtkExpression * gtk_cclosure_expression_new (GType /** * GTK_VALUE_HOLDS_EXPRESSION: - * @value: a #GValue + * @value: a `GValue` * * Evaluates to %TRUE if @value was initialized with %GTK_TYPE_EXPRESSION. */ @@ -184,7 +184,7 @@ GtkExpression * gtk_value_dup_expression (const GValue *value); /** * GtkParamSpecExpression: * - * A #GParamSpec for properties holding a #GtkExpression. + * A `GParamSpec` for properties holding a `GtkExpression`. */ typedef struct { /*< private >*/ diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c index cfe31e8899..44931a54dc 100644 --- a/gtk/gtkfilechooser.c +++ b/gtk/gtkfilechooser.c @@ -372,7 +372,7 @@ gtk_file_chooser_unselect_all (GtkFileChooser *chooser) * @file: the `GFile` for the new folder * @error: location to store error * - * Sets the current folder for @chooser from a #GFile. + * Sets the current folder for @chooser from a `GFile`. * * Returns: %TRUE if the folder could be changed successfully, %FALSE * otherwise. @@ -393,7 +393,7 @@ gtk_file_chooser_set_current_folder (GtkFileChooser *chooser, * gtk_file_chooser_get_current_folder: * @chooser: a `GtkFileChooser` * - * Gets the current folder of @chooser as #GFile. + * Gets the current folder of @chooser as `GFile`. * * Returns: (transfer full): the `GFile` for the current folder. */ @@ -432,7 +432,7 @@ gtk_file_chooser_unselect_file (GtkFileChooser *chooser, * @chooser: a `GtkFileChooser` * * Lists all the selected files and subfolders in the current folder - * of @chooser as #GFile. + * of @chooser as `GFile`. * * Returns: (transfer full): a list model containing a `GFile` for each * selected file and subfolder in the current folder. Free the returned diff --git a/gtk/gtkfilechooserentry.c b/gtk/gtkfilechooserentry.c index 7e9f1ec473..2bf47a067e 100644 --- a/gtk/gtkfilechooserentry.c +++ b/gtk/gtkfilechooserentry.c @@ -798,12 +798,12 @@ delete_text_callback (GtkFileChooserEntry *chooser_entry, * @eat_tabs: If %FALSE, allow focus navigation with the tab key. * @eat_escape: If %TRUE, capture Escape key presses and emit ::hide-entry * - * Creates a new #GtkFileChooserEntry object. #GtkFileChooserEntry + * Creates a new `GtkFileChooserEntry` object. `GtkFileChooserEntry` * is an internal implementation widget for the GTK file chooser * which is an entry with completion with respect to a - * #GtkFileSystem object. + * `GtkFileSystem` object. * - * Returns: the newly created #GtkFileChooserEntry + * Returns: the newly created `GtkFileChooserEntry` **/ GtkWidget * _gtk_file_chooser_entry_new (gboolean eat_tabs, @@ -820,7 +820,7 @@ _gtk_file_chooser_entry_new (gboolean eat_tabs, /** * _gtk_file_chooser_entry_set_base_folder: - * @chooser_entry: a #GtkFileChooserEntry + * @chooser_entry: a `GtkFileChooserEntry` * @file: file for a folder in the chooser entries current file system. * * Sets the folder with respect to which completions occur. @@ -850,13 +850,14 @@ _gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry, /** * _gtk_file_chooser_entry_get_current_folder: - * @chooser_entry: a #GtkFileChooserEntry + * @chooser_entry: a `GtkFileChooserEntry` * - * Gets the current folder for the #GtkFileChooserEntry. If the - * user has only entered a filename, this will be in the base folder - * (see _gtk_file_chooser_entry_set_base_folder()), but if the - * user has entered a relative or absolute path, then it will - * be different. If the user has entered unparsable text, or text which + * Gets the current folder for the `GtkFileChooserEntry`. + * + * If the user has only entered a filename, this will be in the base + * folder (see _gtk_file_chooser_entry_set_base_folder()), but if the + * user has entered a relative or absolute path, then it will be + * different. If the user has entered unparsable text, or text which * the entry cannot handle, this will return %NULL. * * Returns: (nullable) (transfer full): the file for the current folder @@ -873,7 +874,7 @@ _gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry) /** * _gtk_file_chooser_entry_get_file_part: - * @chooser_entry: a #GtkFileChooserEntry + * @chooser_entry: a `GtkFileChooserEntry` * * Gets the non-folder portion of whatever the user has entered * into the file selector. What is returned is a UTF-8 string, @@ -902,11 +903,11 @@ _gtk_file_chooser_entry_get_file_part (GtkFileChooserEntry *chooser_entry) /** * _gtk_file_chooser_entry_set_action: - * @chooser_entry: a #GtkFileChooserEntry + * @chooser_entry: a `GtkFileChooserEntry` * @action: the action which is performed by the file selector using this entry * - * Sets action which is performed by the file selector using this entry. - * The #GtkFileChooserEntry will use different completion strategies for + * Sets action which is performed by the file selector using this entry. + * The `GtkFileChooserEntry` will use different completion strategies for * different actions. **/ void @@ -949,7 +950,7 @@ _gtk_file_chooser_entry_set_action (GtkFileChooserEntry *chooser_entry, /** * _gtk_file_chooser_entry_get_action: - * @chooser_entry: a #GtkFileChooserEntry + * @chooser_entry: a `GtkFileChooserEntry` * * Gets the action for this entry. * @@ -986,7 +987,7 @@ _gtk_file_chooser_entry_get_is_folder (GtkFileChooserEntry *chooser_entry, /* * _gtk_file_chooser_entry_select_filename: - * @chooser_entry: a #GtkFileChooserEntry + * @chooser_entry: a `GtkFileChooserEntry` * * Selects the filename (without the extension) for user edition. */ diff --git a/gtk/gtkfilechoosernative.c b/gtk/gtkfilechoosernative.c index 0a9cce88e1..af89e65e1a 100644 --- a/gtk/gtkfilechoosernative.c +++ b/gtk/gtkfilechoosernative.c @@ -152,7 +152,7 @@ * and %GTK_RESPONSE_CANCEL if he pressed cancel. It can also return * %GTK_RESPONSE_DELETE_EVENT if the window was unexpectedly closed. * - * ## Differences from #GtkFileChooserDialog + * ## Differences from `GtkFileChooserDialog` * * There are a few things in the [iface@Gtk.FileChooser] interface that * are not possible to use with `GtkFileChooserNative`, as such use would diff --git a/gtk/gtkfilechooserutils.c b/gtk/gtkfilechooserutils.c index af319303a0..556859a4a1 100644 --- a/gtk/gtkfilechooserutils.c +++ b/gtk/gtkfilechooserutils.c @@ -71,15 +71,16 @@ static const char * delegate_get_choice (GtkFileChooser *chooser, /** * _gtk_file_chooser_install_properties: - * @klass: the class structure for a type deriving from #GObject + * @klass: the class structure for a type deriving from `GObject` * * Installs the necessary properties for a class implementing - * #GtkFileChooser. A #GtkParamSpecOverride property is installed - * for each property, using the values from the #GtkFileChooserProp - * enumeration. The caller must make sure itself that the enumeration - * values don’t collide with some other property values they - * are using. - **/ + * `GtkFileChooser`. + * + * A `GtkParamSpecOverride` property is installed for each property, + * using the values from the `GtkFileChooserProp` enumeration. The + * caller must make sure itself that the enumeration values don’t + * collide with some other property values they are using. + */ void _gtk_file_chooser_install_properties (GObjectClass *klass) { @@ -105,11 +106,12 @@ _gtk_file_chooser_install_properties (GObjectClass *klass) /** * _gtk_file_chooser_delegate_iface_init: - * @iface: a #GtkFileChoserIface structure + * @iface: a `GtkFileChoserIface` structure * * An interface-initialization function for use in cases where * an object is simply delegating the methods, signals of - * the #GtkFileChooser interface to another object. + * the `GtkFileChooser` interface to another object. + * * _gtk_file_chooser_set_delegate() must be called on each * instance of the object so that the delegate object can * be found. @@ -140,12 +142,12 @@ _gtk_file_chooser_delegate_iface_init (GtkFileChooserIface *iface) /** * _gtk_file_chooser_set_delegate: - * @receiver: a #GObject implementing #GtkFileChooser - * @delegate: another #GObject implementing #GtkFileChooser + * @receiver: a `GObject` implementing `GtkFileChooser` + * @delegate: another `GObject` implementing `GtkFileChooser` * - * Establishes that calls on @receiver for #GtkFileChooser + * Establishes that calls on @receiver for `GtkFileChooser` * methods should be delegated to @delegate, and that - * #GtkFileChooser signals emitted on @delegate should be + * `GtkFileChooser` signals emitted on @delegate should be * forwarded to @receiver. Must be used in conjunction with * _gtk_file_chooser_delegate_iface_init(). **/ diff --git a/gtk/gtkfilesystemmodel.c b/gtk/gtkfilesystemmodel.c index 73e6b3afe0..dc1be31795 100644 --- a/gtk/gtkfilesystemmodel.c +++ b/gtk/gtkfilesystemmodel.c @@ -1340,13 +1340,13 @@ _gtk_file_system_model_new_valist (GtkFileSystemModelGetValue get_func, * @get_func: function to call for getting a value * @get_data: user data argument passed to @get_func * @n_columns: number of columns - * @...: @n_columns #GType types for the columns + * @...: @n_columns `GType` types for the columns * - * Creates a new #GtkFileSystemModel object. You need to add files + * Creates a new `GtkFileSystemModel` object. You need to add files * to the list using _gtk_file_system_model_add_and_query_file() * or _gtk_file_system_model_update_file(). * - * Returns: the newly created #GtkFileSystemModel + * Returns: the newly created `GtkFileSystemModel` **/ GtkFileSystemModel * _gtk_file_system_model_new (GtkFileSystemModelGetValue get_func, @@ -1374,16 +1374,17 @@ _gtk_file_system_model_new (GtkFileSystemModelGetValue get_func, * @get_func: function that the model should call to query data about a file * @get_data: user data to pass to the @get_func * @n_columns: number of columns - * @...: @n_columns #GType types for the columns + * @...: @n_columns `GType` types for the columns * - * Creates a new #GtkFileSystemModel object. The #GtkFileSystemModel - * object wraps the given @directory as a #GtkTreeModel. - * The model will query the given directory with the given @attributes - * and add all files inside the directory automatically. If supported, - * it will also monitor the drectory and update the model's + * Creates a new `GtkFileSystemModel` object. + * + * The `GtkFileSystemModel` object wraps the given @directory as a + * `GtkTreeModel`. The model will query the given directory with the + * given @attributes and add all files inside the directory automatically. + * If supported, it will also monitor the drectory and update the model's * contents to reflect changes, if the @directory supports monitoring. - * - * Returns: the newly created #GtkFileSystemModel + * + * Returns: the newly created `GtkFileSystemModel` **/ GtkFileSystemModel * _gtk_file_system_model_new_for_directory (GFile * dir, @@ -1432,10 +1433,10 @@ gtk_file_system_model_refilter_all (GtkFileSystemModel *model) /** * _gtk_file_system_model_set_show_hidden: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * @show_hidden: whether hidden files should be displayed - * - * Sets whether hidden files should be included in the #GtkTreeModel + * + * Sets whether hidden files should be included in the `GtkTreeModel` * for display. **/ void @@ -1455,12 +1456,12 @@ _gtk_file_system_model_set_show_hidden (GtkFileSystemModel *model, /** * _gtk_file_system_model_set_show_folders: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * @show_folders: whether folders should be displayed - * - * Sets whether folders should be included in the #GtkTreeModel for - * display. - **/ + * + * Sets whether folders should be included in the `GtkTreeModel` + * for display. + */ void _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model, gboolean show_folders) @@ -1478,12 +1479,12 @@ _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model, /** * _gtk_file_system_model_set_show_files: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * @show_files: whether files (as opposed to folders) should be displayed. * * Sets whether files (as opposed to folders) should be included - * in the #GtkTreeModel for display. - **/ + * in the `GtkTreeModel` for display. + */ void _gtk_file_system_model_set_show_files (GtkFileSystemModel *model, gboolean show_files) @@ -1501,13 +1502,13 @@ _gtk_file_system_model_set_show_files (GtkFileSystemModel *model, /** * _gtk_file_system_model_set_filter_folders: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * @filter_folders: whether the filter applies to folders - * + * * Sets whether the filter set by _gtk_file_system_model_set_filter() * applies to folders. By default, it does not and folders are always * visible. - **/ + */ void _gtk_file_system_model_set_filter_folders (GtkFileSystemModel *model, gboolean filter_folders) @@ -1548,8 +1549,9 @@ _gtk_file_system_model_get_cancellable (GtkFileSystemModel *model) * @iter: a valid iterator * * Checks if the iterator is visible. A visible iterator references - * a row that is currently exposed using the #GtkTreeModel API. If - * the iterator is invisible, it references a file that is not shown + * a row that is currently exposed using the `GtkTreeModel` API. + * + * If the iterator is invisible, it references a file that is not shown * for some reason, such as being filtered out by the current filter or * being a hidden file. * @@ -1596,18 +1598,17 @@ _gtk_file_system_model_iter_is_filtered_out (GtkFileSystemModel *model, /** * _gtk_file_system_model_get_info: - * @model: a #GtkFileSystemModel - * @iter: a #GtkTreeIter pointing to a row of @model - * - * Gets the #GFileInfo-struct for a particular row + * @model: a `GtkFileSystemModel` + * @iter: a `GtkTreeIter` pointing to a row of @model + * + * Gets the `GFileInfo` for a particular row * of @model. - * - * Returns: a #GFileInfo-struct. This value - * is owned by @model and must not be modified or freed. - * If you want to keep the information for later use, - * you must take a reference, since the #GFileInfo-struct may be - * freed on later changes to the file system. - **/ + * + * Returns: a `GFileInfo`. This value is owned by @model and must not + * be modified or freed. If you want to keep the information for + * later use, you must take a reference, since the `GFileInfo` may + * be freed on later changes to the file system. + */ GFileInfo * _gtk_file_system_model_get_info (GtkFileSystemModel *model, GtkTreeIter *iter) @@ -1624,9 +1625,9 @@ _gtk_file_system_model_get_info (GtkFileSystemModel *model, /** * _gtk_file_system_model_get_file: - * @model: a #GtkFileSystemModel - * @iter: a #GtkTreeIter pointing to a row of @model - * + * @model: a `GtkFileSystemModel` + * @iter: a `GtkTreeIter` pointing to a row of @model + * * Gets the file for a particular row in @model. * * Returns: the file. This object is owned by @model and @@ -1648,8 +1649,8 @@ _gtk_file_system_model_get_file (GtkFileSystemModel *model, /** * _gtk_file_system_model_get_value: - * @model: a #GtkFileSystemModel - * @iter: a #GtkTreeIter pointing to a row of @model + * @model: a `GtkFileSystemModel` + * @iter: a `GtkTreeIter` pointing to a row of @model * @column: the column to get the value for * * Gets the value associated with the given row @iter and @column. @@ -1932,7 +1933,7 @@ _gtk_file_system_model_update_files (GtkFileSystemModel *model, /** * _gtk_file_system_model_set_filter: - * @mode: a #GtkFileSystemModel + * @mode: a `GtkFileSystemModel` * @filter: (nullable): %NULL or filter to use * * Sets a filter to be used for deciding if a row should be visible or not. @@ -1962,7 +1963,7 @@ _gtk_file_system_model_set_filter (GtkFileSystemModel *model, /** * freeze_updates: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * * Freezes most updates on the model, so that performing multiple operations on * the files in the model do not cause any events. Use thaw_updates() to resume @@ -1979,7 +1980,7 @@ freeze_updates (GtkFileSystemModel *model) /** * thaw_updates: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * * Undoes the effect of a previous call to freeze_updates() **/ @@ -2019,7 +2020,7 @@ thaw_updates (GtkFileSystemModel *model) /** * _gtk_file_system_model_clear_cache: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * @column: the column to clear or -1 for all columns * * Clears the cached values in the model for the given @column. Use @@ -2072,7 +2073,7 @@ _gtk_file_system_model_clear_cache (GtkFileSystemModel *model, /** * _gtk_file_system_model_add_and_query_file: - * @model: a #GtkFileSystemModel + * @model: a `GtkFileSystemModel` * @file: the file to add * @attributes: attributes to query before adding the file * diff --git a/gtk/gtkfilter.c b/gtk/gtkfilter.c index ca6e0e9463..fe6e5c0756 100644 --- a/gtk/gtkfilter.c +++ b/gtk/gtkfilter.c @@ -44,7 +44,7 @@ * various widgets to easily allow searches. * * However, in particular for large lists or complex search methods, it is - * also possible to subclass #GtkFilter and provide one's own filter. + * also possible to subclass `GtkFilter` and provide one's own filter. */ enum { @@ -81,7 +81,7 @@ gtk_filter_class_init (GtkFilterClass *class) /** * GtkFilter::changed: - * @self: The #GtkFilter + * @self: The `GtkFilter` * @change: how the filter changed * * Emitted whenever the filter changed. @@ -136,15 +136,15 @@ gtk_filter_match (GtkFilter *self, /** * gtk_filter_get_strictness: - * @self: a #GtkFilter + * @self: a `GtkFilter` * * Gets the known strictness of @filters. If the strictness is not known, * %GTK_FILTER_MATCH_SOME is returned. * - * This value may change after emission of the #GtkFilter::changed signal. + * This value may change after emission of the `GtkFilter::changed` signal. * * This function is meant purely for optimization purposes, filters can - * choose to omit implementing it, but #GtkFilterListModel uses it. + * choose to omit implementing it, but `GtkFilterListModel` uses it. * * Returns: the strictness of @self **/ @@ -158,17 +158,17 @@ gtk_filter_get_strictness (GtkFilter *self) /** * gtk_filter_changed: - * @self: a #GtkFilter + * @self: a `GtkFilter` * @change: How the filter changed * - * Emits the #GtkFilter::changed signal to notify all users of the filter that + * Emits the `GtkFilter::changed` signal to notify all users of the filter that * the filter changed. Users of the filter should then check items again via * gtk_filter_match(). * * Depending on the @change parameter, not all items need to be changed, but - * only some. Refer to the #GtkFilterChange documentation for details. + * only some. Refer to the `GtkFilterChange` documentation for details. * - * This function is intended for implementors of #GtkFilter subclasses and + * This function is intended for implementors of `GtkFilter` subclasses and * should not be called from other functions. */ void diff --git a/gtk/gtkflowbox.c b/gtk/gtkflowbox.c index 76b8657502..d994e69d08 100644 --- a/gtk/gtkflowbox.c +++ b/gtk/gtkflowbox.c @@ -3782,7 +3782,7 @@ gtk_flow_box_class_init (GtkFlowBoxClass *class) /** * GtkFlowBox::move-cursor: * @box: the `GtkFlowBox` on which the signal is emitted - * @step: the granularity fo the move, as a #GtkMovementStep + * @step: the granularity fo the move, as a `GtkMovementStep` * @count: the number of @step units to move * @extend: whether to extend the selection * @modify: whether to modify the selection diff --git a/gtk/gtkfontchooser.h b/gtk/gtkfontchooser.h index 07ca206c1a..2ce7897d03 100644 --- a/gtk/gtkfontchooser.h +++ b/gtk/gtkfontchooser.h @@ -31,8 +31,8 @@ G_BEGIN_DECLS /** * GtkFontFilterFunc: - * @family: a #PangoFontFamily - * @face: a #PangoFontFace belonging to @family + * @family: a `PangoFontFamily` + * @face: a `PangoFontFace` belonging to @family * @data: (closure): user data passed to gtk_font_chooser_set_filter_func() * * The type of function that is used for deciding what fonts get diff --git a/gtk/gtkfontchooserutils.c b/gtk/gtkfontchooserutils.c index 2d484a2b06..6dd2a3fd9d 100644 --- a/gtk/gtkfontchooserutils.c +++ b/gtk/gtkfontchooserutils.c @@ -110,14 +110,15 @@ _gtk_font_chooser_delegate_get_quark (void) /** * _gtk_font_chooser_install_properties: - * @klass: the class structure for a type deriving from #GObject + * @klass: the class structure for a type deriving from `GObject` * * Installs the necessary properties for a class implementing - * #GtkFontChooser. A #GtkParamSpecOverride property is installed - * for each property, using the values from the #GtkFontChooserProp - * enumeration. The caller must make sure itself that the enumeration - * values don’t collide with some other property values they - * are using. + * `GtkFontChooser`. + * + * A `GtkParamSpecOverride` property is installed for each property, + * using the values from the `GtkFontChooserProp` enumeration. The + * caller must make sure itself that the enumeration values don’t + * collide with some other property values they are using. */ void _gtk_font_chooser_install_properties (GObjectClass *klass) @@ -147,11 +148,11 @@ _gtk_font_chooser_install_properties (GObjectClass *klass) /** * _gtk_font_chooser_delegate_iface_init: - * @iface: a #GtkFontChooserIface + * @iface: a `GtkFontChooserIface` * * An interface-initialization function for use in cases where * an object is simply delegating the methods, signals of - * the #GtkFontChooser interface to another object. + * the `GtkFontChooser` interface to another object. * _gtk_font_chooser_set_delegate() must be called on each * instance of the object so that the delegate object can * be found. @@ -169,12 +170,12 @@ _gtk_font_chooser_delegate_iface_init (GtkFontChooserIface *iface) /** * _gtk_font_chooser_set_delegate: - * @receiver: a #GObject implementing #GtkFontChooser - * @delegate: another #GObject implementing #GtkFontChooser + * @receiver: a `GObject` implementing `GtkFontChooser` + * @delegate: another `GObject` implementing `GtkFontChooser` * - * Establishes that calls on @receiver for #GtkFontChooser + * Establishes that calls on @receiver for `GtkFontChooser` * methods should be delegated to @delegate, and that - * #GtkFontChooser signals emitted on @delegate should be + * `GtkFontChooser` signals emitted on @delegate should be * forwarded to @receiver. Must be used in conjunction with * _gtk_font_chooser_delegate_iface_init(). */ diff --git a/gtk/gtkgesture.c b/gtk/gtkgesture.c index 2dc5b3756c..71a0300ea1 100644 --- a/gtk/gtkgesture.c +++ b/gtk/gtkgesture.c @@ -936,7 +936,7 @@ gtk_gesture_get_device (GtkGesture *gesture) /** * gtk_gesture_get_sequence_state: * @gesture: a `GtkGesture` - * @sequence: a #GdkEventSequence + * @sequence: a `GdkEventSequence` * * Returns the @sequence state, as seen by @gesture. * diff --git a/gtk/gtkgesturedrag.c b/gtk/gtkgesturedrag.c index a44cfd6013..65b196ae7d 100644 --- a/gtk/gtkgesturedrag.c +++ b/gtk/gtkgesturedrag.c @@ -262,7 +262,7 @@ gtk_gesture_drag_get_start_point (GtkGestureDrag *gesture, /** * gtk_gesture_drag_get_offset: - * @gesture: a #GtkGesture + * @gesture: a `GtkGesture` * @x: (out) (nullable): X offset for the current point * @y: (out) (nullable): Y offset for the current point * diff --git a/gtk/gtkglarea.c b/gtk/gtkglarea.c index 8782ff7e8a..610ac97c4f 100644 --- a/gtk/gtkglarea.c +++ b/gtk/gtkglarea.c @@ -65,7 +65,7 @@ * render (GtkGLArea *area, GdkGLContext *context) * { * // inside this function it's safe to use GL; the given - * // #GdkGLContext has been made current to the drawable + * // GdkGLContext has been made current to the drawable * // surface used by the `GtkGLArea` and the viewport has * // already been set to be the size of the allocation * @@ -110,7 +110,7 @@ * * // If there were errors during the initialization or * // when trying to make the context current, this - * // function will return a #GError for you to catch + * // function will return a GError for you to catch * if (gtk_gl_area_get_error (area) != NULL) * return; * @@ -1019,7 +1019,7 @@ gtk_gl_area_set_error (GtkGLArea *area, * * Gets the current error set on the @area. * - * Returns: (nullable) (transfer none): the #GError + * Returns: (nullable) (transfer none): the `GError` */ GError * gtk_gl_area_get_error (GtkGLArea *area) @@ -1038,7 +1038,7 @@ gtk_gl_area_get_error (GtkGLArea *area) * * Sets whether the @area should create an OpenGL or an OpenGL ES context. * - * You should check the capabilities of the #GdkGLContext before drawing + * You should check the capabilities of the `GdkGLContext` before drawing * with either API. */ void diff --git a/gtk/gtkglarea.h b/gtk/gtkglarea.h index b7bf7a6c09..70589ef56c 100644 --- a/gtk/gtkglarea.h +++ b/gtk/gtkglarea.h @@ -47,9 +47,9 @@ struct _GtkGLArea /** * GtkGLAreaClass: - * @render: class closure for the #GtkGLArea::render signal - * @resize: class closeure for the #GtkGLArea::resize signal - * @create_context: class closure for the #GtkGLArea::create-context signal + * @render: class closure for the `GtkGLArea::render` signal + * @resize: class closeure for the `GtkGLArea::resize` signal + * @create_context: class closure for the `GtkGLArea::create-context` signal * * The `GtkGLAreaClass` structure contains only private data. */ diff --git a/gtk/gtkgridlayout.c b/gtk/gtkgridlayout.c index 9207748fdf..fcf067adba 100644 --- a/gtk/gtkgridlayout.c +++ b/gtk/gtkgridlayout.c @@ -1711,7 +1711,7 @@ gtk_grid_layout_class_init (GtkGridLayoutClass *klass) /** * GtkGridLayout:baseline-row: (attributes org.gtk.Property.get=gtk_grid_layout_get_baseline_row org.gtk.Property.set=gtk_grid_layout_set_baseline_row) * - * The row to align to the baseline, when #GtkWidget:valign is set + * The row to align to the baseline, when `GtkWidget:valign` is set * to %GTK_ALIGN_BASELINE. */ layout_props[PROP_BASELINE_ROW] = diff --git a/gtk/gtkheaderbar.c b/gtk/gtkheaderbar.c index 12f24ee1c0..7668d7fe5b 100644 --- a/gtk/gtkheaderbar.c +++ b/gtk/gtkheaderbar.c @@ -667,7 +667,7 @@ gtk_header_bar_buildable_init (GtkBuildableIface *iface) /** * gtk_header_bar_pack_start: * @bar: A `GtkHeaderBar` - * @child: the #GtkWidget to be added to @bar + * @child: the `GtkWidget` to be added to @bar * * Adds @child to @bar, packed with reference to the * start of the @bar. @@ -682,7 +682,7 @@ gtk_header_bar_pack_start (GtkHeaderBar *bar, /** * gtk_header_bar_pack_end: * @bar: A `GtkHeaderBar` - * @child: the #GtkWidget to be added to @bar + * @child: the `GtkWidget` to be added to @bar * * Adds @child to @bar, packed with reference to the * end of the @bar. diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c index 3e03c231b1..ac43018cd6 100644 --- a/gtk/gtkicontheme.c +++ b/gtk/gtkicontheme.c @@ -1048,7 +1048,7 @@ gtk_icon_theme_class_init (GtkIconThemeClass *klass) * The name of the icon theme that is being used. * * Unless set to a different value, this will be the value of - * the #GtkSettings:gtk-icon-theme-name property of the #GtkSettings + * the `GtkSettings:gtk-icon-theme-name` property of the `GtkSettings` * object associated to the display of the icontheme object. */ props[PROP_THEME_NAME] = @@ -3677,7 +3677,7 @@ new_resource_file (const char *filename) * * Returns %NULL if the icon was not loaded from a file. * - * Returns: (nullable) (transfer full): the #GFile for the icon + * Returns: (nullable) (transfer full): the `GFile` for the icon */ GFile * gtk_icon_paintable_get_file (GtkIconPaintable *icon) diff --git a/gtk/gtkicontheme.h b/gtk/gtkicontheme.h index 183c7249aa..bc591c12a5 100644 --- a/gtk/gtkicontheme.h +++ b/gtk/gtkicontheme.h @@ -59,7 +59,7 @@ typedef enum /** * GTK_ICON_THEME_ERROR: * - * The #GQuark used for #GtkIconThemeError errors. + * The `GQuark` used for `GtkIconThemeError` errors. */ #define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark () diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c index 095c19a271..0c9a1add77 100644 --- a/gtk/gtkiconview.c +++ b/gtk/gtkiconview.c @@ -62,7 +62,7 @@ * * Note that if the tree model is backed by an actual tree store (as * opposed to a flat list where the mapping to icons is obvious), - * #GtkIconView will only display the first level of the tree and + * `GtkIconView` will only display the first level of the tree and * ignore the tree’s branches. * * # CSS nodes @@ -351,7 +351,7 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) * GtkIconView:selection-mode: * * The ::selection-mode property specifies the selection mode of - * icon view. If the mode is #GTK_SELECTION_MULTIPLE, rubberband selection + * icon view. If the mode is %GTK_SELECTION_MULTIPLE, rubberband selection * is enabled, for the other modes, only keyboard selection is possible. */ g_object_class_install_property (gobject_class, @@ -368,7 +368,7 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) * * The ::pixbuf-column property contains the number of the model column * containing the pixbufs which are displayed. The pixbuf column must be - * of type #GDK_TYPE_PIXBUF. Setting this property to -1 turns off the + * of type `GDK_TYPE_PIXBUF`. Setting this property to -1 turns off the * display of pixbufs. */ g_object_class_install_property (gobject_class, @@ -384,7 +384,7 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) * * The ::text-column property contains the number of the model column * containing the texts which are displayed. The text column must be - * of type #G_TYPE_STRING. If this property and the :markup-column + * of type `G_TYPE_STRING`. If this property and the :markup-column * property are both set to -1, no texts are displayed. */ g_object_class_install_property (gobject_class, @@ -401,7 +401,7 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) * * The ::markup-column property contains the number of the model column * containing markup information to be displayed. The markup column must be - * of type #G_TYPE_STRING. If this property and the :text-column property + * of type `G_TYPE_STRING`. If this property and the :text-column property * are both set to column numbers, it overrides the text column. * If both are set to -1, no texts are displayed. */ @@ -564,10 +564,10 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) /** * GtkIconView:cell-area: * - * The #GtkCellArea used to layout cell renderers for this view. + * The `GtkCellArea` used to layout cell renderers for this view. * * If no area is specified when creating the icon view with gtk_icon_view_new_with_area() - * a #GtkCellAreaBox will be used. + * a `GtkCellAreaBox` will be used. */ g_object_class_install_property (gobject_class, PROP_CELL_AREA, @@ -601,7 +601,7 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) /** * GtkIconView::item-activated: * @iconview: the object on which the signal is emitted - * @path: the #GtkTreePath for the activated item + * @path: the `GtkTreePath` for the activated item * * The ::item-activated signal is emitted when the method * gtk_icon_view_item_activated() is called, when the user double @@ -757,7 +757,7 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) /** * GtkIconView::move-cursor: * @iconview: the object which received the signal - * @step: the granularity of the move, as a #GtkMovementStep + * @step: the granularity of the move, as a `GtkMovementStep` * @count: the number of @step units to move * @extend: whether to extend the selection * @modify: whether to modify the selection @@ -1953,8 +1953,8 @@ gtk_icon_view_remove_editable (GtkCellArea *area, /** * gtk_icon_view_set_cursor: - * @icon_view: A #GtkIconView - * @path: A #GtkTreePath + * @icon_view: A `GtkIconView` + * @path: A `GtkTreePath` * @cell: (nullable): One of the cell renderers of @icon_view * @start_editing: %TRUE if the specified cell should start being edited. * @@ -2008,7 +2008,7 @@ gtk_icon_view_set_cursor (GtkIconView *icon_view, /** * gtk_icon_view_get_cursor: - * @icon_view: A #GtkIconView + * @icon_view: A `GtkIconView` * @path: (out) (optional) (transfer full): Return location for the current * cursor path * @cell: (out) (optional) (transfer none): Return location the current @@ -2018,7 +2018,7 @@ gtk_icon_view_set_cursor (GtkIconView *icon_view, * If the cursor isn’t currently set, then *@path will be %NULL. * If no cell currently has focus, then *@cell will be %NULL. * - * The returned #GtkTreePath must be freed with gtk_tree_path_free(). + * The returned `GtkTreePath` must be freed with gtk_tree_path_free(). * * Returns: %TRUE if the cursor is set. **/ @@ -3826,7 +3826,7 @@ gtk_icon_view_move_cursor_start_end (GtkIconView *icon_view, /** * gtk_icon_view_scroll_to_path: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView` * @path: The path of the item to move to. * @use_align: whether to use alignment arguments, or %FALSE. * @row_align: The vertical alignment of the item specified by @path. @@ -4035,9 +4035,9 @@ _gtk_icon_view_set_cell_data (GtkIconView *icon_view, /** * gtk_icon_view_new: * - * Creates a new #GtkIconView widget + * Creates a new `GtkIconView` widget * - * Returns: A newly created #GtkIconView widget + * Returns: A newly created `GtkIconView` widget **/ GtkWidget * gtk_icon_view_new (void) @@ -4047,12 +4047,12 @@ gtk_icon_view_new (void) /** * gtk_icon_view_new_with_area: - * @area: the #GtkCellArea to use to layout cells + * @area: the `GtkCellArea` to use to layout cells * - * Creates a new #GtkIconView widget using the + * Creates a new `GtkIconView` widget using the * specified @area to layout cells inside the icons. * - * Returns: A newly created #GtkIconView widget + * Returns: A newly created `GtkIconView` widget **/ GtkWidget * gtk_icon_view_new_with_area (GtkCellArea *area) @@ -4064,9 +4064,9 @@ gtk_icon_view_new_with_area (GtkCellArea *area) * gtk_icon_view_new_with_model: * @model: The model. * - * Creates a new #GtkIconView widget with the model @model. + * Creates a new `GtkIconView` widget with the model @model. * - * Returns: A newly created #GtkIconView widget. + * Returns: A newly created `GtkIconView` widget. **/ GtkWidget * gtk_icon_view_new_with_model (GtkTreeModel *model) @@ -4076,13 +4076,13 @@ gtk_icon_view_new_with_model (GtkTreeModel *model) /** * gtk_icon_view_get_path_at_pos: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @x: The x position to be identified * @y: The y position to be identified * * Gets the path for the icon at the given position. * - * Returns: (nullable) (transfer full): The #GtkTreePath corresponding + * Returns: (nullable) (transfer full): The `GtkTreePath` corresponding * to the icon or %NULL if no icon exists at that position. **/ GtkTreePath * @@ -4107,7 +4107,7 @@ gtk_icon_view_get_path_at_pos (GtkIconView *icon_view, /** * gtk_icon_view_get_item_at_pos: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @x: The x position to be identified * @y: The y position to be identified * @path: (out) (optional): Return location for the path @@ -4148,9 +4148,9 @@ gtk_icon_view_get_item_at_pos (GtkIconView *icon_view, /** * gtk_icon_view_get_cell_rect: - * @icon_view: a #GtkIconView - * @path: a #GtkTreePath - * @cell: (nullable): a #GtkCellRenderer + * @icon_view: a `GtkIconView` + * @path: a `GtkTreePath` + * @cell: (nullable): a `GtkCellRenderer` * @rect: (out): rectangle to fill with cell rect * * Fills the bounding rectangle in widget coordinates for the cell specified by @@ -4201,9 +4201,9 @@ gtk_icon_view_get_cell_rect (GtkIconView *icon_view, /** * gtk_icon_view_set_tooltip_item: - * @icon_view: a #GtkIconView - * @tooltip: a #GtkTooltip - * @path: a #GtkTreePath + * @icon_view: a `GtkIconView` + * @tooltip: a `GtkTooltip` + * @path: a `GtkTreePath` * * Sets the tip area of @tooltip to be the area covered by the item at @path. * See also gtk_icon_view_set_tooltip_column() for a simpler alternative. @@ -4222,10 +4222,10 @@ gtk_icon_view_set_tooltip_item (GtkIconView *icon_view, /** * gtk_icon_view_set_tooltip_cell: - * @icon_view: a #GtkIconView - * @tooltip: a #GtkTooltip - * @path: a #GtkTreePath - * @cell: (nullable): a #GtkCellRenderer + * @icon_view: a `GtkIconView` + * @tooltip: a `GtkTooltip` + * @path: a `GtkTreePath` + * @cell: (nullable): a `GtkCellRenderer` * * Sets the tip area of @tooltip to the area which @cell occupies in * the item pointed to by @path. See also gtk_tooltip_set_tip_area(). @@ -4253,7 +4253,7 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view, /** * gtk_icon_view_get_tooltip_context: - * @icon_view: an #GtkIconView + * @icon_view: an `GtkIconView` * @x: the x coordinate (relative to widget coordinates) * @y: the y coordinate (relative to widget coordinates) * @keyboard_tip: whether this is a keyboard tooltip or not @@ -4261,8 +4261,8 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view, * @path: (out) (optional): a pointer to receive a `GtkTreePath` * @iter: (out) (optional): a pointer to receive a `GtkTreeIter` * - * This function is supposed to be used in a #GtkWidget::query-tooltip - * signal handler for #GtkIconView. The @x, @y and @keyboard_tip values + * This function is supposed to be used in a `GtkWidget::query-tooltip` + * signal handler for `GtkIconView`. The @x, @y and @keyboard_tip values * which are received in the signal handler, should be passed to this * function without modification. * @@ -4355,16 +4355,16 @@ gtk_icon_view_set_tooltip_query_cb (GtkWidget *widget, /** * gtk_icon_view_set_tooltip_column: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @column: an integer, which is a valid column number for @icon_view’s model * * If you only plan to have simple (text-only) tooltips on full items, you - * can use this function to have #GtkIconView handle these automatically + * can use this function to have `GtkIconView` handle these automatically * for you. @column should be set to the column in @icon_view’s model * containing the tooltip texts, or -1 to disable this feature. * - * When enabled, #GtkWidget:has-tooltip will be set to %TRUE and - * @icon_view will connect a #GtkWidget::query-tooltip signal handler. + * When enabled, `GtkWidget:has-tooltip` will be set to %TRUE and + * @icon_view will connect a `GtkWidget::query-tooltip` signal handler. * * Note that the signal handler sets the text with gtk_tooltip_set_markup(), * so &, <, etc have to be escaped in the text. @@ -4401,7 +4401,7 @@ gtk_icon_view_set_tooltip_column (GtkIconView *icon_view, /** * gtk_icon_view_get_tooltip_column: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the column of @icon_view’s model which is being used for * displaying tooltips on @icon_view’s rows. @@ -4419,7 +4419,7 @@ gtk_icon_view_get_tooltip_column (GtkIconView *icon_view) /** * gtk_icon_view_get_visible_range: - * @icon_view: A #GtkIconView + * @icon_view: A `GtkIconView` * @start_path: (out) (optional): Return location for start of region * @end_path: (out) (optional): Return location for end of region * @@ -4478,7 +4478,7 @@ gtk_icon_view_get_visible_range (GtkIconView *icon_view, /** * gtk_icon_view_selected_foreach: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @func: (scope call): The function to call for each selected icon. * @data: User data to pass to the function. * @@ -4506,7 +4506,7 @@ gtk_icon_view_selected_foreach (GtkIconView *icon_view, /** * gtk_icon_view_set_selection_mode: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @mode: The selection mode * * Sets the selection mode of the @icon_view. @@ -4531,7 +4531,7 @@ gtk_icon_view_set_selection_mode (GtkIconView *icon_view, /** * gtk_icon_view_get_selection_mode: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Gets the selection mode of the @icon_view. * @@ -4547,10 +4547,10 @@ gtk_icon_view_get_selection_mode (GtkIconView *icon_view) /** * gtk_icon_view_set_model: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @model: (nullable): The model. * - * Sets the model for a #GtkIconView. + * Sets the model for a `GtkIconView`. * If the @icon_view already has a model set, it will remove * it before setting the new model. If @model is %NULL, then * it will unset the old model. @@ -4660,9 +4660,9 @@ gtk_icon_view_set_model (GtkIconView *icon_view, /** * gtk_icon_view_get_model: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * - * Returns the model the #GtkIconView is based on. Returns %NULL if the + * Returns the model the `GtkIconView` is based on. Returns %NULL if the * model is unset. * * Returns: (nullable) (transfer none): The currently used `GtkTreeModel` @@ -4773,11 +4773,11 @@ update_pixbuf_cell (GtkIconView *icon_view) /** * gtk_icon_view_set_text_column: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @column: A column in the currently used model, or -1 to display no text * * Sets the column with text for @icon_view to be @column. The text - * column must be of type #G_TYPE_STRING. + * column must be of type `G_TYPE_STRING`. **/ void gtk_icon_view_set_text_column (GtkIconView *icon_view, @@ -4810,7 +4810,7 @@ gtk_icon_view_set_text_column (GtkIconView *icon_view, /** * gtk_icon_view_get_text_column: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Returns the column with text for @icon_view. * @@ -4826,11 +4826,11 @@ gtk_icon_view_get_text_column (GtkIconView *icon_view) /** * gtk_icon_view_set_markup_column: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @column: A column in the currently used model, or -1 to display no text * * Sets the column with markup information for @icon_view to be - * @column. The markup column must be of type #G_TYPE_STRING. + * @column. The markup column must be of type `G_TYPE_STRING`. * If the markup column is set to something, it overrides * the text column set by gtk_icon_view_set_text_column(). **/ @@ -4865,7 +4865,7 @@ gtk_icon_view_set_markup_column (GtkIconView *icon_view, /** * gtk_icon_view_get_markup_column: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Returns the column with markup text for @icon_view. * @@ -4881,11 +4881,11 @@ gtk_icon_view_get_markup_column (GtkIconView *icon_view) /** * gtk_icon_view_set_pixbuf_column: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @column: A column in the currently used model, or -1 to disable * * Sets the column with pixbufs for @icon_view to be @column. The pixbuf - * column must be of type #GDK_TYPE_PIXBUF + * column must be of type `GDK_TYPE_PIXBUF` **/ void gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view, @@ -4919,7 +4919,7 @@ gtk_icon_view_set_pixbuf_column (GtkIconView *icon_view, /** * gtk_icon_view_get_pixbuf_column: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Returns the column with pixbufs for @icon_view. * @@ -4935,8 +4935,8 @@ gtk_icon_view_get_pixbuf_column (GtkIconView *icon_view) /** * gtk_icon_view_select_path: - * @icon_view: A #GtkIconView. - * @path: The #GtkTreePath to be selected. + * @icon_view: A `GtkIconView`. + * @path: The `GtkTreePath` to be selected. * * Selects the row at @path. **/ @@ -4960,8 +4960,8 @@ gtk_icon_view_select_path (GtkIconView *icon_view, /** * gtk_icon_view_unselect_path: - * @icon_view: A #GtkIconView. - * @path: The #GtkTreePath to be unselected. + * @icon_view: A `GtkIconView`. + * @path: The `GtkTreePath` to be unselected. * * Unselects the row at @path. **/ @@ -4986,11 +4986,11 @@ gtk_icon_view_unselect_path (GtkIconView *icon_view, /** * gtk_icon_view_get_selected_items: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Creates a list of paths of all selected items. Additionally, if you are * planning on modifying the model after calling this function, you may - * want to convert the returned list into a list of #GtkTreeRowReferences. + * want to convert the returned list into a list of `GtkTreeRowReferences`. * To do this, you can use gtk_tree_row_reference_new(). * * To free the return value, use: @@ -4998,7 +4998,7 @@ gtk_icon_view_unselect_path (GtkIconView *icon_view, * g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); * ]| * - * Returns: (element-type GtkTreePath) (transfer full): A #GList containing a #GtkTreePath for each selected row. + * Returns: (element-type GtkTreePath) (transfer full): A `GList` containing a `GtkTreePath` for each selected row. **/ GList * gtk_icon_view_get_selected_items (GtkIconView *icon_view) @@ -5025,10 +5025,10 @@ gtk_icon_view_get_selected_items (GtkIconView *icon_view) /** * gtk_icon_view_select_all: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Selects all the icons. @icon_view must has its selection mode set - * to #GTK_SELECTION_MULTIPLE. + * to %GTK_SELECTION_MULTIPLE. **/ void gtk_icon_view_select_all (GtkIconView *icon_view) @@ -5059,7 +5059,7 @@ gtk_icon_view_select_all (GtkIconView *icon_view) /** * gtk_icon_view_unselect_all: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * * Unselects all the icons. **/ @@ -5081,8 +5081,8 @@ gtk_icon_view_unselect_all (GtkIconView *icon_view) /** * gtk_icon_view_path_is_selected: - * @icon_view: A #GtkIconView. - * @path: A #GtkTreePath to check selection on. + * @icon_view: A `GtkIconView`. + * @path: A `GtkTreePath` to check selection on. * * Returns %TRUE if the icon pointed to by @path is currently * selected. If @path does not point to a valid location, %FALSE is returned. @@ -5110,8 +5110,8 @@ gtk_icon_view_path_is_selected (GtkIconView *icon_view, /** * gtk_icon_view_get_item_row: - * @icon_view: a #GtkIconView - * @path: the #GtkTreePath of the item + * @icon_view: a `GtkIconView` + * @path: the `GtkTreePath` of the item * * Gets the row in which the item @path is currently * displayed. Row numbers start at 0. @@ -5139,8 +5139,8 @@ gtk_icon_view_get_item_row (GtkIconView *icon_view, /** * gtk_icon_view_get_item_column: - * @icon_view: a #GtkIconView - * @path: the #GtkTreePath of the item + * @icon_view: a `GtkIconView` + * @path: the `GtkTreePath` of the item * * Gets the column in which the item @path is currently * displayed. Column numbers start at 0. @@ -5168,8 +5168,8 @@ gtk_icon_view_get_item_column (GtkIconView *icon_view, /** * gtk_icon_view_item_activated: - * @icon_view: A #GtkIconView - * @path: The #GtkTreePath to be activated + * @icon_view: A `GtkIconView` + * @path: The `GtkTreePath` to be activated * * Activates the item determined by @path. **/ @@ -5185,7 +5185,7 @@ gtk_icon_view_item_activated (GtkIconView *icon_view, /** * gtk_icon_view_set_item_orientation: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @orientation: the relative position of texts and icons * * Sets the ::item-orientation property which determines whether the labels @@ -5221,7 +5221,7 @@ gtk_icon_view_set_item_orientation (GtkIconView *icon_view, /** * gtk_icon_view_get_item_orientation: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::item-orientation property which determines * whether the labels are drawn beside the icons instead of below. @@ -5239,7 +5239,7 @@ gtk_icon_view_get_item_orientation (GtkIconView *icon_view) /** * gtk_icon_view_set_columns: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @columns: the number of columns * * Sets the ::columns property which determines in how @@ -5268,7 +5268,7 @@ gtk_icon_view_set_columns (GtkIconView *icon_view, /** * gtk_icon_view_get_columns: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::columns property. * @@ -5284,7 +5284,7 @@ gtk_icon_view_get_columns (GtkIconView *icon_view) /** * gtk_icon_view_set_item_width: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @item_width: the width for each item * * Sets the ::item-width property which specifies the width @@ -5314,7 +5314,7 @@ gtk_icon_view_set_item_width (GtkIconView *icon_view, /** * gtk_icon_view_get_item_width: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::item-width property. * @@ -5331,7 +5331,7 @@ gtk_icon_view_get_item_width (GtkIconView *icon_view) /** * gtk_icon_view_set_spacing: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @spacing: the spacing * * Sets the ::spacing property which specifies the space @@ -5359,7 +5359,7 @@ gtk_icon_view_set_spacing (GtkIconView *icon_view, /** * gtk_icon_view_get_spacing: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::spacing property. * @@ -5375,7 +5375,7 @@ gtk_icon_view_get_spacing (GtkIconView *icon_view) /** * gtk_icon_view_set_row_spacing: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @row_spacing: the row spacing * * Sets the ::row-spacing property which specifies the space @@ -5402,7 +5402,7 @@ gtk_icon_view_set_row_spacing (GtkIconView *icon_view, /** * gtk_icon_view_get_row_spacing: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::row-spacing property. * @@ -5418,7 +5418,7 @@ gtk_icon_view_get_row_spacing (GtkIconView *icon_view) /** * gtk_icon_view_set_column_spacing: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @column_spacing: the column spacing * * Sets the ::column-spacing property which specifies the space @@ -5445,7 +5445,7 @@ gtk_icon_view_set_column_spacing (GtkIconView *icon_view, /** * gtk_icon_view_get_column_spacing: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::column-spacing property. * @@ -5461,7 +5461,7 @@ gtk_icon_view_get_column_spacing (GtkIconView *icon_view) /** * gtk_icon_view_set_margin: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @margin: the margin * * Sets the ::margin property which specifies the space @@ -5489,7 +5489,7 @@ gtk_icon_view_set_margin (GtkIconView *icon_view, /** * gtk_icon_view_get_margin: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::margin property. * @@ -5505,10 +5505,10 @@ gtk_icon_view_get_margin (GtkIconView *icon_view) /** * gtk_icon_view_set_item_padding: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @item_padding: the item padding * - * Sets the #GtkIconView:item-padding property which specifies the padding + * Sets the `GtkIconView`:item-padding property which specifies the padding * around each of the icon view’s items. */ void @@ -5532,7 +5532,7 @@ gtk_icon_view_set_item_padding (GtkIconView *icon_view, /** * gtk_icon_view_get_item_padding: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Returns the value of the ::item-padding property. * @@ -6253,14 +6253,14 @@ gtk_icon_view_drag_data_received (GObject *source, /** * gtk_icon_view_enable_model_drag_source: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @start_button_mask: Mask of allowed buttons to start drag * @formats: the formats that the drag will support * @actions: the bitmask of possible actions for a drag from this * widget * * Turns @icon_view into a drag source for automatic DND. Calling this - * method sets #GtkIconView:reorderable to %FALSE. + * method sets `GtkIconView`:reorderable to %FALSE. **/ void gtk_icon_view_enable_model_drag_source (GtkIconView *icon_view, @@ -6280,13 +6280,13 @@ gtk_icon_view_enable_model_drag_source (GtkIconView *icon_view, /** * gtk_icon_view_enable_model_drag_dest: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @formats: the formats that the drag will support * @actions: the bitmask of possible actions for a drag to this * widget * * Turns @icon_view into a drop destination for automatic DND. Calling this - * method sets #GtkIconView:reorderable to %FALSE. + * method sets `GtkIconView`:reorderable to %FALSE. **/ void gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view, @@ -6320,10 +6320,10 @@ gtk_icon_view_enable_model_drag_dest (GtkIconView *icon_view, /** * gtk_icon_view_unset_model_drag_source: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this - * method sets #GtkIconView:reorderable to %FALSE. + * method sets `GtkIconView`:reorderable to %FALSE. **/ void gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view) @@ -6341,10 +6341,10 @@ gtk_icon_view_unset_model_drag_source (GtkIconView *icon_view) /** * gtk_icon_view_unset_model_drag_dest: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this - * method sets #GtkIconView:reorderable to %FALSE. + * method sets `GtkIconView`:reorderable to %FALSE. **/ void gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view) @@ -6367,7 +6367,7 @@ gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view) /* These are useful to implement your own custom stuff. */ /** * gtk_icon_view_set_drag_dest_item: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @path: (nullable): The path of the item to highlight * @pos: Specifies where to drop, relative to the item * @@ -6424,7 +6424,7 @@ gtk_icon_view_set_drag_dest_item (GtkIconView *icon_view, /** * gtk_icon_view_get_drag_dest_item: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @path: (out) (optional): Return location for the path of * the highlighted item * @pos: (out) (optional): Return location for the drop position @@ -6452,7 +6452,7 @@ gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view, /** * gtk_icon_view_get_dest_item_at_pos: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @drag_x: the position to determine the destination item for * @drag_y: the position to determine the destination item for * @path: (out) (optional): Return location for the path of the item @@ -6513,10 +6513,10 @@ gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view, /** * gtk_icon_view_create_drag_icon: - * @icon_view: a #GtkIconView - * @path: a #GtkTreePath in @icon_view + * @icon_view: a `GtkIconView` + * @path: a `GtkTreePath` in @icon_view * - * Creates a #cairo_surface_t representation of the item at @path. + * Creates a `cairo_surface_t` representation of the item at @path. * This image is used for a drag icon. * * Returns: (transfer full): a newly-allocated surface of the drag icon. @@ -6563,7 +6563,7 @@ gtk_icon_view_create_drag_icon (GtkIconView *icon_view, /** * gtk_icon_view_get_reorderable: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Retrieves whether the user can reorder the list via drag-and-drop. * See gtk_icon_view_set_reorderable(). @@ -6580,12 +6580,12 @@ gtk_icon_view_get_reorderable (GtkIconView *icon_view) /** * gtk_icon_view_set_reorderable: - * @icon_view: A #GtkIconView. + * @icon_view: A `GtkIconView`. * @reorderable: %TRUE, if the list of items can be reordered. * * This function is a convenience function to allow you to reorder models that - * support the #GtkTreeDragSourceIface and the #GtkTreeDragDestIface. Both - * #GtkTreeStore and #GtkListStore support these. If @reorderable is %TRUE, then + * support the `GtkTreeDragSourceIface` and the `GtkTreeDragDestIface`. Both + * `GtkTreeStore` and `GtkListStore` support these. If @reorderable is %TRUE, then * the user can reorder the model by dragging and dropping rows. The * developer can listen to these changes by connecting to the model's * row_inserted and row_deleted signals. The reordering is implemented by setting up @@ -6632,10 +6632,10 @@ gtk_icon_view_set_reorderable (GtkIconView *icon_view, /** * gtk_icon_view_set_activate_on_single_click: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * @single: %TRUE to emit item-activated on a single click * - * Causes the #GtkIconView::item-activated signal to be emitted on + * Causes the `GtkIconView`::item-activated signal to be emitted on * a single click instead of a double click. **/ void @@ -6655,7 +6655,7 @@ gtk_icon_view_set_activate_on_single_click (GtkIconView *icon_view, /** * gtk_icon_view_get_activate_on_single_click: - * @icon_view: a #GtkIconView + * @icon_view: a `GtkIconView` * * Gets the setting set by gtk_icon_view_set_activate_on_single_click(). * diff --git a/gtk/gtkiconview.h b/gtk/gtkiconview.h index 3bdf57f0c8..087670df20 100644 --- a/gtk/gtkiconview.h +++ b/gtk/gtkiconview.h @@ -38,8 +38,8 @@ typedef struct _GtkIconView GtkIconView; /** * GtkIconViewForeachFunc: - * @icon_view: a #GtkIconView - * @path: The #GtkTreePath of a selected row + * @icon_view: a `GtkIconView` + * @path: The `GtkTreePath` of a selected row * @data: (closure): user data * * A function used by gtk_icon_view_selected_foreach() to map all diff --git a/gtk/gtkimage.h b/gtk/gtkimage.h index c63b37a1c1..21852258e8 100644 --- a/gtk/gtkimage.h +++ b/gtk/gtkimage.h @@ -46,8 +46,8 @@ typedef struct _GtkImage GtkImage; * GtkImageType: * @GTK_IMAGE_EMPTY: there is no image displayed by the widget * @GTK_IMAGE_ICON_NAME: the widget contains a named icon - * @GTK_IMAGE_GICON: the widget contains a #GIcon - * @GTK_IMAGE_PAINTABLE: the widget contains a #GdkPaintable + * @GTK_IMAGE_GICON: the widget contains a `GIcon` + * @GTK_IMAGE_PAINTABLE: the widget contains a `GdkPaintable` * * Describes the image data representation used by a [class@Gtk.Image]. * diff --git a/gtk/gtkimcontext.c b/gtk/gtkimcontext.c index add57517fb..10e883e6ca 100644 --- a/gtk/gtkimcontext.c +++ b/gtk/gtkimcontext.c @@ -123,15 +123,15 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkIMContext, gtk_im_context, G_TYPE_OBJECT /** * GtkIMContextClass: - * @preedit_start: Default handler of the #GtkIMContext::preedit-start signal. - * @preedit_end: Default handler of the #GtkIMContext::preedit-end signal. - * @preedit_changed: Default handler of the #GtkIMContext::preedit-changed + * @preedit_start: Default handler of the `GtkIMContext::preedit-start` signal. + * @preedit_end: Default handler of the `GtkIMContext::preedit-end` signal. + * @preedit_changed: Default handler of the `GtkIMContext::preedit-changed` * signal. - * @commit: Default handler of the #GtkIMContext::commit signal. + * @commit: Default handler of the `GtkIMContext::commit` signal. * @retrieve_surrounding: Default handler of the - * #GtkIMContext::retrieve-surrounding signal. + * `GtkIMContext::retrieve-surrounding` signal. * @delete_surrounding: Default handler of the - * #GtkIMContext::delete-surrounding signal. + * `GtkIMContext::delete-surrounding` signal. * @set_client_widget: Called via gtk_im_context_set_client_widget() when the * input window where the entered text will appear changes. Override this to * keep track of the current input window, for instance for the purpose of @@ -145,7 +145,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkIMContext, gtk_im_context, G_TYPE_OBJECT * key press or release event. Every non-trivial input method needs to * override this in order to implement the mapping from key events to text. * A return value of %TRUE indicates to the caller that the event was - * consumed by the input method. In that case, the #GtkIMContext::commit + * consumed by the input method. In that case, the `GtkIMContext::commit` * signal should be emitted upon completion of a key sequence to pass the * resulting text back to the input widget. Alternatively, %FALSE may be * returned to indicate that the event wasn’t handled by the input method. @@ -166,7 +166,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkIMContext, gtk_im_context, G_TYPE_OBJECT * the use of the preedit string. Override this to display feedback by some * other means if turned off. * @set_surrounding: Called via gtk_im_context_set_surrounding() in response - * to signal #GtkIMContext::retrieve-surrounding to update the input + * to signal `GtkIMContext::retrieve-surrounding` to update the input * method’s idea of the context around the cursor. It is not necessary to * override this method even with input methods which implement * context-dependent behavior. The base implementation is sufficient for @@ -175,10 +175,10 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkIMContext, gtk_im_context, G_TYPE_OBJECT * the context around the cursor location. It is not necessary to override * this method even with input methods which implement context-dependent * behavior. The base implementation emits - * #GtkIMContext::retrieve-surrounding and records the context received + * `GtkIMContext::retrieve-surrounding` and records the context received * by the subsequent invocation of @get_surrounding. * @set_surrounding_with_selection: Called via gtk_im_context_set_surrounding_with_selection() - * in response to signal #GtkIMContext::retrieve-surrounding to update the input + * in response to signal `GtkIMContext::retrieve-surrounding` to update the input * method’s idea of the context around the cursor. It is not necessary to * override this method even with input methods which implement * context-dependent behavior. The base implementation is sufficient for @@ -187,7 +187,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkIMContext, gtk_im_context, G_TYPE_OBJECT * to update the context around the cursor location. It is not necessary to override * this method even with input methods which implement context-dependent * behavior. The base implementation emits - * #GtkIMContext::retrieve-surrounding and records the context received + * `GtkIMContext::retrieve-surrounding` and records the context received * by the subsequent invocation of @get_surrounding. */ static void @@ -741,7 +741,7 @@ gtk_im_context_set_surrounding (GtkIMContext *context, /** * gtk_im_context_set_surrounding_with_selection: - * @context: a #GtkIMContext + * @context: a `GtkIMContext` * @text: text surrounding the insertion point, as UTF-8. * the preedit string should not be included within @text * @len: the length of @text, or -1 if @text is nul-terminated @@ -825,7 +825,7 @@ gtk_im_context_get_surrounding (GtkIMContext *context, /** * gtk_im_context_get_surrounding_with_selection: - * @context: a #GtkIMContext + * @context: a `GtkIMContext` * @text: (out) (transfer full): location to store a UTF-8 encoded * string of text holding context around the insertion point. * If the function returns %TRUE, then you must free the result @@ -905,7 +905,7 @@ gtk_im_context_get_surrounding_with_selection (GtkIMContext *context, * GtkIMContext::delete_surrounding signal. * * Note that @offset and @n_chars are in characters not in bytes - * which differs from the usage other places in #GtkIMContext. + * which differs from the usage other places in `GtkIMContext`. * * In order to use this function, you should first call * gtk_im_context_get_surrounding() to get the current context, and diff --git a/gtk/gtkimcontextsimple.c b/gtk/gtkimcontextsimple.c index 1cbb64cf45..761aa66efd 100644 --- a/gtk/gtkimcontextsimple.c +++ b/gtk/gtkimcontextsimple.c @@ -302,10 +302,10 @@ gtk_im_context_simple_finalize (GObject *obj) /** * gtk_im_context_simple_new: * - * Creates a new #GtkIMContextSimple. + * Creates a new `GtkIMContextSimple`. * - * Returns: a new #GtkIMContextSimple. - **/ + * Returns: a new `GtkIMContextSimple` + */ GtkIMContext * gtk_im_context_simple_new (void) { @@ -1183,7 +1183,7 @@ gtk_im_context_simple_get_preedit_string (GtkIMContext *context, /** * gtk_im_context_simple_add_table: (skip) - * @context_simple: A #GtkIMContextSimple + * @context_simple: A `GtkIMContextSimple` * @data: (array): the table * @max_seq_len: Maximum length of a sequence in the table * @n_seqs: number of sequences in the table @@ -1216,7 +1216,7 @@ gtk_im_context_simple_add_table (GtkIMContextSimple *context_simple, /** * gtk_im_context_simple_add_compose_file: - * @context_simple: A #GtkIMContextSimple + * @context_simple: A `GtkIMContextSimple` * @compose_file: The path of compose file * * Adds an additional table from the X11 compose file. diff --git a/gtk/gtkinfobar.c b/gtk/gtkinfobar.c index 0389ba5e0c..2823f8afc1 100644 --- a/gtk/gtkinfobar.c +++ b/gtk/gtkinfobar.c @@ -1071,7 +1071,7 @@ gtk_info_bar_buildable_add_child (GtkBuildable *buildable, /** * gtk_info_bar_set_message_type: (attributes org.gtk.Method.set_property=message-type) * @info_bar: a `GtkInfoBar` - * @message_type: a #GtkMessageType + * @message_type: a `GtkMessageType` * * Sets the message type of the message area. * diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c index 8e1570b47e..d75c7caf2c 100644 --- a/gtk/gtklabel.c +++ b/gtk/gtklabel.c @@ -113,7 +113,7 @@ * * # Accessibility * - * `GtkLabel` uses the #GTK_ACCESSIBLE_ROLE_LABEL role. + * `GtkLabel` uses the %GTK_ACCESSIBLE_ROLE_LABEL role. * * # Mnemonics * @@ -308,7 +308,7 @@ struct _GtkLabelClass * to ensure that pressing inside a link and releasing outside of it * does not activate the link. * - * Links are rendered with the #GTK_STATE_FLAG_LINK/#GTK_STATE_FLAG_VISITED + * Links are rendered with the %GTK_STATE_FLAG_LINK/%GTK_STATE_FLAG_VISITED * state flags. When the mouse pointer is over a link, the pointer is changed * to indicate the link. * @@ -2079,7 +2079,7 @@ gtk_label_class_init (GtkLabelClass *class) /** * GtkLabel::move-cursor: * @entry: the object which received the signal - * @step: the granularity of the move, as a #GtkMovementStep + * @step: the granularity of the move, as a `GtkMovementStep` * @count: the number of @step units to move * @extend_selection: %TRUE if the move should extend the selection * @@ -2814,7 +2814,7 @@ label_mnemonic_widget_weak_notify (gpointer data, /** * gtk_label_set_mnemonic_widget: (attributes org.gtk.Method.set_property=mnemonic-widget) * @self: a `GtkLabel` - * @widget: (nullable): the target #GtkWidget, or %NULL to unset + * @widget: (nullable): the target `GtkWidget`, or %NULL to unset * * Associate the label with its mnemonic target. * diff --git a/gtk/gtklayoutchild.c b/gtk/gtklayoutchild.c index 6de457a8c0..b04a37bea1 100644 --- a/gtk/gtklayoutchild.c +++ b/gtk/gtklayoutchild.c @@ -176,7 +176,7 @@ gtk_layout_child_get_layout_manager (GtkLayoutChild *layout_child) * * Retrieves the `GtkWidget` associated to the given @layout_child. * - * Returns: (transfer none): a #GtkWidget + * Returns: (transfer none): a `GtkWidget` */ GtkWidget * gtk_layout_child_get_child_widget (GtkLayoutChild *layout_child) diff --git a/gtk/gtklayoutmanager.c b/gtk/gtklayoutmanager.c index 1c8ac2be68..2d6901103c 100644 --- a/gtk/gtklayoutmanager.c +++ b/gtk/gtklayoutmanager.c @@ -234,8 +234,8 @@ gtk_layout_manager_init (GtkLayoutManager *self) /*< private > * gtk_layout_manager_set_widget: - * @layout_manager: a #GtkLayoutManager - * @widget: (nullable): a #GtkWidget + * @layout_manager: a `GtkLayoutManager` + * @widget: (nullable): a `GtkWidget` * * Sets a back pointer from @widget to @layout_manager. */ @@ -263,14 +263,14 @@ gtk_layout_manager_set_widget (GtkLayoutManager *layout_manager, /*< private > * gtk_layout_manager_set_root: - * @layout_manager: a #GtkLayoutManager - * @root: (nullable): a #GtkWidget implementing #GtkRoot + * @layout_manager: a i`GtkLayoutManager` + * @root: (nullable): a `GtkWidget` implementing `GtkRoot` * * Sets a back pointer from @root to @layout_manager. * - * This function is called by #GtkWidget when getting rooted and unrooted, - * and will call #GtkLayoutManagerClass.root() or #GtkLayoutManagerClass.unroot() - * depending on whether @root is a #GtkWidget or %NULL. + * This function is called by `GtkWidget` when getting rooted and unrooted, + * and will call `GtkLayoutManagerClass.root()` or `GtkLayoutManagerClass.unroot()` + * depending on whether @root is a `GtkWidget` or %NULL. */ void gtk_layout_manager_set_root (GtkLayoutManager *layout_manager, @@ -470,11 +470,11 @@ gtk_layout_manager_layout_changed (GtkLayoutManager *manager) /*< private > * gtk_layout_manager_remove_layout_child: - * @manager: a #GtkLayoutManager - * @widget: a #GtkWidget + * @manager: a `GtkLayoutManager` + * @widget: a `GtkWidget` * - * Removes the #GtkLayoutChild associated with @widget from the - * given #GtkLayoutManager, if any is set. + * Removes the `GtkLayoutChild` associated with @widget from the + * given `GtkLayoutManager`, if any is set. */ void gtk_layout_manager_remove_layout_child (GtkLayoutManager *manager, diff --git a/gtk/gtklayoutmanager.h b/gtk/gtklayoutmanager.h index 314d4a0625..676edcd4ff 100644 --- a/gtk/gtklayoutmanager.h +++ b/gtk/gtklayoutmanager.h @@ -34,22 +34,22 @@ G_DECLARE_DERIVABLE_TYPE (GtkLayoutManager, gtk_layout_manager, GTK, LAYOUT_MANA * GtkLayoutManagerClass: * @get_request_mode: a virtual function, used to return the preferred * request mode for the layout manager; for instance, "width for height" - * or "height for width"; see #GtkSizeRequestMode + * or "height for width"; see `GtkSizeRequestMode` * @measure: a virtual function, used to measure the minimum and preferred * sizes of the widget using the layout manager for a given orientation * @allocate: a virtual function, used to allocate the size of the widget * using the layout manager - * @layout_child_type: the type of #GtkLayoutChild used by this layout manager - * @create_layout_child: a virtual function, used to create a #GtkLayoutChild + * @layout_child_type: the type of `GtkLayoutChild` used by this layout manager + * @create_layout_child: a virtual function, used to create a `GtkLayoutChild` * meta object for the layout properties * @root: a virtual function, called when the widget using the layout - * manager is attached to a #GtkRoot + * manager is attached to a `GtkRoot` * @unroot: a virtual function, called when the widget using the layout - * manager is detached from a #GtkRoot + * manager is detached from a `GtkRoot` * * The `GtkLayoutManagerClass` structure contains only private data, and * should only be accessed through the provided API, or when subclassing - * #GtkLayoutManager. + * `GtkLayoutManager`. */ struct _GtkLayoutManagerClass { @@ -79,13 +79,13 @@ struct _GtkLayoutManagerClass /** * GtkLayoutManagerClass::create_layout_child: - * @manager: the #GtkLayoutManager + * @manager: the `GtkLayoutManager` * @widget: the widget using the @manager * @for_child: the child of @widget * - * Create a #GtkLayoutChild instance for the given @for_child widget. + * Create a `GtkLayoutChild` instance for the given @for_child widget. * - * Returns: (transfer full): a #GtkLayoutChild + * Returns: (transfer full): a `GtkLayoutChild` */ GtkLayoutChild * (* create_layout_child) (GtkLayoutManager *manager, GtkWidget *widget, diff --git a/gtk/gtklevelbar.c b/gtk/gtklevelbar.c index ad19f57c46..94e2e2b3d4 100644 --- a/gtk/gtklevelbar.c +++ b/gtk/gtklevelbar.c @@ -78,7 +78,7 @@ * [method@Gtk.LevelBar.set_max_value]. The value will be always drawn in * proportion to the admissible interval, i.e. a value of 15 with a specified * interval between 10 and 20 is equivalent to a value of 0.5 with an interval - * between 0 and 1. When #GTK_LEVEL_BAR_MODE_DISCRETE is used, the bar level + * between 0 and 1. When %GTK_LEVEL_BAR_MODE_DISCRETE is used, the bar level * is rendered as a finite number of separated blocks instead of a single one. * The number of blocks that will be rendered is equal to the number of units * specified by the admissible interval. @@ -117,7 +117,7 @@ * * # Accessibility * - * `GtkLevelBar` uses the #GTK_ACCESSIBLE_ROLE_METER role. + * `GtkLevelBar` uses the %GTK_ACCESSIBLE_ROLE_METER role. */ #include "config.h" @@ -977,9 +977,9 @@ gtk_level_bar_class_init (GtkLevelBarClass *klass) * Determines the way `GtkLevelBar` interprets the value properties to draw the * level fill area. * - * Specifically, when the value is #GTK_LEVEL_BAR_MODE_CONTINUOUS, + * Specifically, when the value is %GTK_LEVEL_BAR_MODE_CONTINUOUS, * `GtkLevelBar` will draw a single block representing the current value in - * that area; when the value is #GTK_LEVEL_BAR_MODE_DISCRETE, + * that area; when the value is %GTK_LEVEL_BAR_MODE_DISCRETE, * the widget will draw a succession of separate blocks filling the * draw area, with the number of blocks being equal to the units separating * the integral roundings of [property@Gtk.LevelBar:min-value] and diff --git a/gtk/gtklevelbar.h b/gtk/gtklevelbar.h index 4444eadfb5..52c9857698 100644 --- a/gtk/gtklevelbar.h +++ b/gtk/gtklevelbar.h @@ -36,21 +36,21 @@ G_BEGIN_DECLS /** * GTK_LEVEL_BAR_OFFSET_LOW: * - * The name used for the stock low offset included by #GtkLevelBar. + * The name used for the stock low offset included by `GtkLevelBar`. */ #define GTK_LEVEL_BAR_OFFSET_LOW "low" /** * GTK_LEVEL_BAR_OFFSET_HIGH: * - * The name used for the stock high offset included by #GtkLevelBar. + * The name used for the stock high offset included by `GtkLevelBar`. */ #define GTK_LEVEL_BAR_OFFSET_HIGH "high" /** * GTK_LEVEL_BAR_OFFSET_FULL: * - * The name used for the stock full offset included by #GtkLevelBar. + * The name used for the stock full offset included by `GtkLevelBar`. */ #define GTK_LEVEL_BAR_OFFSET_FULL "full" diff --git a/gtk/gtklinkbutton.c b/gtk/gtklinkbutton.c index 62d2985b24..05234ccd00 100644 --- a/gtk/gtklinkbutton.c +++ b/gtk/gtklinkbutton.c @@ -49,7 +49,7 @@ * * # Accessibility * - * `GtkLinkButton` uses the #GTK_ACCESSIBLE_ROLE_LINK role. + * `GtkLinkButton` uses the %GTK_ACCESSIBLE_ROLE_LINK role. */ #include "config.h" @@ -198,7 +198,7 @@ gtk_link_button_class_init (GtkLinkButtonClass *klass) /** * GtkLinkButton::activate-link: - * @button: the #GtkLinkButton that emitted the signal + * @button: the `GtkLinkButton` that emitted the signal * * Emitted each time the `GtkLinkButton` is clicked. * diff --git a/gtk/gtklistbase.c b/gtk/gtklistbase.c index b529967c44..5362faf22c 100644 --- a/gtk/gtklistbase.c +++ b/gtk/gtklistbase.c @@ -107,7 +107,7 @@ static GParamSpec *properties[N_PROPS] = { NULL, }; /* * gtk_list_base_get_position_from_allocation: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @across: position in pixels in the direction cross to the list * @along: position in pixels in the direction of the list * @pos: (out caller-allocates): set to the looked up position @@ -262,7 +262,7 @@ gtk_list_base_clear_adjustment (GtkListBase *self, /* * gtk_list_base_move_focus_along: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @pos: position from which to move focus * @steps: steps to move focus - negative numbers move focus backwards * @@ -283,7 +283,7 @@ gtk_list_base_move_focus_along (GtkListBase *self, /* * gtk_list_base_move_focus_across: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @pos: position from which to move focus * @steps: steps to move focus - negative numbers move focus backwards * @@ -322,7 +322,7 @@ gtk_list_base_move_focus (GtkListBase *self, /* * gtk_list_base_get_allocation_along: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @pos: item to get the size of * @offset: (out caller-allocates) (optional): set to the offset * of the top/left of the item @@ -345,7 +345,7 @@ gtk_list_base_get_allocation_along (GtkListBase *self, /* * gtk_list_base_get_allocation_across: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @pos: item to get the size of * @offset: (out caller-allocates) (optional): set to the offset * of the top/left of the item @@ -368,7 +368,7 @@ gtk_list_base_get_allocation_across (GtkListBase *self, /* * gtk_list_base_select_item: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @pos: item to select * @modify: %TRUE if the selection should be modified, %FALSE * if a new selection should be done. This is usually set @@ -1939,7 +1939,7 @@ gtk_list_base_get_anchor (GtkListBase *self) /* * gtk_list_base_set_anchor: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @anchor_pos: position of the item to anchor * @anchor_align_across: how far in the across direction to anchor * @anchor_side_across: if the anchor should side to start or end of item @@ -1999,7 +1999,7 @@ gtk_list_base_set_anchor (GtkListBase *self, /** * gtk_list_base_set_anchor_max_widgets: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @center: the number of widgets in the middle * @above_below: extra widgets above and below * @@ -2039,7 +2039,7 @@ gtk_list_base_set_anchor_max_widgets (GtkListBase *self, /* * gtk_list_base_grab_focus_on_item: - * @self: a #GtkListBase + * @self: a `GtkListBase` * @pos: position of the item to focus * @select: %TRUE to select the item * @modify: if selecting, %TRUE to modify the selected diff --git a/gtk/gtklistbox.c b/gtk/gtklistbox.c index 4513892e32..95120f8cef 100644 --- a/gtk/gtklistbox.c +++ b/gtk/gtklistbox.c @@ -1013,7 +1013,7 @@ gtk_list_box_get_selected_rows (GtkListBox *box) /** * gtk_list_box_set_placeholder: * @box: a `GtkListBox` - * @placeholder: (nullable): a #GtkWidget + * @placeholder: (nullable): a `GtkWidget` * * Sets the placeholder widget that is shown in the list when * it doesn't display any visible children. diff --git a/gtk/gtklistitemmanager.c b/gtk/gtklistitemmanager.c index 02772f7c58..5f263b24ab 100644 --- a/gtk/gtklistitemmanager.c +++ b/gtk/gtklistitemmanager.c @@ -153,7 +153,7 @@ gtk_list_item_manager_get_root (GtkListItemManager *self) /* * gtk_list_item_manager_get_nth: - * @self: a #GtkListItemManager + * @self: a `GtkListItemManager` * @position: position of the item * @offset: (out): offset into the returned item * @@ -897,7 +897,7 @@ gtk_list_item_manager_get_model (GtkListItemManager *self) /* * gtk_list_item_manager_acquire_list_item: - * @self: a #GtkListItemManager + * @self: a `GtkListItemManager` * @position: the row in the model to create a list item for * @prev_sibling: the widget this widget should be inserted before or %NULL * if it should be the first widget @@ -906,7 +906,7 @@ gtk_list_item_manager_get_model (GtkListItemManager *self) * yet exist that is used for @position. * * When the returned item is no longer needed, the caller is responsible - * for calling gtk_list_item_manager_release_list_item(). + * for calling gtk_list_item_manager_release_list_item(). * A particular case is when the row at @position is removed. In that case, * all list items in the removed range must be released before * gtk_list_item_manager_model_changed() is called. @@ -942,7 +942,7 @@ gtk_list_item_manager_acquire_list_item (GtkListItemManager *self, /** * gtk_list_item_manager_try_acquire_list_item_from_change: - * @self: a #GtkListItemManager + * @self: a `GtkListItemManager` * @position: the row in the model to create a list item for * @prev_sibling: the widget this widget should be inserted after or %NULL * if it should be the first widget @@ -991,8 +991,8 @@ gtk_list_item_manager_try_reacquire_list_item (GtkListItemManager *self, /** * gtk_list_item_manager_move_list_item: - * @self: a #GtkListItemManager - * @list_item: an acquired #GtkListItem that should be moved to represent + * @self: a `GtkListItemManager` + * @list_item: an acquired `GtkListItem` that should be moved to represent * a different row * @position: the new position of that list item * @prev_sibling: the new previous sibling @@ -1023,8 +1023,8 @@ gtk_list_item_manager_move_list_item (GtkListItemManager *self, /** * gtk_list_item_manager_update_list_item: - * @self: a #GtkListItemManager - * @item: a #GtkListItem that has been acquired + * @self: a `GtkListItemManager` + * @item: a `GtkListItem` that has been acquired * @position: the new position of that list item * * Updates the position of the given @item. This function must be called whenever @@ -1050,7 +1050,7 @@ gtk_list_item_manager_update_list_item (GtkListItemManager *self, /* * gtk_list_item_manager_release_list_item: - * @self: a #GtkListItemManager + * @self: a `GtkListItemManager` * @change: (nullable): The change associated with this release or * %NULL if this is a final removal * @item: an item previously acquired with diff --git a/gtk/gtklistlistmodel.c b/gtk/gtklistlistmodel.c index 3f5e54ee0d..e7e5f6de5f 100644 --- a/gtk/gtklistlistmodel.c +++ b/gtk/gtklistlistmodel.c @@ -21,9 +21,9 @@ /* * GtkListListModel: * - * #GtkListListModel is a #GListModel implementation that takes a list API - * and provides it as a GListModel. - **/ + * `GtkListListModel` is a `GListModel` implementation that takes a list API + * and provides it as a `GListModel`. + */ #include "config.h" diff --git a/gtk/gtkliststore.c b/gtk/gtkliststore.c index 32af78e5e2..df38e404fa 100644 --- a/gtk/gtkliststore.c +++ b/gtk/gtkliststore.c @@ -34,23 +34,23 @@ * * A list-like data structure that can be used with the GtkTreeView * - * The #GtkListStore object is a list model for use with a #GtkTreeView - * widget. It implements the #GtkTreeModel interface, and consequentialy, + * The `GtkListStore` object is a list model for use with a `GtkTreeView` + * widget. It implements the `GtkTreeModel` interface, and consequentialy, * can use all of the methods available there. It also implements the - * #GtkTreeSortable interface so it can be sorted by the view. + * `GtkTreeSortable` interface so it can be sorted by the view. * Finally, it also implements the tree * [drag and drop][gtk4-GtkTreeView-drag-and-drop] * interfaces. * - * The #GtkListStore can accept most GObject types as a column type, though + * The `GtkListStore` can accept most GObject types as a column type, though * it can’t accept all custom types. Internally, it will keep a copy of * data passed in (such as a string or a boxed pointer). Columns that - * accept #GObjects are handled a little differently. The - * #GtkListStore will keep a reference to the object instead of copying the + * accept `GObject`s are handled a little differently. The + * `GtkListStore` will keep a reference to the object instead of copying the * value. As a result, if the object is modified, it is up to the * application writer to call gtk_tree_model_row_changed() to emit the - * #GtkTreeModel::row_changed signal. This most commonly affects lists with - * #GdkTextures stored. + * `GtkTreeModel`::row_changed signal. This most commonly affects lists with + * `GdkTexture`s stored. * * An example for creating a simple list store: * |[<!-- language="C" --> @@ -105,10 +105,10 @@ * * # Performance Considerations * - * Internally, the #GtkListStore was originally implemented with a linked list + * Internally, the `GtkListStore` was originally implemented with a linked list * with a tail pointer. As a result, it was fast at data insertion and deletion, - * and not fast at random data access. The #GtkListStore sets the - * #GTK_TREE_MODEL_ITERS_PERSIST flag, which means that #GtkTreeIters can be + * and not fast at random data access. The `GtkListStore` sets the + * %GTK_TREE_MODEL_ITERS_PERSIST flag, which means that `GtkTreeIter`s can be * cached while the row exists. Thus, if access to a particular row is needed * often and your code is expected to run on older versions of GTK, it is worth * keeping the iter around. @@ -118,16 +118,16 @@ * It is important to note that only the methods * gtk_list_store_insert_with_values() and gtk_list_store_insert_with_valuesv() * are atomic, in the sense that the row is being appended to the store and the - * values filled in in a single operation with regard to #GtkTreeModel signaling. + * values filled in in a single operation with regard to `GtkTreeModel` signaling. * In contrast, using e.g. gtk_list_store_append() and then gtk_list_store_set() - * will first create a row, which triggers the #GtkTreeModel::row-inserted signal - * on #GtkListStore. The row, however, is still empty, and any signal handler - * connecting to #GtkTreeModel::row-inserted on this particular store should be prepared + * will first create a row, which triggers the `GtkTreeModel`::row-inserted signal + * on `GtkListStore`. The row, however, is still empty, and any signal handler + * connecting to `GtkTreeModel`::row-inserted on this particular store should be prepared * for the situation that the row might be empty. This is especially important - * if you are wrapping the #GtkListStore inside a #GtkTreeModelFilter and are - * using a #GtkTreeModelFilterVisibleFunc. Using any of the non-atomic operations - * to append rows to the #GtkListStore will cause the - * #GtkTreeModelFilterVisibleFunc to be visited with an empty row first; the + * if you are wrapping the `GtkListStore` inside a `GtkTreeModel`Filter and are + * using a `GtkTreeModel`FilterVisibleFunc. Using any of the non-atomic operations + * to append rows to the `GtkListStore` will cause the + * `GtkTreeModel`FilterVisibleFunc to be visited with an empty row first; the * function must be prepared for that. * * # GtkListStore as GtkBuildable @@ -398,17 +398,17 @@ iter_is_valid (GtkTreeIter *iter, /** * gtk_list_store_new: * @n_columns: number of columns in the list store - * @...: all #GType types for the columns, from first to last + * @...: all `GType` types for the columns, from first to last * * Creates a new list store as with @n_columns columns each of the types passed * in. Note that only types derived from standard GObject fundamental types * are supported. * * As an example, `gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING, - * GDK_TYPE_TEXTURE);` will create a new #GtkListStore with three columns, of type - * int, string and #GdkTexture, respectively. + * GDK_TYPE_TEXTURE);` will create a new `GtkListStore` with three columns, of type + * int, string and `GdkTexture`, respectively. * - * Returns: a new #GtkListStore + * Returns: a new `GtkListStore` */ GtkListStore * gtk_list_store_new (int n_columns, @@ -449,11 +449,11 @@ gtk_list_store_new (int n_columns, /** * gtk_list_store_newv: (rename-to gtk_list_store_new) * @n_columns: number of columns in the list store - * @types: (array length=n_columns): an array of #GType types for the columns, from first to last + * @types: (array length=n_columns): an array of `GType` types for the columns, from first to last * * Non-vararg creation function. Used primarily by language bindings. * - * Returns: (transfer full): a new #GtkListStore + * Returns: (transfer full): a new `GtkListStore` **/ GtkListStore * gtk_list_store_newv (int n_columns, @@ -484,13 +484,13 @@ gtk_list_store_newv (int n_columns, /** * gtk_list_store_set_column_types: - * @list_store: A #GtkListStore + * @list_store: A `GtkListStore` * @n_columns: Number of columns for the list store - * @types: (array length=n_columns): An array length n of #GTypes + * @types: (array length=n_columns): An array length n of `GType`s * - * This function is meant primarily for #GObjects that inherit from #GtkListStore, - * and should only be used when constructing a new #GtkListStore. It will not - * function after a row has been added, or a method on the #GtkTreeModel + * This function is meant primarily for `GObject`s that inherit from `GtkListStore`, + * and should only be used when constructing a new `GtkListStore`. It will not + * function after a row has been added, or a method on the `GtkTreeModel` * interface is called. **/ void @@ -910,8 +910,8 @@ gtk_list_store_real_set_value (GtkListStore *list_store, /** * gtk_list_store_set_value: - * @list_store: A #GtkListStore - * @iter: A valid #GtkTreeIter for the row being modified + * @list_store: A `GtkListStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @column: column number to modify * @value: new value for the cell * @@ -1061,8 +1061,8 @@ gtk_list_store_set_valist_internal (GtkListStore *list_store, /** * gtk_list_store_set_valuesv: (rename-to gtk_list_store_set) - * @list_store: A #GtkListStore - * @iter: A valid #GtkTreeIter for the row being modified + * @list_store: A `GtkListStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @columns: (array length=n_values): an array of column numbers * @values: (array length=n_values): an array of GValues * @n_values: the length of the @columns and @values arrays @@ -1109,8 +1109,8 @@ gtk_list_store_set_valuesv (GtkListStore *list_store, /** * gtk_list_store_set_valist: - * @list_store: A #GtkListStore - * @iter: A valid #GtkTreeIter for the row being modified + * @list_store: A `GtkListStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @var_args: va_list of column/value pairs * * See gtk_list_store_set(); this version takes a va_list for use by language @@ -1151,7 +1151,7 @@ gtk_list_store_set_valist (GtkListStore *list_store, /** * gtk_list_store_set: - * @list_store: a #GtkListStore + * @list_store: a `GtkListStore` * @iter: row iterator * @...: pairs of column number and value, terminated with -1 * @@ -1179,8 +1179,8 @@ gtk_list_store_set (GtkListStore *list_store, /** * gtk_list_store_remove: - * @list_store: A #GtkListStore - * @iter: A valid #GtkTreeIter + * @list_store: A `GtkListStore` + * @iter: A valid `GtkTreeIter` * * Removes the given row from the list store. After being removed, * @iter is set to be the next valid row, or invalidated if it pointed @@ -1229,8 +1229,8 @@ gtk_list_store_remove (GtkListStore *list_store, /** * gtk_list_store_insert: - * @list_store: A #GtkListStore - * @iter: (out): An unset #GtkTreeIter to set to the new row + * @list_store: A `GtkListStore` + * @iter: (out): An unset `GtkTreeIter` to set to the new row * @position: position to insert the new row, or -1 for last * * Creates a new row at @position. @iter will be changed to point to this new @@ -1282,9 +1282,9 @@ gtk_list_store_insert (GtkListStore *list_store, /** * gtk_list_store_insert_before: - * @list_store: A #GtkListStore - * @iter: (out): An unset #GtkTreeIter to set to the new row - * @sibling: (nullable): A valid #GtkTreeIter + * @list_store: A `GtkListStore` + * @iter: (out): An unset `GtkTreeIter` to set to the new row + * @sibling: (nullable): A valid `GtkTreeIter` * * Inserts a new row before @sibling. If @sibling is %NULL, then the row will * be appended to the end of the list. @iter will be changed to point to this @@ -1318,9 +1318,9 @@ gtk_list_store_insert_before (GtkListStore *list_store, /** * gtk_list_store_insert_after: - * @list_store: A #GtkListStore - * @iter: (out): An unset #GtkTreeIter to set to the new row - * @sibling: (nullable): A valid #GtkTreeIter + * @list_store: A `GtkListStore` + * @iter: (out): An unset `GtkTreeIter` to set to the new row + * @sibling: (nullable): A valid `GtkTreeIter` * * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be * prepended to the beginning of the list. @iter will be changed to point to @@ -1354,8 +1354,8 @@ gtk_list_store_insert_after (GtkListStore *list_store, /** * gtk_list_store_prepend: - * @list_store: A #GtkListStore - * @iter: (out): An unset #GtkTreeIter to set to the prepend row + * @list_store: A `GtkListStore` + * @iter: (out): An unset `GtkTreeIter` to set to the prepend row * * Prepends a new row to @list_store. @iter will be changed to point to this new * row. The row will be empty after this function is called. To fill in @@ -1374,8 +1374,8 @@ gtk_list_store_prepend (GtkListStore *list_store, /** * gtk_list_store_append: - * @list_store: A #GtkListStore - * @iter: (out): An unset #GtkTreeIter to set to the appended row + * @list_store: A `GtkListStore` + * @iter: (out): An unset `GtkTreeIter` to set to the appended row * * Appends a new row to @list_store. @iter will be changed to point to this new * row. The row will be empty after this function is called. To fill in @@ -1406,7 +1406,7 @@ gtk_list_store_increment_stamp (GtkListStore *list_store) /** * gtk_list_store_clear: - * @list_store: a #GtkListStore. + * @list_store: a `GtkListStore`. * * Removes all rows from the list store. * @@ -1433,13 +1433,13 @@ gtk_list_store_clear (GtkListStore *list_store) /** * gtk_list_store_iter_is_valid: - * @list_store: A #GtkListStore. - * @iter: A #GtkTreeIter. + * @list_store: A `GtkListStore`. + * @iter: A `GtkTreeIter` * * > This function is slow. Only use it for debugging and/or testing * > purposes. * - * Checks if the given iter is a valid iter for this #GtkListStore. + * Checks if the given iter is a valid iter for this `GtkListStore`. * * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. **/ @@ -1678,7 +1678,7 @@ gtk_list_store_reorder_func (GSequenceIter *a, /** * gtk_list_store_reorder: - * @store: A #GtkListStore. + * @store: A `GtkListStore`. * @new_order: (array zero-terminated=1): an array of integers mapping the new * position of each child to its old position before the re-ordering, * i.e. @new_order`[newpos] = oldpos`. It must have @@ -1772,9 +1772,9 @@ generate_order (GSequence *seq, /** * gtk_list_store_swap: - * @store: A #GtkListStore. - * @a: A #GtkTreeIter. - * @b: Another #GtkTreeIter. + * @store: A `GtkListStore`. + * @a: A `GtkTreeIter` + * @b: Another `GtkTreeIter` * * Swaps @a and @b in @store. Note that this function only works with * unsorted stores. @@ -1838,9 +1838,9 @@ gtk_list_store_move_to (GtkListStore *store, /** * gtk_list_store_move_before: - * @store: A #GtkListStore. - * @iter: A #GtkTreeIter. - * @position: (nullable): A #GtkTreeIter + * @store: A `GtkListStore`. + * @iter: A `GtkTreeIter` + * @position: (nullable): A `GtkTreeIter` * * Moves @iter in @store to the position before @position. Note that this * function only works with unsorted stores. If @position is %NULL, @iter @@ -1869,9 +1869,9 @@ gtk_list_store_move_before (GtkListStore *store, /** * gtk_list_store_move_after: - * @store: A #GtkListStore. - * @iter: A #GtkTreeIter. - * @position: (nullable): A #GtkTreeIter + * @store: A `GtkListStore`. + * @iter: A `GtkTreeIter` + * @position: (nullable): A `GtkTreeIter` * * Moves @iter in @store to the position after @position. Note that this * function only works with unsorted stores. If @position is %NULL, @iter @@ -2147,8 +2147,8 @@ gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable) /** * gtk_list_store_insert_with_values: - * @list_store: A #GtkListStore - * @iter: (out) (optional): An unset #GtkTreeIter to set to the new row + * @list_store: A `GtkListStore` + * @iter: (out) (optional): An unset `GtkTreeIter` to set to the new row * @position: position to insert the new row, or -1 to append after existing * rows * @...: pairs of column number and value, terminated with -1 @@ -2176,12 +2176,12 @@ gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable) * } * ]| * - * with the difference that the former will only emit #GtkTreeModel::row-inserted - * once, while the latter will emit #GtkTreeModel::row-inserted, - * #GtkTreeModel::row-changed and, if the list store is sorted, - * #GtkTreeModel::rows-reordered for every inserted value. + * with the difference that the former will only emit `GtkTreeModel`::row-inserted + * once, while the latter will emit `GtkTreeModel`::row-inserted, + * `GtkTreeModel`::row-changed and, if the list store is sorted, + * `GtkTreeModel`::rows-reordered for every inserted value. * - * Since emitting the #GtkTreeModel::rows-reordered signal repeatedly can + * Since emitting the `GtkTreeModel::rows-reordered` signal repeatedly can * affect the performance of the program, gtk_list_store_insert_with_values() * should generally be preferred when inserting rows in a sorted list store. */ @@ -2248,8 +2248,8 @@ gtk_list_store_insert_with_values (GtkListStore *list_store, /** * gtk_list_store_insert_with_valuesv: (rename-to gtk_list_store_insert_with_values) - * @list_store: A #GtkListStore - * @iter: (out) (optional): An unset #GtkTreeIter to set to the new row + * @list_store: A `GtkListStore` + * @iter: (out) (optional): An unset `GtkTreeIter` to set to the new row * @position: position to insert the new row, or -1 for last * @columns: (array length=n_values): an array of column numbers * @values: (array length=n_values): an array of GValues diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c index 6ea63ab6d3..accaee07c1 100644 --- a/gtk/gtkmain.c +++ b/gtk/gtkmain.c @@ -607,8 +607,8 @@ gtk_init_check (void) * applications. It will initialize everything needed to operate the * toolkit and parses some standard command line options. * - * If you are using #GtkApplication, you don't have to call gtk_init() - * or gtk_init_check(); the #GApplication::startup handler + * If you are using `GtkApplication`, you don't have to call gtk_init() + * or gtk_init_check(); the `GApplication::startup` handler * does it for you. * * This function will terminate your program if it was unable to @@ -738,7 +738,7 @@ gtk_is_initialized (void) * gtk_widget_set_default_direction (direction); * ]| * - * Returns: the #GtkTextDirection of the current locale + * Returns: the `GtkTextDirection` of the current locale */ GtkTextDirection gtk_get_locale_direction (void) @@ -762,17 +762,22 @@ gtk_get_locale_direction (void) /** * gtk_get_default_language: * - * Returns the #PangoLanguage for the default language currently in - * effect. (Note that this can change over the life of an - * application.) The default language is derived from the current - * locale. It determines, for example, whether GTK uses the - * right-to-left or left-to-right text direction. + * Returns the `PangoLanguage` for the default language + * currently in effect. * - * This function is equivalent to pango_language_get_default(). + * Note that this can change over the life of an + * application. + * + * The default language is derived from the current + * locale. It determines, for example, whether GTK uses + * the right-to-left or left-to-right text direction. + * + * This function is equivalent to + * [func@Pango.Language.get_default]. * See that function for details. * - * Returns: (transfer none): the default language as a #PangoLanguage, - * must not be freed + * Returns: (transfer none): the default language as a + * `PangoLanguage` */ PangoLanguage * gtk_get_default_language (void) @@ -1782,7 +1787,7 @@ gtk_get_current_event_time (void) /** * gtk_get_event_widget: - * @event: a #GdkEvent + * @event: a `GdkEvent` * * If @event is %NULL or the event was not associated with any widget, * returns %NULL, otherwise returns the widget that received the event @@ -1892,14 +1897,14 @@ gtk_propagate_event_internal (GtkWidget *widget, /** * gtk_propagate_event: - * @widget: a #GtkWidget + * @widget: a `GtkWidget` * @event: an event * * Sends an event to a widget, propagating the event to parent widgets * if the event remains unhandled. This function will emit the event * through all the hierarchy of @widget through all propagation phases. * - * Events received by GTK from GDK normally begin at a #GtkRoot widget. + * Events received by GTK from GDK normally begin at a `GtkRoot` widget. * Depending on the type of event, existence of modal dialogs, grabs, etc., * the event may be propagated; if so, this function is used. * diff --git a/gtk/gtkmenubutton.c b/gtk/gtkmenubutton.c index 2566c7cb00..d3b85ea72a 100644 --- a/gtk/gtkmenubutton.c +++ b/gtk/gtkmenubutton.c @@ -77,7 +77,7 @@ * * # Accessibility * - * `GtkMenuButton` uses the #GTK_ACCESSIBLE_ROLE_BUTTON role. + * `GtkMenuButton` uses the %GTK_ACCESSIBLE_ROLE_BUTTON role. */ #include "config.h" diff --git a/gtk/gtkmenubutton.h b/gtk/gtkmenubutton.h index efe985fcb7..4ac9da798b 100644 --- a/gtk/gtkmenubutton.h +++ b/gtk/gtkmenubutton.h @@ -38,7 +38,7 @@ typedef struct _GtkMenuButton GtkMenuButton; /** * GtkMenuButtonCreatePopupFunc: - * @menu_button: the #GtkMenuButton + * @menu_button: the `GtkMenuButton` * @user_data: User data passed to gtk_menu_button_set_create_popup_func() * * User-provided callback function to create a popup for a diff --git a/gtk/gtkmenutracker.c b/gtk/gtkmenutracker.c index 224abafaa7..4fccce4a02 100644 --- a/gtk/gtkmenutracker.c +++ b/gtk/gtkmenutracker.c @@ -24,32 +24,32 @@ /*< private > * GtkMenuTracker: * - * #GtkMenuTracker is a simple object to ease implementations of #GMenuModel. - * Given a #GtkActionObservable (usually a #GActionMuxer) along with a - * #GMenuModel, it will tell you which menu items to create and where to place + * GtkMenuTracker is a simple object to ease implementations of GMenuModel. + * Given a GtkActionObservable (usually a GActionMuxer) along with a + * GMenuModel, it will tell you which menu items to create and where to place * them. If a menu item is removed, it will tell you the position of the menu * item to remove. * - * Using #GtkMenuTracker is fairly simple. The only guarantee you must make - * to #GtkMenuTracker is that you must obey all insert signals and track the - * position of items that #GtkMenuTracker gives you. That is, #GtkMenuTracker + * Using GtkMenuTracker is fairly simple. The only guarantee you must make + * to GtkMenuTracker is that you must obey all insert signals and track the + * position of items that GtkMenuTracker gives you. That is, GtkMenuTracker * expects positions of all the latter items to change when it calls your * insertion callback with an early position, as it may ask you to remove * an item with a readjusted position later. * - * #GtkMenuTracker will give you a #GtkMenuTrackerItem in your callback. You + * GtkMenuTracker will give you a GtkMenuTrackerItem in your callback. You * must hold onto this object until a remove signal is emitted. This item * represents a single menu item, which can be one of three classes: normal item, * separator, or submenu. * - * Certain properties on the #GtkMenuTrackerItem are mutable, and you must + * Certain properties on the GtkMenuTrackerItem are mutable, and you must * listen for changes in the item. For more details, see the documentation - * for #GtkMenuTrackerItem along with https://wiki.gnome.org/Projects/GLib/GApplication/GMenuModel. + * for GtkMenuTrackerItem along with https://wiki.gnome.org/Projects/GLib/GApplication/GMenuModel. * * The idea of @with_separators is for special cases where menu models may * be tracked in places where separators are not available, like in toplevel - * "File", “Edit” menu bars. Ignoring separator items is wrong, as #GtkMenuTracker - * expects the position to change, so we must tell #GtkMenuTracker to ignore + * "File", “Edit” menu bars. Ignoring separator items is wrong, as GtkMenuTracker + * expects the position to change, so we must tell GtkMenuTracker to ignore * separators itself. */ @@ -540,10 +540,10 @@ gtk_menu_tracker_section_new (GtkMenuTracker *tracker, * this case -- to the section menu item corresponding to the separator. * This is useful if the section specifies a label, for example. If * there is an “action-namespace” attribute on this menu item then it - * should be ignored by the consumer because #GtkMenuTracker has already + * should be ignored by the consumer because GtkMenuTracker has already * handled it. * - * When using #GtkMenuTracker there is no need to hold onto @model or + * When using GtkMenuTracker there is no need to hold onto @model or * monitor it for changes. The model will be unreffed when * gtk_menu_tracker_free() is called. */ @@ -602,7 +602,7 @@ gtk_menu_tracker_new_for_item_link (GtkMenuTrackerItem *item, /*< private > * gtk_menu_tracker_free: - * @tracker: a #GtkMenuTracker + * @tracker: a GtkMenuTracker * * Frees the tracker, ... */ diff --git a/gtk/gtkmenutrackeritem.c b/gtk/gtkmenutrackeritem.c index 59d3b19af4..1f621ed3d1 100644 --- a/gtk/gtkmenutrackeritem.c +++ b/gtk/gtkmenutrackeritem.c @@ -29,7 +29,7 @@ /*< private > * GtkMenuTrackerItem: * - * A #GtkMenuTrackerItem is a small helper class used by #GtkMenuTracker to + * A GtkMenuTrackerItem is a small helper class used by GtkMenuTracker to * represent menu items. It has one of three classes: normal item, separator, * or submenu. * @@ -50,11 +50,11 @@ * GtkMenuTrackerItem::is-separator and GtkMenuTrackerItem::has-submenu are * allowed to change, so listen to the notify signals to update your item's * appearance. When using a GObject library, this can conveniently be done - * with g_object_bind_property() and #GBinding, and this is how this is - * implemented in GTK; the appearance side is implemented in #GtkModelMenuItem. + * with g_object_bind_property() and GBinding, and this is how this is + * implemented in GTK; the appearance side is implemented in GtkModelMenuItem. * * When an item is clicked, simply call gtk_menu_tracker_item_activated() in - * response. The #GtkMenuTrackerItem will take care of everything related to + * response. The GtkMenuTrackerItem will take care of everything related to * activating the item and will itself update the state of all items in * response. * @@ -577,11 +577,11 @@ _gtk_menu_tracker_item_get_observable (GtkMenuTrackerItem *self) /*< private > * gtk_menu_tracker_item_get_is_separator: - * @self: A #GtkMenuTrackerItem instance + * @self: A GtkMenuTrackerItem instance * * Returns: whether the menu item is a separator. If so, only * certain properties may need to be obeyed. See the documentation - * for #GtkMenuTrackerItem. + * for GtkMenuTrackerItem. */ gboolean gtk_menu_tracker_item_get_is_separator (GtkMenuTrackerItem *self) @@ -591,11 +591,11 @@ gtk_menu_tracker_item_get_is_separator (GtkMenuTrackerItem *self) /*< private > * gtk_menu_tracker_item_get_has_submenu: - * @self: A #GtkMenuTrackerItem instance + * @self: A GtkMenuTrackerItem instance * * Returns: whether the menu item has a submenu. If so, only * certain properties may need to be obeyed. See the documentation - * for #GtkMenuTrackerItem. + * for GtkMenuTrackerItem. */ gboolean gtk_menu_tracker_item_get_has_link (GtkMenuTrackerItem *self, @@ -972,7 +972,7 @@ gtk_menu_tracker_item_request_submenu_shown (GtkMenuTrackerItem *self, /* * gtk_menu_tracker_item_get_is_visible: - * @self: A #GtkMenuTrackerItem instance + * @self: A GtkMenuTrackerItem instance * * Don't use this unless you're tracking items for yourself -- normally * the tracker will emit add/remove automatically when this changes. @@ -987,7 +987,7 @@ gtk_menu_tracker_item_get_is_visible (GtkMenuTrackerItem *self) /* * gtk_menu_tracker_item_may_disappear: - * @self: A #GtkMenuTrackerItem instance + * @self: A GtkMenuTrackerItem instance * * Returns: if the item may disappear (ie: is-visible property may change) */ diff --git a/gtk/gtkmodelbutton.c b/gtk/gtkmodelbutton.c index 531fa25dea..b3bfd0b05c 100644 --- a/gtk/gtkmodelbutton.c +++ b/gtk/gtkmodelbutton.c @@ -50,33 +50,33 @@ /*< private > * GtkModelButton: * - * GtkModelButton is a button class that can use a #GAction as its model. - * In contrast to #GtkToggleButton or #GtkCheckButton, which can also - * be backed by a #GAction via the #GtkActionable:action-name property, + * GtkModelButton is a button class that can use a GAction as its model. + * In contrast to GtkToggleButton or GtkCheckButton, which can also + * be backed by a GAction via the GtkActionable:action-name property, * GtkModelButton will adapt its appearance according to the kind of * action it is backed by, and appear either as a plain, check or * radio button. * * Model buttons are used when popovers from a menu model with * gtk_popover_menu_new_from_model(); they can also be used manually in - * a #GtkPopoverMenu. + * a GtkPopoverMenu. * - * When the action is specified via the #GtkActionable:action-name - * and #GtkActionable:action-target properties, the role of the button + * When the action is specified via the GtkActionable:action-name + * and GtkActionable:action-target properties, the role of the button * (i.e. whether it is a plain, check or radio button) is determined by * the type of the action and doesn't have to be explicitly specified - * with the #GtkModelButton:role property. + * with the GtkModelButton:role property. * - * The content of the button is specified by the #GtkModelButton:text - * and #GtkModelButton:icon properties. + * The content of the button is specified by the GtkModelButton:text + * and GtkModelButton:icon properties. * * The appearance of model buttons can be influenced with the - * #GtkModelButton:iconic property. + * GtkModelButton:iconic property. * - * Model buttons have built-in support for submenus in #GtkPopoverMenu. + * Model buttons have built-in support for submenus in GtkPopoverMenu. * To make a GtkModelButton that opens a submenu when activated, set - * the #GtkModelButton:menu-name property. To make a button that goes - * back to the parent menu, you should set the #GtkModelButton:inverted + * the GtkModelButton:menu-name property. To make a button that goes + * back to the parent menu, you should set the GtkModelButton:inverted * property to place the submenu indicator at the opposite side. * * # Example @@ -149,7 +149,7 @@ * ╰── check * ]| * - * Iconic model buttons (see #GtkModelButton:iconic) change the name of + * Iconic model buttons (see GtkModelButton:iconic) change the name of * their main node to button and add a .model style class to it. The indicator * subnode is invisible in this case. */ @@ -1162,7 +1162,7 @@ gtk_model_button_class_init (GtkModelButtonClass *class) * GtkModelButton:role: * * Specifies whether the button is a plain, check or radio button. - * When #GtkActionable:action-name is set, the role will be determined + * When GtkActionable:action-name is set, the role will be determined * from the action and does not have to be set explicitly. */ properties[PROP_ROLE] = @@ -1176,7 +1176,7 @@ gtk_model_button_class_init (GtkModelButtonClass *class) /** * GtkModelButton:icon: * - * A #GIcon that will be used if iconic appearance for the button is + * A GIcon that will be used if iconic appearance for the button is * desired. */ properties[PROP_ICON] = @@ -1216,7 +1216,7 @@ gtk_model_button_class_init (GtkModelButtonClass *class) * GtkModelButton:active: * * The state of the button. This is reflecting the state of the associated - * #GAction. + * GAction. */ properties[PROP_ACTIVE] = g_param_spec_boolean ("active", @@ -1261,7 +1261,7 @@ gtk_model_button_class_init (GtkModelButtonClass *class) /** * GtkModelButton:indicator-size-group: * - * Containers like #GtkPopoverMenu can provide a size group + * Containers like GtkPopoverMenu can provide a size group * in this property to align the checks and radios of all * the model buttons in a menu. */ @@ -1499,7 +1499,7 @@ gtk_model_button_init (GtkModelButton *self) * * Creates a new GtkModelButton. * - * Returns: the newly created #GtkModelButton widget + * Returns: the newly created GtkModelButton widget */ GtkWidget * gtk_model_button_new (void) diff --git a/gtk/gtkmodelbuttonprivate.h b/gtk/gtkmodelbuttonprivate.h index db10e01476..2c0f0a5610 100644 --- a/gtk/gtkmodelbuttonprivate.h +++ b/gtk/gtkmodelbuttonprivate.h @@ -39,7 +39,7 @@ typedef struct _GtkModelButton GtkModelButton; * @GTK_BUTTON_ROLE_RADIO: A radio button * @GTK_BUTTON_ROLE_TITLE: The title for a submenu * - * The role specifies the desired appearance of a #GtkModelButton. + * The role specifies the desired appearance of a GtkModelButton. */ typedef enum { GTK_BUTTON_ROLE_NORMAL, diff --git a/gtk/gtknativedialog.h b/gtk/gtknativedialog.h index a4e75680d4..8015386496 100644 --- a/gtk/gtknativedialog.h +++ b/gtk/gtknativedialog.h @@ -34,9 +34,9 @@ G_DECLARE_DERIVABLE_TYPE (GtkNativeDialog, gtk_native_dialog, GTK, NATIVE_DIALOG /** * GtkNativeDialogClass: - * @response: class handler for the #GtkNativeDialog::response signal + * @response: class handler for the `GtkNativeDialog::response` signal * - * Class structure for #GtkNativeDialog. + * Class structure for `GtkNativeDialog`. */ struct _GtkNativeDialogClass { diff --git a/gtk/gtknativeprivate.h b/gtk/gtknativeprivate.h index df9b9ffaa6..021402dcbf 100644 --- a/gtk/gtknativeprivate.h +++ b/gtk/gtknativeprivate.h @@ -8,7 +8,7 @@ G_BEGIN_DECLS /** * GtkNativeIface: * - * The list of functions that must be implemented for the #GtkNative interface. + * The list of functions that must be implemented for the `GtkNative` interface. */ struct _GtkNativeInterface { diff --git a/gtk/gtknotebook.c b/gtk/gtknotebook.c index d62c38f2aa..cf2a7a9310 100644 --- a/gtk/gtknotebook.c +++ b/gtk/gtknotebook.c @@ -1298,7 +1298,7 @@ gtk_notebook_class_init (GtkNotebookClass *class) /** * GtkNotebook::page-reordered: * @notebook: the `GtkNotebook` - * @child: the child #GtkWidget affected + * @child: the child `GtkWidget` affected * @page_num: the new page number for @child * * the ::page-reordered signal is emitted in the notebook @@ -1320,7 +1320,7 @@ gtk_notebook_class_init (GtkNotebookClass *class) /** * GtkNotebook::page-removed: * @notebook: the `GtkNotebook` - * @child: the child #GtkWidget affected + * @child: the child `GtkWidget` affected * @page_num: the @child page number * * the ::page-removed signal is emitted in the notebook @@ -1342,7 +1342,7 @@ gtk_notebook_class_init (GtkNotebookClass *class) /** * GtkNotebook::page-added: * @notebook: the `GtkNotebook` - * @child: the child #GtkWidget affected + * @child: the child `GtkWidget` affected * @page_num: the new page number for @child * * the ::page-added signal is emitted in the notebook @@ -5705,7 +5705,7 @@ gtk_notebook_append_page (GtkNotebook *notebook, * for the page, or %NULL to use the default label, “page N” * @menu_label: (nullable): the widget to use as a label for the * page-switch menu, if that is enabled. If %NULL, and @tab_label - * is a #GtkLabel or %NULL, then the menu label will be a newly + * is a `GtkLabel` or %NULL, then the menu label will be a newly * created label with the same text as @tab_label; if @tab_label * is not a `GtkLabel`, @menu_label must be specified if the * page-switch menu is to be used. @@ -5734,7 +5734,7 @@ gtk_notebook_append_page_menu (GtkNotebook *notebook, * gtk_notebook_prepend_page: * @notebook: a `GtkNotebook` * @child: the `GtkWidget` to use as the contents of the page - * @tab_label: (nullable): the #GtkWidget to be used as the label + * @tab_label: (nullable): the `GtkWidget` to be used as the label * for the page, or %NULL to use the default label, “page N” * * Prepends a page to @notebook. @@ -5762,9 +5762,9 @@ gtk_notebook_prepend_page (GtkNotebook *notebook, * for the page, or %NULL to use the default label, “page N” * @menu_label: (nullable): the widget to use as a label for the * page-switch menu, if that is enabled. If %NULL, and @tab_label - * is a #GtkLabel or %NULL, then the menu label will be a newly + * is a `GtkLabel` or %NULL, then the menu label will be a newly * created label with the same text as @tab_label; if @tab_label - * is not a #GtkLabel, @menu_label must be specified if the + * is not a `GtkLabel`, @menu_label must be specified if the * page-switch menu is to be used. * * Prepends a page to @notebook, specifying the widget to use as the @@ -5852,9 +5852,9 @@ gtk_notebook_mnemonic_activate_switch_page (GtkWidget *child, * for the page, or %NULL to use the default label, “page N” * @menu_label: (nullable): the widget to use as a label for the * page-switch menu, if that is enabled. If %NULL, and @tab_label - * is a #GtkLabel or %NULL, then the menu label will be a newly + * is a `GtkLabel` or %NULL, then the menu label will be a newly * created label with the same text as @tab_label; if @tab_label - * is not a #GtkLabel, @menu_label must be specified if the + * is not a `GtkLabel`, @menu_label must be specified if the * page-switch menu is to be used. * @position: the index (starting at 0) at which to insert the page, * or -1 to append the page after all other pages. @@ -7113,7 +7113,7 @@ gtk_notebook_get_action_widget (GtkNotebook *notebook, /** * gtk_notebook_set_action_widget: * @notebook: a `GtkNotebook` - * @widget: a #GtkWidget + * @widget: a `GtkWidget` * @pack_type: pack type of the action widget * * Sets @widget as one of the action widgets. diff --git a/gtk/gtkoverlay.c b/gtk/gtkoverlay.c index 04ec0093a6..4fba2b476a 100644 --- a/gtk/gtkoverlay.c +++ b/gtk/gtkoverlay.c @@ -325,7 +325,7 @@ gtk_overlay_class_init (GtkOverlayClass *klass) /** * GtkOverlay::get-child-position: - * @overlay: the #GtkOverlay + * @overlay: the `GtkOverlay` * @widget: the child widget to position * @allocation: (type Gdk.Rectangle) (out caller-allocates): return * location for the allocation diff --git a/gtk/gtkpadcontroller.c b/gtk/gtkpadcontroller.c index ddee7931e6..49e7ae512e 100644 --- a/gtk/gtkpadcontroller.c +++ b/gtk/gtkpadcontroller.c @@ -500,7 +500,7 @@ gtk_pad_controller_set_action_entries (GtkPadController *controller, * @mode: the mode that will trigger this action, or -1 for all modes. * @label: Human readable description of this action, this string should * be deemed user-visible. - * @action_name: action name that will be activated in the #GActionGroup + * @action_name: action name that will be activated in the `GActionGroup` * * Adds an individual action to @controller. * diff --git a/gtk/gtkpadcontroller.h b/gtk/gtkpadcontroller.h index c1163d13c3..c544305734 100644 --- a/gtk/gtkpadcontroller.h +++ b/gtk/gtkpadcontroller.h @@ -62,7 +62,7 @@ typedef enum { * @mode: the mode that will trigger this action entry, or -1 for all modes. * @label: Human readable description of this action entry, this string should * be deemed user-visible. - * @action_name: action name that will be activated in the #GActionGroup. + * @action_name: action name that will be activated in the `GActionGroup`. * * Struct defining a pad action entry. */ diff --git a/gtk/gtkpagesetup.c b/gtk/gtkpagesetup.c index d106edab9a..97c23beef9 100644 --- a/gtk/gtkpagesetup.c +++ b/gtk/gtkpagesetup.c @@ -180,7 +180,7 @@ gtk_page_setup_get_orientation (GtkPageSetup *setup) /** * gtk_page_setup_set_orientation: * @setup: a `GtkPageSetup` - * @orientation: a #GtkPageOrientation value + * @orientation: a `GtkPageOrientation` value * * Sets the page orientation of the `GtkPageSetup`. */ @@ -210,7 +210,7 @@ gtk_page_setup_get_paper_size (GtkPageSetup *setup) /** * gtk_page_setup_set_paper_size: * @setup: a `GtkPageSetup` - * @size: a #GtkPaperSize + * @size: a `GtkPaperSize` * * Sets the paper size of the `GtkPageSetup` without * changing the margins. @@ -237,7 +237,7 @@ gtk_page_setup_set_paper_size (GtkPageSetup *setup, /** * gtk_page_setup_set_paper_size_and_default_margins: * @setup: a `GtkPageSetup` - * @size: a #GtkPaperSize + * @size: a `GtkPaperSize` * * Sets the paper size of the `GtkPageSetup` and modifies * the margins according to the new paper size. @@ -797,7 +797,7 @@ gtk_page_setup_to_key_file (GtkPageSetup *setup, * * Serialize page setup to an a{sv} variant. * - * Return: (transfer none): a new, floating, #GVariant + * Return: (transfer none): a new, floating, `GVariant` */ GVariant * gtk_page_setup_to_gvariant (GtkPageSetup *setup) diff --git a/gtk/gtkpaned.c b/gtk/gtkpaned.c index bbef9d0ac5..e12c8e5c9c 100644 --- a/gtk/gtkpaned.c +++ b/gtk/gtkpaned.c @@ -608,7 +608,7 @@ gtk_paned_class_init (GtkPanedClass *class) /** * GtkPaned::move-handle: * @widget: the object that received the signal - * @scroll_type: a #GtkScrollType + * @scroll_type: a `GtkScrollType` * * Emitted to move the handle with key bindings. * diff --git a/gtk/gtkpango.c b/gtk/gtkpango.c index a712944170..8a176b56aa 100644 --- a/gtk/gtkpango.c +++ b/gtk/gtkpango.c @@ -38,8 +38,8 @@ attr_list_merge_filter (PangoAttribute *attribute, /* * _gtk_pango_attr_list_merge: - * @into: (nullable): a #PangoAttrList where attributes are merged - * @from: (nullable): a #PangoAttrList with the attributes to merge + * @into: (nullable): a `PangoAttrList` where attributes are merged + * @from: (nullable): a `PangoAttrList` with the attributes to merge * * Merges attributes from @from into @into. * diff --git a/gtk/gtkpasswordentry.c b/gtk/gtkpasswordentry.c index 1ea23a9704..1c11f5cb6a 100644 --- a/gtk/gtkpasswordentry.c +++ b/gtk/gtkpasswordentry.c @@ -142,7 +142,7 @@ focus_changed (GtkWidget *widget) /*< private > * gtk_password_entry_toggle_peek: - * @entry: a #GtkPasswordEntry + * @entry: a `GtkPasswordEntry` * * Toggles the text visibility. */ @@ -549,11 +549,11 @@ gtk_password_entry_accessible_init (GtkAccessibleInterface *iface) /*< private > * gtk_password_entry_get_text_widget - * @entry: a #GtkPasswordEntry + * @entry: a `GtkPasswordEntry` * - * Retrieves the #GtkText delegate of the #GtkPasswordEntry. + * Retrieves the `GtkText` delegate of the `GtkPasswordEntry`. * - * Returns: (transfer none): the #GtkText delegate widget + * Returns: (transfer none): the `GtkText` delegate widget */ GtkText * gtk_password_entry_get_text_widget (GtkPasswordEntry *entry) diff --git a/gtk/gtkpasswordentrybuffer.c b/gtk/gtkpasswordentrybuffer.c index bc9cc0daa9..bbb51311c7 100644 --- a/gtk/gtkpasswordentrybuffer.c +++ b/gtk/gtkpasswordentrybuffer.c @@ -195,7 +195,7 @@ gtk_password_entry_buffer_init (GtkPasswordEntryBuffer *self) /*< private > * gtk_password_entry_buffer_new: * - * Creates a new #GtkEntryBuffer using secure memory allocations. + * Creates a new `GtkEntryBuffer` using secure memory allocations. * * Returns: (transfer full): the newly created instance */ diff --git a/gtk/gtkpathbar.c b/gtk/gtkpathbar.c index def05495d4..ee1b1be68d 100644 --- a/gtk/gtkpathbar.c +++ b/gtk/gtkpathbar.c @@ -1318,7 +1318,7 @@ _gtk_path_bar_set_file (GtkPathBar *path_bar, /** * _gtk_path_bar_up: - * @path_bar: a #GtkPathBar + * @path_bar: a `GtkPathBar` * * If the selected button in the pathbar is not the furthest button “up” (in the * root direction), act as if the user clicked on the next button up. @@ -1345,7 +1345,7 @@ _gtk_path_bar_up (GtkPathBar *path_bar) /** * _gtk_path_bar_down: - * @path_bar: a #GtkPathBar + * @path_bar: a `GtkPathBar` * * If the selected button in the pathbar is not the furthest button “down” (in the * leaf direction), act as if the user clicked on the next button down. diff --git a/gtk/gtkplacessidebar.c b/gtk/gtkplacessidebar.c index e64e3df699..d4a1f74e5d 100644 --- a/gtk/gtkplacessidebar.c +++ b/gtk/gtkplacessidebar.c @@ -66,9 +66,9 @@ /*< private > * GtkPlacesSidebar: * - * #GtkPlacesSidebar is a widget that displays a list of frequently-used places in the + * GtkPlacesSidebar is a widget that displays a list of frequently-used places in the * file system: the user’s home directory, the user’s bookmarks, and volumes and drives. - * This widget is used as a sidebar in #GtkFileChooser and may be used by file managers + * This widget is used as a sidebar in GtkFileChooser and may be used by file managers * and similar programs. * * The places sidebar displays drives and volumes, and will automatically mount @@ -84,7 +84,7 @@ * for a Clipart folder. You can do this with gtk_places_sidebar_add_shortcut(). * * To make use of the places sidebar, an application at least needs to connect - * to the #GtkPlacesSidebar::open-location signal. This is emitted when the + * to the GtkPlacesSidebar::open-location signal. This is emitted when the * user selects in the sidebar a location to open. The application should also * call gtk_places_sidebar_set_location() when it changes the currently-viewed * location. @@ -4101,8 +4101,8 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * GtkPlacesSidebar::open-location: * @sidebar: the object which received the signal. - * @location: (type Gio.File): #GFile to which the caller should switch. - * @open_flags: a single value from #GtkPlacesOpenFlags specifying how the @location should be opened. + * @location: (type Gio.File): GFile to which the caller should switch. + * @open_flags: a single value from GtkPlacesOpenFlags specifying how the @location should be opened. * * The places sidebar emits this signal when the user selects a location * in it. The calling application should display the contents of that @@ -4163,10 +4163,10 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * GtkPlacesSidebar::drag-action-requested: * @sidebar: the object which received the signal. - * @drop: (type Gdk.Drop): #GdkDrop with information about the drag operation - * @dest_file: (type Gio.File): #GFile with the tentative location that is being hovered for a drop + * @drop: (type Gdk.Drop): GdkDrop with information about the drag operation + * @dest_file: (type Gio.File): GFile with the tentative location that is being hovered for a drop * @source_file_list: (type GLib.SList) (element-type GFile) (transfer none): - * List of #GFile that are being dragged + * List of GFile that are being dragged * * When the user starts a drag-and-drop operation and the sidebar needs * to ask the application for which drag action to perform, then the @@ -4178,8 +4178,8 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) * * The drag action to use must be the return value of the signal handler. * - * Returns: The drag action to use, for example, #GDK_ACTION_COPY - * or #GDK_ACTION_MOVE, or 0 if no action is allowed here (i.e. drops + * Returns: The drag action to use, for example, GDK_ACTION_COPY + * or GDK_ACTION_MOVE, or 0 if no action is allowed here (i.e. drops * are not allowed in the specified @dest_file). */ places_sidebar_signals [DRAG_ACTION_REQUESTED] = @@ -4217,9 +4217,9 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * GtkPlacesSidebar::drag-perform-drop: * @sidebar: the object which received the signal. - * @dest_file: (type Gio.File): Destination #GFile. + * @dest_file: (type Gio.File): Destination GFile. * @source_file_list: (type GLib.SList) (element-type GFile) (transfer none): - * #GSList of #GFile that got dropped. + * GSList of GFile that got dropped. * @action: Drop action to perform. * * The places sidebar emits this signal when the user completes a @@ -4243,7 +4243,7 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * GtkPlacesSidebar::show-other-locations-with-flags: * @sidebar: the object which received the signal. - * @open_flags: a single value from #GtkPlacesOpenFlags specifying how it should be opened. + * @open_flags: a single value from GtkPlacesOpenFlags specifying how it should be opened. * * The places sidebar emits this signal when it needs the calling * application to present a way to show other locations e.g. drives @@ -4264,11 +4264,11 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * GtkPlacesSidebar::mount: * @sidebar: the object which received the signal. - * @mount_operation: the #GMountOperation that is going to start. + * @mount_operation: the GMountOperation that is going to start. * * The places sidebar emits this signal when it starts a new operation * because the user clicked on some location that needs mounting. - * In this way the application using the #GtkPlacesSidebar can track the + * In this way the application using the GtkPlacesSidebar can track the * progress of the operation and, for example, show a notification. */ places_sidebar_signals [MOUNT] = @@ -4284,11 +4284,11 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * GtkPlacesSidebar::unmount: * @sidebar: the object which received the signal. - * @mount_operation: the #GMountOperation that is going to start. + * @mount_operation: the GMountOperation that is going to start. * * The places sidebar emits this signal when it starts a new operation * because the user for example ejected some drive or unmounted a mount. - * In this way the application using the #GtkPlacesSidebar can track the + * In this way the application using the GtkPlacesSidebar can track the * progress of the operation and, for example, show a notification. */ places_sidebar_signals [UNMOUNT] = @@ -4380,13 +4380,13 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) /* * gtk_places_sidebar_new: * - * Creates a new #GtkPlacesSidebar widget. + * Creates a new GtkPlacesSidebar widget. * * The application should connect to at least the - * #GtkPlacesSidebar::open-location signal to be notified + * GtkPlacesSidebar::open-location signal to be notified * when the user makes a selection in the sidebar. * - * Returns: a newly created #GtkPlacesSidebar + * Returns: a newly created GtkPlacesSidebar */ GtkWidget * gtk_places_sidebar_new (void) @@ -4408,11 +4408,11 @@ gtk_places_sidebar_new (void) * application can open new locations, so that the sidebar can display (or not) * the “Open in new tab” and “Open in new window” menu items as appropriate. * - * When the #GtkPlacesSidebar::open-location signal is emitted, its flags + * When the GtkPlacesSidebar::open-location signal is emitted, its flags * argument will be set to one of the @flags that was passed in * gtk_places_sidebar_set_open_flags(). * - * Passing 0 for @flags will cause #GTK_PLACES_OPEN_NORMAL to always be sent + * Passing 0 for @flags will cause GTK_PLACES_OPEN_NORMAL to always be sent * to callbacks for the “open-location” signal. */ void @@ -4430,11 +4430,11 @@ gtk_places_sidebar_set_open_flags (GtkPlacesSidebar *sidebar, /* * gtk_places_sidebar_get_open_flags: - * @sidebar: a #GtkPlacesSidebar + * @sidebar: a GtkPlacesSidebar * * Gets the open flags. * - * Returns: the #GtkPlacesOpenFlags of @sidebar + * Returns: the GtkPlacesOpenFlags of @sidebar */ GtkPlacesOpenFlags gtk_places_sidebar_get_open_flags (GtkPlacesSidebar *sidebar) @@ -4514,7 +4514,7 @@ gtk_places_sidebar_set_location (GtkPlacesSidebar *sidebar, * * You can use this function to get the selection in the @sidebar. * - * Returns: (nullable) (transfer full): a #GFile with the selected location, or + * Returns: (nullable) (transfer full): a GFile with the selected location, or * %NULL if nothing is visually selected. */ GFile * @@ -4657,7 +4657,7 @@ gtk_places_sidebar_get_show_desktop (GtkPlacesSidebar *sidebar) * entering URLs is an expected user action. * * If you enable this, you should connect to the - * #GtkPlacesSidebar::show-enter-location signal. + * GtkPlacesSidebar::show-enter-location signal. */ void gtk_places_sidebar_set_show_enter_location (GtkPlacesSidebar *sidebar, @@ -4702,7 +4702,7 @@ gtk_places_sidebar_get_show_enter_location (GtkPlacesSidebar *sidebar) * see and interact with drives and network servers directly. * * If you enable this, you should connect to the - * #GtkPlacesSidebar::show-other-locations-with-flags signal. + * GtkPlacesSidebar::show-other-locations-with-flags signal. */ void gtk_places_sidebar_set_show_other_locations (GtkPlacesSidebar *sidebar, @@ -4840,12 +4840,12 @@ gtk_places_sidebar_remove_shortcut (GtkPlacesSidebar *sidebar, * gtk_places_sidebar_list_shortcuts: * @sidebar: a places sidebar * - * Gets the list of shortcuts, as a list model containing #GFile objects. + * Gets the list of shortcuts, as a list model containing GFile objects. * * You should not modify the returned list model. Future changes to * @sidebar may or may not affect the returned model. * - * Returns: (transfer full): a list model of #GFiles that have been added as + * Returns: (transfer full): a list model of GFiles that have been added as * application-specific shortcuts with gtk_places_sidebar_add_shortcut() */ GListModel * @@ -4862,7 +4862,7 @@ gtk_places_sidebar_get_shortcuts (GtkPlacesSidebar *sidebar) * @n: index of the bookmark to query * * This function queries the bookmarks added by the user to the places sidebar, - * and returns one of them. This function is used by #GtkFileChooser to implement + * and returns one of them. This function is used by GtkFileChooser to implement * the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the corresponding bookmark. * * Returns: (nullable) (transfer full): The bookmark specified by the index @n, or @@ -4965,7 +4965,7 @@ gtk_places_sidebar_set_drop_targets_visible (GtkPlacesSidebar *sidebar, * @show_starred_location: whether to show an item for Starred files * * If you enable this, you should connect to the - * #GtkPlacesSidebar::show-starred-location signal. + * GtkPlacesSidebar::show-starred-location signal. */ void gtk_places_sidebar_set_show_starred_location (GtkPlacesSidebar *sidebar, diff --git a/gtk/gtkplacessidebarprivate.h b/gtk/gtkplacessidebarprivate.h index 55003b499d..9fbf22f035 100644 --- a/gtk/gtkplacessidebarprivate.h +++ b/gtk/gtkplacessidebarprivate.h @@ -39,12 +39,12 @@ typedef struct _GtkPlacesSidebarClass GtkPlacesSidebarClass; /* * GtkPlacesOpenFlags: - * @GTK_PLACES_OPEN_NORMAL: This is the default mode that #GtkPlacesSidebar uses if no other flags + * @GTK_PLACES_OPEN_NORMAL: This is the default mode that GtkPlacesSidebar uses if no other flags * are specified. It indicates that the calling application should open the selected location * in the normal way, for example, in the folder view beside the sidebar. * @GTK_PLACES_OPEN_NEW_TAB: When passed to gtk_places_sidebar_set_open_flags(), this indicates * that the application can open folders selected from the sidebar in new tabs. This value - * will be passed to the #GtkPlacesSidebar::open-location signal when the user selects + * will be passed to the GtkPlacesSidebar::open-location signal when the user selects * that a location be opened in a new tab instead of in the standard fashion. * @GTK_PLACES_OPEN_NEW_WINDOW: Similar to @GTK_PLACES_OPEN_NEW_TAB, but indicates that the application * can open folders in new windows. @@ -55,13 +55,13 @@ typedef struct _GtkPlacesSidebarClass GtkPlacesSidebarClass; * addition to the normal mode. * * Second, when one of these values gets passed back to the application in the - * #GtkPlacesSidebar::open-location signal, it means that the application should + * GtkPlacesSidebar::open-location signal, it means that the application should * open the selected location in the normal way, in a new tab, or in a new * window. The sidebar takes care of determining the desired way to open the location, * based on the modifier keys that the user is pressing at the time the selection is made. * * If the application never calls gtk_places_sidebar_set_open_flags(), then the sidebar will only - * use #GTK_PLACES_OPEN_NORMAL in the #GtkPlacesSidebar::open-location signal. This is the + * use GTK_PLACES_OPEN_NORMAL in the GtkPlacesSidebar::open-location signal. This is the * default mode of operation. */ typedef enum { diff --git a/gtk/gtkplacesview.c b/gtk/gtkplacesview.c index 9a57a18492..cb13276513 100644 --- a/gtk/gtkplacesview.c +++ b/gtk/gtkplacesview.c @@ -35,8 +35,8 @@ /*< private > * GtkPlacesView: * - * #GtkPlacesView is a widget that displays a list of persistent drives - * such as harddisk partitions and networks. #GtkPlacesView does not monitor + * GtkPlacesView is a widget that displays a list of persistent drives + * such as harddisk partitions and networks. GtkPlacesView does not monitor * removable devices. * * The places view displays drives and networks, and will automatically mount @@ -45,7 +45,7 @@ * shown at the network list. * * To make use of the places view, an application at least needs to connect - * to the #GtkPlacesView::open-location signal. This is emitted when the user + * to the GtkPlacesView::open-location signal. This is emitted when the user * selects a location to open in the view. */ @@ -2198,8 +2198,8 @@ gtk_places_view_class_init (GtkPlacesViewClass *klass) /* * GtkPlacesView::open-location: * @view: the object which received the signal. - * @location: (type Gio.File): #GFile to which the caller should switch. - * @open_flags: a single value from #GtkPlacesOpenFlags specifying how the @location + * @location: (type Gio.File): GFile to which the caller should switch. + * @open_flags: a single value from GtkPlacesOpenFlags specifying how the @location * should be opened. * * The places view emits this signal when the user selects a location @@ -2377,13 +2377,13 @@ gtk_places_view_init (GtkPlacesView *self) /* * gtk_places_view_new: * - * Creates a new #GtkPlacesView widget. + * Creates a new GtkPlacesView widget. * * The application should connect to at least the - * #GtkPlacesView::open-location signal to be notified + * GtkPlacesView::open-location signal to be notified * when the user makes a selection in the view. * - * Returns: a newly created #GtkPlacesView + * Returns: a newly created GtkPlacesView */ GtkWidget * gtk_places_view_new (void) @@ -2393,7 +2393,7 @@ gtk_places_view_new (void) /* * gtk_places_view_set_open_flags: - * @view: a #GtkPlacesView + * @view: a GtkPlacesView * @flags: Bitmask of modes in which the calling application can open locations * * Sets the way in which the calling application can open new locations from @@ -2405,11 +2405,11 @@ gtk_places_view_new (void) * application can open new locations, so that the view can display (or not) * the “Open in new tab” and “Open in new window” menu items as appropriate. * - * When the #GtkPlacesView::open-location signal is emitted, its flags + * When the GtkPlacesView::open-location signal is emitted, its flags * argument will be set to one of the @flags that was passed in * gtk_places_view_set_open_flags(). * - * Passing 0 for @flags will cause #GTK_PLACES_OPEN_NORMAL to always be sent + * Passing 0 for @flags will cause GTK_PLACES_OPEN_NORMAL to always be sent * to callbacks for the “open-location” signal. */ void @@ -2433,11 +2433,11 @@ gtk_places_view_set_open_flags (GtkPlacesView *view, /* * gtk_places_view_get_open_flags: - * @view: a #GtkPlacesSidebar + * @view: a GtkPlacesSidebar * * Gets the open flags. * - * Returns: the #GtkPlacesOpenFlags of @view + * Returns: the GtkPlacesOpenFlags of @view */ GtkPlacesOpenFlags gtk_places_view_get_open_flags (GtkPlacesView *view) @@ -2449,7 +2449,7 @@ gtk_places_view_get_open_flags (GtkPlacesView *view) /* * gtk_places_view_get_search_query: - * @view: a #GtkPlacesView + * @view: a GtkPlacesView * * Retrieves the current search query from @view. * @@ -2465,7 +2465,7 @@ gtk_places_view_get_search_query (GtkPlacesView *view) /* * gtk_places_view_set_search_query: - * @view: a #GtkPlacesView + * @view: a GtkPlacesView * @query_text: the query, or NULL. * * Sets the search query of @view. The search is immediately performed @@ -2491,7 +2491,7 @@ gtk_places_view_set_search_query (GtkPlacesView *view, /* * gtk_places_view_get_loading: - * @view: a #GtkPlacesView + * @view: a GtkPlacesView * * Returns %TRUE if the view is loading locations. */ diff --git a/gtk/gtkpopovermenu.c b/gtk/gtkpopovermenu.c index 8018d861c7..3d183f07b2 100644 --- a/gtk/gtkpopovermenu.c +++ b/gtk/gtkpopovermenu.c @@ -90,7 +90,7 @@ * content. `<attribute>` elements can be marked for translation with a * `translatable="yes"` attribute. It is also possible to specify message * context and translator comments, using the context and comments attributes. - * To make use of this, the #GtkBuilder must have been given the gettext + * To make use of this, the `GtkBuilder` must have been given the gettext * domain to use. * * The following attributes are used when constructing menu items: @@ -655,16 +655,16 @@ gtk_popover_menu_new (void) /*<private> * gtk_popover_menu_open_submenu: - * @popover: a #GtkPopoverMenu + * @popover: a `GtkPopoverMenu` * @name: the name of the menu to switch to * * Opens a submenu of the @popover. The @name * must be one of the names given to the submenus - * of @popover with #GtkPopoverMenu:submenu, or + * of @popover with `GtkPopoverMenu:submenu`, or * "main" to switch back to the main menu. * - * #GtkModelButton will open submenus automatically - * when the #GtkModelButton:menu-name property is set, + * `GtkModelButton` will open submenus automatically + * when the `GtkModelButton:menu-name` property is set, * so this function is only needed when you are using * other kinds of widgets to initiate menu changes. */ diff --git a/gtk/gtkpopovermenubar.c b/gtk/gtkpopovermenubar.c index 193e77baa6..fe91374a6d 100644 --- a/gtk/gtkpopovermenubar.c +++ b/gtk/gtkpopovermenubar.c @@ -805,7 +805,7 @@ gtk_popover_menu_bar_add_child (GtkPopoverMenuBar *bar, /** * gtk_popover_menu_bar_remove_child: * @bar: a `GtkPopoverMenuBar` - * @child: the #GtkWidget to remove + * @child: the `GtkWidget` to remove * * Removes a widget that has previously been added with * gtk_popover_menu_bar_add_child(). diff --git a/gtk/gtkprintbackend.c b/gtk/gtkprintbackend.c index 63894df2d2..9e84ba3088 100644 --- a/gtk/gtkprintbackend.c +++ b/gtk/gtkprintbackend.c @@ -455,8 +455,7 @@ gtk_print_backend_set_list_done (GtkPrintBackend *backend) * Returns the current list of printers. * * Returns: (element-type GtkPrinter) (transfer container): - * A list of #GtkPrinter objects. The list should be freed - * with g_list_free(). + * A list of `GtkPrinter` objects */ GList * gtk_print_backend_get_printer_list (GtkPrintBackend *backend) diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c index 28bcb8043b..1507637157 100644 --- a/gtk/gtkprinter.c +++ b/gtk/gtkprinter.c @@ -262,7 +262,7 @@ gtk_printer_class_init (GtkPrinterClass *class) /** * GtkPrinter::details-acquired: - * @printer: the #GtkPrinter on which the signal is emitted + * @printer: the `GtkPrinter` on which the signal is emitted * @success: %TRUE if the details were successfully acquired * * Emitted in response to a request for detailed information @@ -484,7 +484,7 @@ gtk_printer_get_name (GtkPrinter *printer) /** * gtk_printer_get_description: - * @printer: a #GtkPrinter + * @printer: a `GtkPrinter` * * Gets the description of the printer. * diff --git a/gtk/gtkprinter.h b/gtk/gtkprinter.h index 9243c5c11b..bd63d8008d 100644 --- a/gtk/gtkprinter.h +++ b/gtk/gtkprinter.h @@ -142,7 +142,7 @@ gboolean gtk_printer_get_hard_margins_for_paper_size (GtkPrinter /** * GtkPrinterFunc: - * @printer: a #GtkPrinter + * @printer: a `GtkPrinter` * @data: (closure): user data passed to gtk_enumerate_printers() * * The type of function passed to gtk_enumerate_printers(). diff --git a/gtk/gtkprinteroptionset.c b/gtk/gtkprinteroptionset.c index 8fe831bf56..54fcc46bbe 100644 --- a/gtk/gtkprinteroptionset.c +++ b/gtk/gtkprinteroptionset.c @@ -144,7 +144,7 @@ gtk_printer_option_set_clear_conflicts (GtkPrinterOptionSet *set) /** * gtk_printer_option_set_get_groups: - * @set: a #GtkPrinterOptionSet + * @set: a `GtkPrinterOptionSet` * * Gets the groups in this set. * diff --git a/gtk/gtkprintjob.c b/gtk/gtkprintjob.c index f71156d9de..945a43a0d9 100644 --- a/gtk/gtkprintjob.c +++ b/gtk/gtkprintjob.c @@ -210,7 +210,7 @@ gtk_print_job_class_init (GtkPrintJobClass *class) /** * GtkPrintJob::status-changed: - * @job: the #GtkPrintJob object on which the signal was emitted + * @job: the `GtkPrintJob` object on which the signal was emitted * * Emitted when the status of a job changes. * diff --git a/gtk/gtkprintjob.h b/gtk/gtkprintjob.h index 47b14c7149..ea9be52ac2 100644 --- a/gtk/gtkprintjob.h +++ b/gtk/gtkprintjob.h @@ -37,9 +37,9 @@ typedef struct _GtkPrintJob GtkPrintJob; /** * GtkPrintJobCompleteFunc: - * @print_job: the #GtkPrintJob + * @print_job: the `GtkPrintJob` * @user_data: user data that has been passed to gtk_print_job_send() - * @error: a #GError that contains error information if the sending + * @error: a `GError` that contains error information if the sending * of the print job failed, otherwise %NULL * * The type of callback that is passed to gtk_print_job_send(). diff --git a/gtk/gtkprintoperation-unix.c b/gtk/gtkprintoperation-unix.c index 32411ed22b..644100898b 100644 --- a/gtk/gtkprintoperation-unix.c +++ b/gtk/gtkprintoperation-unix.c @@ -962,11 +962,11 @@ get_page_setup_dialog (GtkWindow *parent, /** * gtk_print_run_page_setup_dialog: * @parent: (nullable): transient parent - * @page_setup: (nullable): an existing #GtkPageSetup - * @settings: a #GtkPrintSettings + * @page_setup: (nullable): an existing `GtkPageSetup` + * @settings: a `GtkPrintSettings` * * Runs a page setup dialog, letting the user modify the values from - * @page_setup. If the user cancels the dialog, the returned #GtkPageSetup + * @page_setup. If the user cancels the dialog, the returned `GtkPageSetup` * is identical to the passed in @page_setup, otherwise it contains the * modifications done in the dialog. * @@ -974,7 +974,7 @@ get_page_setup_dialog (GtkWindow *parent, * setup dialog. See gtk_print_run_page_setup_dialog_async() if this is * a problem. * - * Returns: (transfer full): a new #GtkPageSetup + * Returns: (transfer full): a new `GtkPageSetup` */ GtkPageSetup * gtk_print_run_page_setup_dialog (GtkWindow *parent, @@ -1013,16 +1013,16 @@ gtk_print_run_page_setup_dialog (GtkWindow *parent, /** * gtk_print_run_page_setup_dialog_async: * @parent: (nullable): transient parent - * @page_setup: (nullable): an existing #GtkPageSetup - * @settings: a #GtkPrintSettings + * @page_setup: (nullable): an existing `GtkPageSetup` + * @settings: a `GtkPrintSettings` * @done_cb: (scope async): a function to call when the user saves * the modified page setup * @data: user data to pass to @done_cb - * - * Runs a page setup dialog, letting the user modify the values from @page_setup. * - * In contrast to gtk_print_run_page_setup_dialog(), this function returns after - * showing the page setup dialog on platforms that support this, and calls @done_cb + * Runs a page setup dialog, letting the user modify the values from @page_setup. + * + * In contrast to gtk_print_run_page_setup_dialog(), this function returns after + * showing the page setup dialog on platforms that support this, and calls @done_cb * from a signal handler for the ::response signal of the dialog. */ void diff --git a/gtk/gtkprintoperation.h b/gtk/gtkprintoperation.h index fc6f6e5a56..360c0859b6 100644 --- a/gtk/gtkprintoperation.h +++ b/gtk/gtkprintoperation.h @@ -195,7 +195,7 @@ struct _GtkPrintOperationClass /** * GTK_PRINT_ERROR: * - * The error domain for #GtkPrintError errors. + * The error domain for `GtkPrintError` errors. */ #define GTK_PRINT_ERROR gtk_print_error_quark () @@ -310,7 +310,7 @@ GtkPageSetup *gtk_print_run_page_setup_dialog (GtkWindow /** * GtkPageSetupDoneFunc: - * @page_setup: the #GtkPageSetup that has been passed to + * @page_setup: the `GtkPageSetup` that has been passed to * gtk_print_run_page_setup_dialog_async() * @data: (closure): user data that has been passed to * gtk_print_run_page_setup_dialog_async() diff --git a/gtk/gtkprintoperationpreview.c b/gtk/gtkprintoperationpreview.c index 20c8acf527..3c2d9b36df 100644 --- a/gtk/gtkprintoperationpreview.c +++ b/gtk/gtkprintoperationpreview.c @@ -76,7 +76,7 @@ gtk_print_operation_preview_base_init (gpointer g_iface) /** * GtkPrintOperationPreview::ready: * @preview: the object on which the signal is emitted - * @context: the current #GtkPrintContext + * @context: the current `GtkPrintContext` * * The ::ready signal gets emitted once per preview operation, * before the first page is rendered. diff --git a/gtk/gtkprintsettings.c b/gtk/gtkprintsettings.c index dbc8a099e8..ad6371b47f 100644 --- a/gtk/gtkprintsettings.c +++ b/gtk/gtkprintsettings.c @@ -834,7 +834,7 @@ gtk_print_settings_get_duplex (GtkPrintSettings *settings) /** * gtk_print_settings_set_duplex: * @settings: a `GtkPrintSettings` - * @duplex: a #GtkPrintDuplex value + * @duplex: a `GtkPrintDuplex` value * * Sets the value of %GTK_PRINT_SETTINGS_DUPLEX. */ @@ -894,7 +894,7 @@ gtk_print_settings_get_quality (GtkPrintSettings *settings) /** * gtk_print_settings_set_quality: * @settings: a `GtkPrintSettings` - * @quality: a #GtkPrintQuality value + * @quality: a `GtkPrintQuality` value * * Sets the value of %GTK_PRINT_SETTINGS_QUALITY. */ @@ -954,7 +954,7 @@ gtk_print_settings_get_page_set (GtkPrintSettings *settings) /** * gtk_print_settings_set_page_set: * @settings: a `GtkPrintSettings` - * @page_set: a #GtkPageSet value + * @page_set: a `GtkPageSet` value * * Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET. */ @@ -1023,7 +1023,7 @@ gtk_print_settings_get_number_up_layout (GtkPrintSettings *settings) /** * gtk_print_settings_set_number_up_layout: * @settings: a `GtkPrintSettings` - * @number_up_layout: a #GtkNumberUpLayout value + * @number_up_layout: a `GtkNumberUpLayout` value * * Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. */ @@ -1281,7 +1281,7 @@ gtk_print_settings_get_print_pages (GtkPrintSettings *settings) /** * gtk_print_settings_set_print_pages: * @settings: a `GtkPrintSettings` - * @pages: a #GtkPrintPages value + * @pages: a `GtkPrintPages` value * * Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. */ diff --git a/gtk/gtkprivate.c b/gtk/gtkprivate.c index ef19feb43a..ce7077e7c2 100644 --- a/gtk/gtkprivate.c +++ b/gtk/gtkprivate.c @@ -175,7 +175,7 @@ _gtk_ensure_resources (void) /* * gtk_get_portal_interface_version: - * @connection: a session #GDBusConnection + * @connection: a session `GDBusConnection` * @interface_name: the interface name for the portal interface * we're interested in. * diff --git a/gtk/gtkprogressbar.c b/gtk/gtkprogressbar.c index 2af936066a..d49c7f4868 100644 --- a/gtk/gtkprogressbar.c +++ b/gtk/gtkprogressbar.c @@ -85,7 +85,7 @@ * * # Accessibility * - * `GtkProgressBar` uses the #GTK_ACCESSIBLE_ROLE_PROGRESS_BAR role. + * `GtkProgressBar` uses the %GTK_ACCESSIBLE_ROLE_PROGRESS_BAR role. */ typedef struct _GtkProgressBarClass GtkProgressBarClass; diff --git a/gtk/gtkpropertylookuplistmodel.c b/gtk/gtkpropertylookuplistmodel.c index b019a7b6b4..caccf6653c 100644 --- a/gtk/gtkpropertylookuplistmodel.c +++ b/gtk/gtkpropertylookuplistmodel.c @@ -21,7 +21,7 @@ /* * GtkPropertyLookupListModel: * - * #GtkPropertyLookupListModel is a #GListModel implementation that takes an + * `GtkPropertyLookupListModel` is a `GListModel` implementation that takes an * object and a property and then recursively looks up the next element using * the property on the previous object. * @@ -366,7 +366,7 @@ gtk_property_lookup_list_model_class_init (GtkPropertyLookupListModelClass *klas /** * GtkPropertyLookupListModel:item-type: * - * The #GType for elements of this object + * The `GType` for elements of this object */ properties[PROP_ITEM_TYPE] = g_param_spec_gtype ("item-type", diff --git a/gtk/gtkrecentmanager.c b/gtk/gtkrecentmanager.c index 00cb6c7af9..639e2d23e7 100644 --- a/gtk/gtkrecentmanager.c +++ b/gtk/gtkrecentmanager.c @@ -995,7 +995,7 @@ gtk_recent_manager_add_full (GtkRecentManager *manager, * gtk_recent_manager_remove_item: * @manager: a `GtkRecentManager` * @uri: the URI of the item you wish to remove - * @error: (nullable): return location for a #GError + * @error: (nullable): return location for a `GError` * * Removes a resource pointed by @uri from the recently used resources * list handled by a recent manager. @@ -1144,7 +1144,7 @@ build_recent_info (GBookmarkFile *bookmarks, * gtk_recent_manager_lookup_item: * @manager: a `GtkRecentManager` * @uri: a URI - * @error: (nullable): a return location for a #GError + * @error: (nullable): a return location for a `GError` * * Searches for a URI inside the recently used resources list, and * returns a `GtkRecentInfo` containing information about the resource @@ -1207,7 +1207,7 @@ gtk_recent_manager_lookup_item (GtkRecentManager *manager, * @uri: the URI of a recently used resource * @new_uri: (nullable): the new URI of the recently used resource, or * %NULL to remove the item pointed by @uri in the list - * @error: (nullable): a return location for a #GError, or %NULL + * @error: (nullable): a return location for a `GError` * * Changes the location of a recently used resource from @uri to @new_uri. * @@ -1332,7 +1332,7 @@ purge_recent_items_list (GtkRecentManager *manager, /** * gtk_recent_manager_purge_items: * @manager: a `GtkRecentManager` - * @error: (nullable): a return location for a #GError, or %NULL + * @error: (nullable): a return location for a `GError` * * Purges every item from the recently used resources list. * @@ -1652,7 +1652,7 @@ gtk_recent_info_get_mime_type (GtkRecentInfo *info) * Gets the the time when the resource * was added to the recently used resources list. * - * Returns: (transfer none): a #GDateTime for the time + * Returns: (transfer none): a `GDateTime` for the time * when the resource was added */ GDateTime * @@ -1670,8 +1670,8 @@ gtk_recent_info_get_added (GtkRecentInfo *info) * Gets the time when the meta-data * for the resource was last modified. * - * Returns: (transfer none): a #GDateTime for the time - * when the resource was last modified + * Returns: (transfer none): a `GDateTime` for the time + * when the resource was last modified */ GDateTime * gtk_recent_info_get_modified (GtkRecentInfo *info) @@ -1688,7 +1688,7 @@ gtk_recent_info_get_modified (GtkRecentInfo *info) * Gets the time when the meta-data * for the resource was last visited. * - * Returns: (transfer none): a #GDateTime for the time + * Returns: (transfer none): a `GDateTime` for the time * when the resource was last visited */ GDateTime * @@ -1879,8 +1879,7 @@ gtk_recent_info_last_application (GtkRecentInfo *info) * * Retrieves the icon associated to the resource MIME type. * - * Returns: (nullable) (transfer full): a #GIcon containing the icon, or %NULL. - * Use g_object_unref() when finished using the icon + * Returns: (nullable) (transfer full): a `GIcon` containing the icon */ GIcon * gtk_recent_info_get_gicon (GtkRecentInfo *info) @@ -2279,13 +2278,14 @@ gtk_recent_info_has_group (GtkRecentInfo *info, * @app_name: (nullable): the name of the application that should * be mapped to a `GAppInfo`; if %NULL is used then the default * application for the MIME type is used - * @error: (nullable): return location for a #GError, or %NULL + * @error: (nullable): return location for a `GError` * * Creates a `GAppInfo` for the specified `GtkRecentInfo` * - * Returns: (nullable) (transfer full): the newly created `GAppInfo`, - * or %NULL. In case of error, @error will be set either with a - * %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR + * In case of error, @error will be set either with a + * %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR + * + * Returns: (nullable) (transfer full): the newly created `GAppInfo` */ GAppInfo * gtk_recent_info_create_app_info (GtkRecentInfo *info, diff --git a/gtk/gtkrecentmanager.h b/gtk/gtkrecentmanager.h index 1f4c378ec3..2779c75c92 100644 --- a/gtk/gtkrecentmanager.h +++ b/gtk/gtkrecentmanager.h @@ -92,7 +92,7 @@ struct _GtkRecentManager /** * GtkRecentManagerClass: * - * #GtkRecentManagerClass contains only private data. + * `GtkRecentManagerClass` contains only private data. */ struct _GtkRecentManagerClass { @@ -123,7 +123,7 @@ struct _GtkRecentManagerClass * resources file. * @GTK_RECENT_MANAGER_ERROR_UNKNOWN: unspecified error. * - * Error codes for #GtkRecentManager operations + * Error codes for `GtkRecentManager` operations */ typedef enum { @@ -139,7 +139,7 @@ typedef enum /** * GTK_RECENT_MANAGER_ERROR: * - * The #GError domain for #GtkRecentManager errors. + * The `GError` domain for `GtkRecentManager` errors. */ #define GTK_RECENT_MANAGER_ERROR (gtk_recent_manager_error_quark ()) GDK_AVAILABLE_IN_ALL diff --git a/gtk/gtkrender.c b/gtk/gtkrender.c index 1a18290353..414b940517 100644 --- a/gtk/gtkrender.c +++ b/gtk/gtkrender.c @@ -60,14 +60,14 @@ gtk_do_render_icon (GtkStyleContext *context, /** * gtk_render_check: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width * @height: rectangle height * - * Renders a checkmark (as in a #GtkCheckButton). + * Renders a checkmark (as in a `GtkCheckButton`). * * The %GTK_STATE_FLAG_CHECKED state determines whether the check is * on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it @@ -96,8 +96,8 @@ gtk_render_check (GtkStyleContext *context, /** * gtk_render_option: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width @@ -130,8 +130,8 @@ gtk_render_option (GtkStyleContext *context, /** * gtk_render_arrow: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @angle: arrow angle from 0 to 2 * %G_PI, being 0 the arrow pointing to the north * @x: X origin of the render area * @y: Y origin of the render area @@ -162,8 +162,8 @@ gtk_render_arrow (GtkStyleContext *context, /** * gtk_render_background: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width @@ -208,8 +208,8 @@ gtk_render_background (GtkStyleContext *context, /** * gtk_render_frame: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width @@ -254,14 +254,14 @@ gtk_render_frame (GtkStyleContext *context, /** * gtk_render_expander: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width * @height: rectangle height * - * Renders an expander (as used in #GtkTreeView and #GtkExpander) in the area + * Renders an expander (as used in `GtkTreeView` and `GtkExpander`) in the area * defined by @x, @y, @width, @height. The state %GTK_STATE_FLAG_CHECKED * determines whether the expander is collapsed or expanded. * @@ -288,8 +288,8 @@ gtk_render_expander (GtkStyleContext *context, /** * gtk_render_focus: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width @@ -333,11 +333,11 @@ gtk_render_focus (GtkStyleContext *context, /** * gtk_render_layout: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin * @y: Y origin - * @layout: the #PangoLayout to render + * @layout: the `PangoLayout` to render * * Renders @layout on the coordinates @x, @y **/ @@ -370,8 +370,8 @@ gtk_render_layout (GtkStyleContext *context, /** * gtk_render_line: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x0: X coordinate for the origin of the line * @y0: Y coordinate for the origin of the line * @x1: X coordinate for the end of the line @@ -410,16 +410,15 @@ gtk_render_line (GtkStyleContext *context, /** * gtk_render_handle: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width * @height: rectangle height * - * Renders a handle (as in #GtkPaned and - * #GtkWindow’s resize grip), in the rectangle - * determined by @x, @y, @width, @height. + * Renders a handle (as in `GtkPaned` and `GtkWindow`’s resize grip), + * in the rectangle determined by @x, @y, @width, @height. * * Handles rendered for the paned and grip classes: * @@ -447,14 +446,14 @@ gtk_render_handle (GtkStyleContext *context, /** * gtk_render_activity: - * @context: a #GtkStyleContext - * @cr: a #cairo_t + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` * @x: X origin of the rectangle * @y: Y origin of the rectangle * @width: rectangle width * @height: rectangle height * - * Renders an activity indicator (such as in #GtkSpinner). + * Renders an activity indicator (such as in `GtkSpinner`). * The state %GTK_STATE_FLAG_CHECKED determines whether there is * activity going on. **/ @@ -477,11 +476,11 @@ gtk_render_activity (GtkStyleContext *context, /** * gtk_render_icon: - * @context: a #GtkStyleContext - * @cr: a #cairo_t - * @texture: a #GdkTexture containing the icon to draw + * @context: a `GtkStyleContext` + * @cr: a `cairo_t` + * @texture: a `GdkTexture` containing the icon to draw * @x: X position for the @texture - * @y: Y position for the @texture + * @y: Y position for the @texture * * Renders the icon in @texture at the specified @x and @y coordinates. * diff --git a/gtk/gtkrootprivate.h b/gtk/gtkrootprivate.h index d4c3174ae0..b7aa076880 100644 --- a/gtk/gtkrootprivate.h +++ b/gtk/gtkrootprivate.h @@ -10,7 +10,7 @@ G_BEGIN_DECLS /** * GtkRootIface: * - * The list of functions that must be implemented for the #GtkRoot interface. + * The list of functions that must be implemented for the `GtkRoot` interface. */ struct _GtkRootInterface { diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c index a44c863a73..d9620e9461 100644 --- a/gtk/gtkscale.c +++ b/gtk/gtkscale.c @@ -964,7 +964,7 @@ gtk_scale_new (GtkOrientation orientation, * @step is a power of ten. If the resulting precision is not suitable * for your needs, use [method@Gtk.Scale.set_digits] to correct it. * - * Returns: a new #GtkScale + * Returns: a new `GtkScale` */ GtkWidget * gtk_scale_new_with_range (GtkOrientation orientation, @@ -1095,7 +1095,7 @@ update_value_position (GtkScale *scale) /** * gtk_scale_set_draw_value: (attributes org.gtk.Method.set_property=draw-value) - * @scale: a #GtkScale + * @scale: a `GtkScale` * @draw_value: %TRUE to draw the value * * Specifies whether the current value is displayed as a string next @@ -1595,7 +1595,7 @@ gtk_scale_get_layout (GtkScale *scale) /** * gtk_scale_get_layout_offsets: - * @scale: a #GtkScale + * @scale: a `GtkScale` * @x: (out) (optional): location to store X offset of layout * @y: (out) (optional): location to store Y offset of layout * @@ -1674,9 +1674,9 @@ gtk_scale_clear_marks (GtkScale *scale) * @scale: a `GtkScale` * @value: the value at which the mark is placed, must be between * the lower and upper limits of the scales’ adjustment - * @position: where to draw the mark. For a horizontal scale, #GTK_POS_TOP + * @position: where to draw the mark. For a horizontal scale, %GTK_POS_TOP * and %GTK_POS_LEFT are drawn above the scale, anything else below. - * For a vertical scale, #GTK_POS_LEFT and %GTK_POS_TOP are drawn to + * For a vertical scale, %GTK_POS_LEFT and %GTK_POS_TOP are drawn to * the left of the scale, anything else to the right. * @markup: (nullable): Text to be shown at the mark, using Pango markup * diff --git a/gtk/gtkscale.h b/gtk/gtkscale.h index 3b650e0271..d7d11f8d01 100644 --- a/gtk/gtkscale.h +++ b/gtk/gtkscale.h @@ -67,7 +67,7 @@ struct _GtkScaleClass /** * GtkScaleFormatValueFunc: - * @scale: The #GtkScale + * @scale: The `GtkScale` * @value: The numeric value to format * @user_data: (closure): user data * diff --git a/gtk/gtkscalebutton.c b/gtk/gtkscalebutton.c index 0bcb97f459..2012cf49d2 100644 --- a/gtk/gtkscalebutton.c +++ b/gtk/gtkscalebutton.c @@ -231,7 +231,7 @@ gtk_scale_button_class_init (GtkScaleButtonClass *klass) * 50% of the scale, and the second one for the top 50%. * * It is recommended to use at least 3 icons so that the - * #GtkScaleButton reflects the current value of the scale + * `GtkScaleButton` reflects the current value of the scale * better for the users. */ g_object_class_install_property (gobject_class, diff --git a/gtk/gtksearchentry.c b/gtk/gtksearchentry.c index 255bd018e5..dd7ca5b170 100644 --- a/gtk/gtksearchentry.c +++ b/gtk/gtksearchentry.c @@ -677,7 +677,7 @@ capture_widget_key_handled (GtkEventControllerKey *controller, /** * gtk_search_entry_set_key_capture_widget: * @entry: a `GtkSearchEntry` - * @widget: (nullable) (transfer none): a #GtkWidget + * @widget: (nullable) (transfer none): a `GtkWidget` * * Sets @widget as the widget that @entry will capture key * events from. diff --git a/gtk/gtkselectionmodel.h b/gtk/gtkselectionmodel.h index 936a7d141d..a956d32a08 100644 --- a/gtk/gtkselectionmodel.h +++ b/gtk/gtkselectionmodel.h @@ -38,7 +38,7 @@ G_DECLARE_INTERFACE (GtkSelectionModel, gtk_selection_model, GTK, SELECTION_MODE * @is_selected: Return if the item at the given position is selected. * @get_selection_in_range: Return a bitset with all currently selected * items in the given range. By default, this function will call - * #GtkSelectionModel::is_selected() on all items in the given range. + * `GtkSelectionModel::is_selected()` on all items in the given range. * @select_item: Select the item in the given position. If the operation * is known to fail, return %FALSE. * @unselect_item: Unselect the item in the given position. If the @@ -56,8 +56,8 @@ G_DECLARE_INTERFACE (GtkSelectionModel, gtk_selection_model, GTK, SELECTION_MODE * See gtk_selection_model_set_selection() for a detailed explanation * of this function. * - * The list of virtual functions for the #GtkSelectionModel interface. - * No function must be implemented, but unless #GtkSelectionModel::is_selected() + * The list of virtual functions for the `GtkSelectionModel` interface. + * No function must be implemented, but unless `GtkSelectionModel::is_selected()` * is implemented, it will not be possible to select items in the set. * * The model does not need to implement any functions to support either @@ -65,7 +65,7 @@ G_DECLARE_INTERFACE (GtkSelectionModel, gtk_selection_model, GTK, SELECTION_MODE * it means that users cannot select or unselect items in a list widget * using the model. * - * All selection functions fall back to #GtkSelectionModel::set_selection() + * All selection functions fall back to `GtkSelectionModel::set_selection()` * so it is sufficient to implement just that function for full selection * support. */ diff --git a/gtk/gtkseparator.c b/gtk/gtkseparator.c index 53f831dde6..5eb8dc35b7 100644 --- a/gtk/gtkseparator.c +++ b/gtk/gtkseparator.c @@ -50,7 +50,7 @@ * * # Accessibility * - * `GtkSeparator` uses the #GTK_ACCESSIBLE_ROLE_SEPARATOR role. + * `GtkSeparator` uses the %GTK_ACCESSIBLE_ROLE_SEPARATOR role. */ typedef struct _GtkSeparatorClass GtkSeparatorClass; diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c index 186bebf6aa..95da9e1be3 100644 --- a/gtk/gtksettings.c +++ b/gtk/gtksettings.c @@ -834,7 +834,7 @@ gtk_settings_class_init (GtkSettingsClass *class) * GtkSettings:gtk-primary-button-warps-slider: * * If the value of this setting is %TRUE, clicking the primary button in a - * #GtkRange trough will move the slider, and hence set the range’s value, to + * `GtkRange` trough will move the slider, and hence set the range’s value, to * the point that you clicked. * * If it is %FALSE, a primary click will cause the slider/value to move diff --git a/gtk/gtkshortcut.c b/gtk/gtkshortcut.c index c2bbabf80f..37620b6fb4 100644 --- a/gtk/gtkshortcut.c +++ b/gtk/gtkshortcut.c @@ -38,7 +38,7 @@ * The actual work is usually done via [class@Gtk.ShortcutController], * which decides if and when to activate a shortcut. Using that controller * directly however is rarely necessary as various higher level - * convenience APIs exist on #GtkWidgets that make it easier to use + * convenience APIs exist on `GtkWidget`s that make it easier to use * shortcuts in GTK. * * `GtkShortcut` does provide functionality to make it easy for users diff --git a/gtk/gtkshortcutcontroller.c b/gtk/gtkshortcutcontroller.c index 8db04d71e6..a2a71c4f71 100644 --- a/gtk/gtkshortcutcontroller.c +++ b/gtk/gtkshortcutcontroller.c @@ -865,7 +865,7 @@ gtk_shortcut_controller_get_scope (GtkShortcutController *self) * The mnemonics modifiers determines which modifiers need to be pressed to allow * activation of shortcuts with mnemonics triggers. * - * GTK normally uses the Alt modifier for mnemonics, except in #GtkPopoverMenus, + * GTK normally uses the Alt modifier for mnemonics, except in `GtkPopoverMenu`s, * where mnemonics can be triggered without any modifiers. It should be very * rarely necessary to change this, and doing so is likely to interfere with * other shortcuts. diff --git a/gtk/gtkshortcutmanager.h b/gtk/gtkshortcutmanager.h index 79dc6e583c..50359a51f1 100644 --- a/gtk/gtkshortcutmanager.h +++ b/gtk/gtkshortcutmanager.h @@ -36,14 +36,15 @@ G_DECLARE_INTERFACE (GtkShortcutManager, gtk_shortcut_manager, GTK, SHORTCUT_MAN /** * GtkShortcutManagerInterface: - * @add_controller: Add a #GtkShortcutController to be managed. - * @remove_controller: Remove a #GtkShortcutController that had previously + * @add_controller: Add a `GtkShortcutController` to be managed. + * @remove_controller: Remove a `GtkShortcutController` that had previously * been added * - * The list of functions that can be implemented for the #GtkShortcutManager interface. + * The list of functions that can be implemented for the `GtkShortcutManager` + * interface. * - * Note that no function is mandatory to implement, the default implementation will work - * fine. + * Note that no function is mandatory to implement, the default implementation + * will work fine. */ struct _GtkShortcutManagerInterface { diff --git a/gtk/gtkshortcuttrigger.c b/gtk/gtkshortcuttrigger.c index 0d0064897c..bd4cfce061 100644 --- a/gtk/gtkshortcuttrigger.c +++ b/gtk/gtkshortcuttrigger.c @@ -317,8 +317,8 @@ gtk_shortcut_trigger_print_label (GtkShortcutTrigger *self, * architectures or even different versions of GTK. Do not use this * function as a basis for building protocols or file formats. * - * The types of @trigger is #gconstpointer only to allow use of this - * function with #GHashTable. They must each be a `GtkShortcutTrigger`. + * The types of @trigger is `gconstpointer` only to allow use of this + * function with `GHashTable`. They must each be a `GtkShortcutTrigger`. * * Returns: a hash value corresponding to @trigger */ @@ -339,8 +339,8 @@ gtk_shortcut_trigger_hash (gconstpointer trigger) * * Checks if @trigger1 and @trigger2 trigger under the same conditions. * - * The types of @one and @two are #gconstpointer only to allow use of this - * function with #GHashTable. They must each be a `GtkShortcutTrigger`. + * The types of @one and @two are `gconstpointer` only to allow use of this + * function with `GHashTable`. They must each be a `GtkShortcutTrigger`. * * Returns: %TRUE if @trigger1 and @trigger2 are equal */ @@ -356,8 +356,8 @@ gtk_shortcut_trigger_equal (gconstpointer trigger1, * @trigger1: (type GtkShortcutTrigger): a `GtkShortcutTrigger` * @trigger2: (type GtkShortcutTrigger): a `GtkShortcutTrigger` * - * The types of @trigger1 and @trigger2 are #gconstpointer only to allow - * use of this function as a #GCompareFunc. + * The types of @trigger1 and @trigger2 are `gconstpointer` only to allow + * use of this function as a `GCompareFunc`. * * They must each be a `GtkShortcutTrigger`. * diff --git a/gtk/gtkshow.c b/gtk/gtkshow.c index 9577901118..d1a0906989 100644 --- a/gtk/gtkshow.c +++ b/gtk/gtkshow.c @@ -84,7 +84,7 @@ window_handle_exported (GtkWindow *window, * @parent: (nullable): parent window * @uri: the uri to show * @timestamp: timestamp from the event that triggered this call, or %GDK_CURRENT_TIME - * @cancellable: (nullable): a #GCancellable to cancel the launch + * @cancellable: (nullable): a `GCancellable` to cancel the launch * @callback: (scope async): a callback to call when the action is complete * @user_data: (closure callback): data to pass to @callback * @@ -135,8 +135,8 @@ gtk_show_uri_full (GtkWindow *parent, /** * gtk_show_uri_full_finish: - * @parent: the #GtkWindow passed to gtk_show_uri() - * @result: #GAsyncResult that was passed to @callback + * @parent: the `GtkWindow` passed to gtk_show_uri() + * @result: `GAsyncResult` that was passed to @callback * @error: return location for an error * * Finishes the gtk_show_uri() call and returns the result diff --git a/gtk/gtksignallistitemfactory.c b/gtk/gtksignallistitemfactory.c index b56b2c19f0..a2d0240ffe 100644 --- a/gtk/gtksignallistitemfactory.c +++ b/gtk/gtksignallistitemfactory.c @@ -61,7 +61,7 @@ * was emitted on a listitem, the listitem will be destroyed and not be used again. * * Note that during the signal emissions, changing properties on the - * #GtkListItems passed will not trigger notify signals as the listitem's + * `GtkListItem`s passed will not trigger notify signals as the listitem's * notifications are frozen. See g_object_freeze_notify() for details. * * For tracking changes in other properties in the `GtkListItem`, the @@ -156,7 +156,7 @@ gtk_signal_list_item_factory_class_init (GtkSignalListItemFactoryClass *klass) /** * GtkSignalListItemFactory::setup: * @self: The `GtkSignalListItemFactory` - * @listitem: The #GtkListItem to set up + * @listitem: The `GtkListItem` to set up * * Emitted when a new listitem has been created and needs to be setup for use. * @@ -181,7 +181,7 @@ gtk_signal_list_item_factory_class_init (GtkSignalListItemFactoryClass *klass) /** * GtkSignalListItemFactory::bind: * @self: The `GtkSignalListItemFactory` - * @listitem: The #GtkListItem to bind + * @listitem: The `GtkListItem` to bind * * Emitted when a new [property@Gtk.ListItem:item] has been set * on the @listitem and should be bound for use. @@ -209,7 +209,7 @@ gtk_signal_list_item_factory_class_init (GtkSignalListItemFactoryClass *klass) /** * GtkSignalListItemFactory::unbind: * @self: The `GtkSignalListItemFactory` - * @listitem: The #GtkListItem to unbind + * @listitem: The `GtkListItem` to unbind * * Emitted when a listitem has been removed from use in a list widget * and its new [property@Gtk.ListItem:item] is about to be unset. @@ -233,7 +233,7 @@ gtk_signal_list_item_factory_class_init (GtkSignalListItemFactoryClass *klass) /** * GtkSignalListItemFactory::teardown: * @self: The `GtkSignalListItemFactory` - * @listitem: The #GtkListItem to teardown + * @listitem: The `GtkListItem` to teardown * * Emitted when a listitem is about to be destroyed. * diff --git a/gtk/gtksizerequest.c b/gtk/gtksizerequest.c index 8f038596e1..935112061a 100644 --- a/gtk/gtksizerequest.c +++ b/gtk/gtksizerequest.c @@ -446,7 +446,7 @@ gtk_widget_query_size_for_orientation (GtkWidget *widget, /** * gtk_widget_measure: - * @widget: A #GtkWidget instance + * @widget: A `GtkWidget` instance * @orientation: the orientation to measure * @for_size: Size for the opposite of @orientation, i.e. * if @orientation is %GTK_ORIENTATION_HORIZONTAL, this is @@ -467,7 +467,7 @@ gtk_widget_query_size_for_orientation (GtkWidget *widget, * if it is allocated at a height of 300 pixels. * * See [GtkWidget’s geometry management section](class.Widget.html#height-for-width-geometry-management) for - * a more details on implementing #GtkWidgetClass.measure(). + * a more details on implementing `GtkWidgetClass.measure()`. */ void gtk_widget_measure (GtkWidget *widget, diff --git a/gtk/gtksnapshot.c b/gtk/gtksnapshot.c index 261c41860f..b0b1222c66 100644 --- a/gtk/gtksnapshot.c +++ b/gtk/gtksnapshot.c @@ -1523,7 +1523,7 @@ gtk_snapshot_to_node (GtkSnapshot *snapshot) * add more nodes to @snapshot. The only function that should * be called after this is g_object_unref(). * - * Returns: (transfer full): a new #GdkPaintable + * Returns: (transfer full): a new `GdkPaintable` */ GdkPaintable * gtk_snapshot_to_paintable (GtkSnapshot *snapshot, @@ -1848,7 +1848,7 @@ gtk_snapshot_perspective (GtkSnapshot *snapshot, /** * gtk_snapshot_append_node: * @snapshot: a `GtkSnapshot` - * @node: a #GskRenderNode + * @node: a `GskRenderNode` * * Appends @node to the current render node of @snapshot, * without changing the current node. @@ -2072,7 +2072,7 @@ gtk_snapshot_render_focus (GtkSnapshot *snapshot, * @context: the `GtkStyleContext` to use * @x: X origin of the rectangle * @y: Y origin of the rectangle - * @layout: the #PangoLayout to render + * @layout: the `PangoLayout` to render * * Creates a render node for rendering @layout according to the style * information in @context, and appends it to the current node of @snapshot, diff --git a/gtk/gtksorter.c b/gtk/gtksorter.c index 9fe8a906cb..f40c15311f 100644 --- a/gtk/gtksorter.c +++ b/gtk/gtksorter.c @@ -111,7 +111,7 @@ gtk_sorter_class_init (GtkSorterClass *class) /** * GtkSorter::changed: - * @self: The #GtkSorter + * @self: The `GtkSorter` * @change: how the sorter changed * * Emitted whenever the sorter changed. diff --git a/gtk/gtksorter.h b/gtk/gtksorter.h index 6cc248ec38..668aa9507c 100644 --- a/gtk/gtksorter.h +++ b/gtk/gtksorter.h @@ -31,7 +31,7 @@ G_BEGIN_DECLS /** * GtkSorterOrder: - * @GTK_SORTER_ORDER_PARTIAL: A partial order. Any #GtkOrdering is possible. + * @GTK_SORTER_ORDER_PARTIAL: A partial order. Any `GtkOrdering` is possible. * @GTK_SORTER_ORDER_NONE: No order, all elements are considered equal. * gtk_sorter_compare() will only return %GTK_ORDERING_EQUAL. * @GTK_SORTER_ORDER_TOTAL: A total order. gtk_sorter_compare() will only @@ -76,7 +76,7 @@ G_DECLARE_DERIVABLE_TYPE (GtkSorter, gtk_sorter, GTK, SORTER, GObject) /** * GtkSorterClass * @compare: Compare two items. See gtk_sorter_compare() for details. - * @get_order: Get the #GtkSorderOrder that applies to the current sorter. + * @get_order: Get the `GtkSorderOrder` that applies to the current sorter. * If unimplemented, it returns %GTK_SORTER_ORDER_PARTIAL. * * The virtual table for `GtkSorter`. diff --git a/gtk/gtksortkeys.c b/gtk/gtksortkeys.c index 032c60b4f2..9aa7a3f689 100644 --- a/gtk/gtksortkeys.c +++ b/gtk/gtksortkeys.c @@ -135,10 +135,10 @@ static const GtkSortKeysClass GTK_EQUAL_SORT_KEYS_CLASS = /*<private> * gtk_sort_keys_new_equal: * - * Creates a new #GtkSortKeys that compares every element as equal. + * Creates a new GtkSortKeys that compares every element as equal. * This is useful when sorters are in an invalid configuration. * - * Returns: a new #GtkSortKeys + * Returns: a new GtkSortKeys **/ GtkSortKeys * gtk_sort_keys_new_equal (void) diff --git a/gtk/gtkspinbutton.c b/gtk/gtkspinbutton.c index 9a41486cde..ac1b2e1568 100644 --- a/gtk/gtkspinbutton.c +++ b/gtk/gtkspinbutton.c @@ -568,7 +568,7 @@ gtk_spin_button_class_init (GtkSpinButtonClass *class) /** * GtkSpinButton::change-value: * @spin_button: the object on which the signal was emitted - * @scroll: a #GtkScrollType to specify the speed and amount of change + * @scroll: a `GtkScrollType` to specify the speed and amount of change * * Emitted when the user initiates a value change. * diff --git a/gtk/gtkspinbutton.h b/gtk/gtkspinbutton.h index 350d0c3979..d5f9287888 100644 --- a/gtk/gtkspinbutton.h +++ b/gtk/gtkspinbutton.h @@ -54,9 +54,9 @@ G_BEGIN_DECLS /** * GtkSpinButtonUpdatePolicy: - * @GTK_UPDATE_ALWAYS: When refreshing your #GtkSpinButton, the value is + * @GTK_UPDATE_ALWAYS: When refreshing your `GtkSpinButton`, the value is * always displayed - * @GTK_UPDATE_IF_VALID: When refreshing your #GtkSpinButton, the value is + * @GTK_UPDATE_IF_VALID: When refreshing your `GtkSpinButton`, the value is * only displayed if it is valid within the bounds of the spin button's * adjustment * diff --git a/gtk/gtkstack.c b/gtk/gtkstack.c index 4d77e89ef4..d53eb0653a 100644 --- a/gtk/gtkstack.c +++ b/gtk/gtkstack.c @@ -1751,7 +1751,7 @@ gtk_stack_get_hhomogeneous (GtkStack *stack) * @stack: a `GtkStack` * @vhomogeneous: %TRUE to make @stack vertically homogeneous * - * Sets the #GtkStack to be vertically homogeneous or not. + * Sets the `GtkStack` to be vertically homogeneous or not. * * If it is homogeneous, the `GtkStack` will request the same * height for all its children. If it isn't, the stack @@ -1941,7 +1941,7 @@ gtk_stack_set_interpolate_size (GtkStack *stack, * gtk_stack_get_interpolate_size: (attributes org.gtk.Method.get_property=interpolate-size) * @stack: A `GtkStack` * - * Returns whether the #GtkStack is set up to interpolate between + * Returns whether the `GtkStack` is set up to interpolate between * the sizes of children on page switch. * * Returns: %TRUE if child sizes are interpolated diff --git a/gtk/gtkstacksidebar.c b/gtk/gtkstacksidebar.c index 41631859d1..49d26de430 100644 --- a/gtk/gtkstacksidebar.c +++ b/gtk/gtkstacksidebar.c @@ -425,7 +425,7 @@ gtk_stack_sidebar_set_stack (GtkStackSidebar *self, * * Retrieves the stack. * - * Returns: (nullable) (transfer none): the associated #GtkStack or + * Returns: (nullable) (transfer none): the associated `GtkStack` or * %NULL if none has been set explicitly */ GtkStack * diff --git a/gtk/gtkstylecontext.c b/gtk/gtkstylecontext.c index 5427e67879..fcf123b011 100644 --- a/gtk/gtkstylecontext.c +++ b/gtk/gtkstylecontext.c @@ -56,7 +56,7 @@ * queries information from all attached `GtkStyleProviders`. Style * providers can be either attached explicitly to the context through * [method@Gtk.StyleContext.add_provider], or to the display through - * [func@Gtk.StyleContext.add_provider_for_display]. The resulting + * [type_func@Gtk.StyleContext.add_provider_for_display]. The resulting * style is a combination of all providers’ information in priority order. * * For GTK widgets, any `GtkStyleContext` returned by @@ -354,11 +354,11 @@ gtk_style_context_new_for_node (GtkCssNode *node) * Note that a style provider added by this function only affects * the style of the widget to which @context belongs. If you want * to affect the style of all widgets, use - * [func@Gtk.StyleContext.add_provider_for_display]. + * [type_func@Gtk.StyleContext.add_provider_for_display]. * * Note: If both priorities are the same, a `GtkStyleProvider` * added through this function takes precedence over another added - * through [func@Gtk.StyleContext.add_provider_for_display]. + * through [type_func@Gtk.StyleContext.add_provider_for_display]. */ void gtk_style_context_add_provider (GtkStyleContext *context, @@ -1124,8 +1124,8 @@ snapshot_insertion_cursor (GtkSnapshot *snapshot, * @x: X origin * @y: Y origin * @layout: the `PangoLayout` of the text - * @index: the index in the #PangoLayout - * @direction: the #PangoDirection of the text + * @index: the index in the `PangoLayout` + * @direction: the `PangoDirection` of the text * * Draws a text caret using @snapshot at the specified index of @layout. */ diff --git a/gtk/gtkstyleproperty.c b/gtk/gtkstyleproperty.c index f753070402..f560d25fd5 100644 --- a/gtk/gtkstyleproperty.c +++ b/gtk/gtkstyleproperty.c @@ -124,11 +124,11 @@ _gtk_style_property_init (GtkStyleProperty *property) * parsing fails, %FALSE will be returned and @value will be * left uninitialized. * - * Only if @property is a #GtkCssShorthandProperty, the @value will - * always be a #GtkCssValue whose values can be queried with + * Only if @property is a `GtkCssShorthandProperty`, the @value will + * always be a `GtkCssValue` whose values can be queried with * _gtk_css_array_value_get_nth(). * - * Returns: (nullable): %NULL on failure or the parsed #GtkCssValue + * Returns: (nullable): %NULL on failure or the parsed `GtkCssValue` **/ GtkCssValue * _gtk_style_property_parse_value (GtkStyleProperty *property, diff --git a/gtk/gtkstyleprovider.c b/gtk/gtkstyleprovider.c index 1c404ad368..1b2b499257 100644 --- a/gtk/gtkstyleprovider.c +++ b/gtk/gtkstyleprovider.c @@ -29,7 +29,7 @@ * `GtkStyleContext`. * * See [method@Gtk.StyleContext.add_provider] and - * [func@Gtk.StyleContext.add_provider_for_display] for + * [type_func@Gtk.StyleContext.add_provider_for_display] for * adding `GtkStyleProviders`. * * GTK uses the `GtkStyleProvider` implementation for CSS in diff --git a/gtk/gtkstyleprovider.h b/gtk/gtkstyleprovider.h index 64abae73a3..9a8913f078 100644 --- a/gtk/gtkstyleprovider.h +++ b/gtk/gtkstyleprovider.h @@ -59,7 +59,7 @@ G_BEGIN_DECLS * The priority used for style information provided * via `GtkSettings`. * - * This priority is higher than #GTK_STYLE_PROVIDER_PRIORITY_THEME + * This priority is higher than %GTK_STYLE_PROVIDER_PRIORITY_THEME * to let settings override themes. */ #define GTK_STYLE_PROVIDER_PRIORITY_SETTINGS 400 diff --git a/gtk/gtktestatcontext.c b/gtk/gtktestatcontext.c index e8f3754ea9..3e30b27d10 100644 --- a/gtk/gtktestatcontext.c +++ b/gtk/gtktestatcontext.c @@ -118,14 +118,14 @@ gtk_test_at_context_init (GtkTestATContext *self) /*< private > * gtk_test_at_context_new: - * @accessible_role: the #GtkAccessibleRole for the AT context - * @accessible: the #GtkAccessible instance which owns the AT context - * @display: a #GdkDisplay + * @accessible_role: the `GtkAccessibleRole` for the AT context + * @accessible: the `GtkAccessible` instance which owns the AT context + * @display: a `GdkDisplay` * - * Creates a new #GtkTestATContext instance for @accessible, using the + * Creates a new `GtkTestATContext` instance for @accessible, using the * given @accessible_role. * - * Returns: (transfer full): the newly created #GtkTestATContext instance + * Returns: (transfer full): the newly created `GtkTestATContext` instance */ GtkATContext * gtk_test_at_context_new (GtkAccessibleRole accessible_role, @@ -141,10 +141,10 @@ gtk_test_at_context_new (GtkAccessibleRole accessible_role, /** * gtk_test_accessible_has_role: - * @accessible: a #GtkAccessible - * @role: a #GtkAccessibleRole + * @accessible: a `GtkAccessible` + * @role: a `GtkAccessibleRole` * - * Checks whether the #GtkAccessible:accessible-role of the accessible + * Checks whether the `GtkAccessible:accessible-role` of the accessible * is @role. * * Returns: %TRUE if the role matches @@ -160,10 +160,10 @@ gtk_test_accessible_has_role (GtkAccessible *accessible, /** * gtk_test_accessible_has_property: - * @accessible: a #GtkAccessible - * @property: a #GtkAccessibleProperty + * @accessible: a `GtkAccessible` + * @property: a `GtkAccessibleProperty` * - * Checks whether the #GtkAccessible has @property set. + * Checks whether the `GtkAccessible` has @property set. * * Returns: %TRUE if the @property is set in the @accessible */ @@ -184,8 +184,8 @@ gtk_test_accessible_has_property (GtkAccessible *accessible, /** * gtk_test_accessible_check_property: - * @accessible: a #GtkAccessible - * @property: a #GtkAccessibleProperty + * @accessible: a `GtkAccessible` + * @property: a `GtkAccessibleProperty` * @...: the expected value of @property * * Checks whether the accessible @property of @accessible is set to @@ -236,10 +236,10 @@ out: /** * gtk_test_accessible_has_state: - * @accessible: a #GtkAccessible - * @state: a #GtkAccessibleState + * @accessible: a `GtkAccessible` + * @state: a `GtkAccessibleState` * - * Checks whether the #GtkAccessible has @state set. + * Checks whether the `GtkAccessible` has @state set. * * Returns: %TRUE if the @state is set in the @accessible */ @@ -260,8 +260,8 @@ gtk_test_accessible_has_state (GtkAccessible *accessible, /** * gtk_test_accessible_check_state: - * @accessible: a #GtkAccessible - * @state: a #GtkAccessibleState + * @accessible: a `GtkAccessible` + * @state: a `GtkAccessibleState` * @...: the expected value of @state * * Checks whether the accessible @state of @accessible is set to @@ -312,10 +312,10 @@ out: /** * gtk_test_accessible_has_relation: - * @accessible: a #GtkAccessible - * @relation: a #GtkAccessibleRelation + * @accessible: a `GtkAccessible` + * @relation: a `GtkAccessibleRelation` * - * Checks whether the #GtkAccessible has @relation set. + * Checks whether the `GtkAccessible` has @relation set. * * Returns: %TRUE if the @relation is set in the @accessible */ @@ -336,8 +336,8 @@ gtk_test_accessible_has_relation (GtkAccessible *accessible, /** * gtk_test_accessible_check_relation: - * @accessible: a #GtkAccessible - * @relation: a #GtkAccessibleRelation + * @accessible: a `GtkAccessible` + * @relation: a `GtkAccessibleRelation` * @...: the expected value of @relation * * Checks whether the accessible @relation of @accessible is set to @@ -393,9 +393,9 @@ out: * @line: the line in @file * @func: a function name in @file * @expr: the expression being tested - * @accessible: a #GtkAccessible - * @expected_role: the expected #GtkAccessibleRole - * @actual_role: the actual #GtkAccessibleRole + * @accessible: a `GtkAccessible` + * @expected_role: the expected `GtkAccessibleRole` + * @actual_role: the actual `GtkAccessibleRole` * * Prints an assertion message for gtk_test_accessible_assert_role(). */ diff --git a/gtk/gtktestatcontext.h b/gtk/gtktestatcontext.h index 574b79a7dc..b4adfb3414 100644 --- a/gtk/gtktestatcontext.h +++ b/gtk/gtktestatcontext.h @@ -30,10 +30,10 @@ G_BEGIN_DECLS /** * gtk_test_accessible_assert_role: - * @accessible: a #GtkAccessible - * @role: a #GtkAccessibleRole + * @accessible: a `GtkAccessible` + * @role: a `GtkAccessibleRole` * - * Checks whether a #GtkAccessible implementation has the given @role, + * Checks whether a `GtkAccessible` implementation has the given @role, * and raises an assertion if the condition is failed. */ #define gtk_test_accessible_assert_role(accessible,role) \ @@ -50,11 +50,11 @@ G_STMT_START { \ /** * gtk_test_accessible_assert_property: - * @accessible: a #GtkAccessible - * @property: a #GtkAccessibleProperty + * @accessible: a `GtkAccessible` + * @property: a `GtkAccessibleProperty` * @...: the value of @property * - * Checks whether a #GtkAccessible implementation has its accessible + * Checks whether a `GtkAccessible` implementation has its accessible * property set to the expected value, and raises an assertion if the * condition is not satisfied. */ @@ -72,11 +72,11 @@ G_STMT_START { \ /** * gtk_test_accessible_assert_relation: - * @accessible: a #GtkAccessible - * @relation: a #GtkAccessibleRelation + * @accessible: a `GtkAccessible` + * @relation: a `GtkAccessibleRelation` * @...: the expected value of @relation * - * Checks whether a #GtkAccessible implementation has its accessible + * Checks whether a `GtkAccessible` implementation has its accessible * relation set to the expected value, and raises an assertion if the * condition is not satisfied. */ @@ -94,11 +94,11 @@ G_STMT_START { \ /** * gtk_test_accessible_assert_state: - * @accessible: a #GtkAccessible - * @state: a #GtkAccessibleRelation + * @accessible: a `GtkAccessible` + * @state: a `GtkAccessibleRelation` * @...: the expected value of @state * - * Checks whether a #GtkAccessible implementation has its accessible + * Checks whether a `GtkAccessible` implementation has its accessible * state set to the expected value, and raises an assertion if the * condition is not satisfied. */ diff --git a/gtk/gtktext.c b/gtk/gtktext.c index 8db3495a44..0791fe063c 100644 --- a/gtk/gtktext.c +++ b/gtk/gtktext.c @@ -1018,7 +1018,7 @@ gtk_text_class_init (GtkTextClass *class) /** * GtkText::move-cursor: * @self: the object which received the signal - * @step: the granularity of the move, as a #GtkMovementStep + * @step: the granularity of the move, as a `GtkMovementStep` * @count: the number of @step units to move * @extend: %TRUE if the move should extend the selection * @@ -1080,7 +1080,7 @@ gtk_text_class_init (GtkTextClass *class) /** * GtkText::delete-from-cursor: * @self: the object which received the signal - * @type: the granularity of the deletion, as a #GtkDeleteType + * @type: the granularity of the deletion, as a `GtkDeleteType` * @count: the number of @type units to delete * * Emitted when the user initiates a text deletion. diff --git a/gtk/gtktextattributes.c b/gtk/gtktextattributes.c index 19becb030e..738caa6bc1 100644 --- a/gtk/gtktextattributes.c +++ b/gtk/gtktextattributes.c @@ -55,10 +55,10 @@ /** * gtk_text_attributes_new: * - * Creates a #GtkTextAttributes, which describes + * Creates a `GtkTextAttributes`, which describes * a set of properties on some text. * - * Returns: a new #GtkTextAttributes, + * Returns: a new `GtkTextAttributes`, * free with gtk_text_attributes_unref(). */ GtkTextAttributes* @@ -82,9 +82,9 @@ gtk_text_attributes_new (void) /** * gtk_text_attributes_copy: - * @src: a #GtkTextAttributes to be copied + * @src: a `GtkTextAttributes` to be copied * - * Copies @src and returns a new #GtkTextAttributes. + * Copies @src and returns a new `GtkTextAttributes`. * * Returns: a copy of @src, * free with gtk_text_attributes_unref() @@ -102,8 +102,8 @@ gtk_text_attributes_copy (GtkTextAttributes *src) /** * gtk_text_attributes_copy_values: - * @src: a #GtkTextAttributes - * @dest: another #GtkTextAttributes + * @src: a `GtkTextAttributes` + * @dest: another `GtkTextAttributes` * * Copies the values from @src to @dest so that @dest has * the same values as @src. Frees existing values in @dest. @@ -184,11 +184,11 @@ gtk_text_attributes_copy_values (GtkTextAttributes *src, /** * gtk_text_attributes_ref: - * @values: a #GtkTextAttributes + * @values: a `GtkTextAttributes` * * Increments the reference count on @values. * - * Returns: the #GtkTextAttributes that were passed in + * Returns: the `GtkTextAttributes` that were passed in **/ GtkTextAttributes * gtk_text_attributes_ref (GtkTextAttributes *values) @@ -202,7 +202,7 @@ gtk_text_attributes_ref (GtkTextAttributes *values) /** * gtk_text_attributes_unref: - * @values: a #GtkTextAttributes + * @values: a `GtkTextAttributes` * * Decrements the reference count on @values, freeing the structure * if the reference count reaches 0. diff --git a/gtk/gtktextattributes.h b/gtk/gtktextattributes.h index b7dfa9ce7b..05f7750247 100644 --- a/gtk/gtktextattributes.h +++ b/gtk/gtktextattributes.h @@ -60,26 +60,6 @@ G_BEGIN_DECLS typedef struct _GtkTextAttributes GtkTextAttributes; typedef struct _GtkTextAppearance GtkTextAppearance; -/** - * GtkTextAppearance: - * @bg_color: Background #GdkColor. - * @fg_color: Foreground #GdkColor. - * @rise: Super/subscript rise, can be negative. - * @underline: #PangoUnderline - * @overline: #PangoOverline - * @strikethrough: Strikethrough style - * @draw_bg: Whether to use background-related values; this is - * irrelevant for the values struct when in a tag, but is used for - * the composite values struct; it’s true if any of the tags being - * composited had background stuff set. - * @inside_selection: This are only used when we are actually laying - * out and rendering a paragraph; not when a #GtkTextAppearance is - * part of a #GtkTextAttributes. - * @is_text: This are only used when we are actually laying - * out and rendering a paragraph; not when a #GtkTextAppearance is - * part of a #GtkTextAttributes. - * @rgba: #GdkRGBA - */ struct _GtkTextAppearance { GdkRGBA *bg_rgba; @@ -112,10 +92,10 @@ struct _GtkTextAppearance /** * GtkTextAttributes: - * @appearance: #GtkTextAppearance for text. - * @justification: #GtkJustification for text. - * @direction: #GtkTextDirection for text. - * @font: #PangoFontDescription for text. + * @appearance: GtkTextAppearance for text. + * @justification: GtkJustification for text. + * @direction: GtkTextDirection for text. + * @font: `PangoFontDescription` for text. * @font_scale: Font scale factor. * @left_margin: Width of the left margin in pixels. * @right_margin: Width of the right margin in pixels. @@ -124,9 +104,9 @@ struct _GtkTextAppearance * @pixels_below_lines: Pixels of blank space below paragraphs. * @pixels_inside_wrap: Pixels of blank space between wrapped lines in * a paragraph. - * @tabs: Custom #PangoTabArray for this text. - * @wrap_mode: #GtkWrapMode for text. - * @language: #PangoLanguage for text. + * @tabs: Custom `PangoTabArray` for this text. + * @wrap_mode: `GtkWrapMode` for text. + * @language: `PangoLanguage` for text. * @invisible: Hide the text. * @bg_full_height: Background is fit to full line height rather than * baseline +/- ascent/descent (font height). @@ -134,7 +114,7 @@ struct _GtkTextAppearance * @no_fallback: Whether to disable font fallback. * @letter_spacing: Extra space to insert between graphemes, in Pango units * - * Using #GtkTextAttributes directly should rarely be necessary. + * Using GtkTextAttributes directly should rarely be necessary. * It’s primarily useful with gtk_text_iter_get_attributes(). * As with most GTK structs, the fields in this struct should only * be read, never modified directly. diff --git a/gtk/gtktextbtree.c b/gtk/gtktextbtree.c index 6d02b70098..0acc023a09 100644 --- a/gtk/gtktextbtree.c +++ b/gtk/gtktextbtree.c @@ -2999,19 +2999,21 @@ _gtk_text_btree_get_mark_by_name (GtkTextBTree *tree, /** * gtk_text_mark_set_visible: - * @mark: a #GtkTextMark + * @mark: a GtkTextMark * @setting: visibility of mark - * - * Sets the visibility of @mark; the insertion point is normally - * visible, i.e. you can see it as a vertical bar. Also, the text - * widget uses a visible mark to indicate where a drop will occur when - * dragging-and-dropping text. Most other marks are not visible. + * + * Sets the visibility of @mark. + * + * The insertion point is normally visible, i.e. you can see it as + * a vertical bar. Also, the text widget uses a visible mark to + * indicate where a drop will occur when dragging-and-dropping text. + * Most other marks are not visible. + * * Marks are not visible by default. - * - **/ + */ void -gtk_text_mark_set_visible (GtkTextMark *mark, - gboolean setting) +gtk_text_mark_set_visible (GtkTextMark *mark, + gboolean setting) { GtkTextLineSegment *seg; @@ -5012,13 +5014,13 @@ gtk_text_btree_node_invalidate_upward (GtkTextBTreeNode *node, gpointer view_id) /** * _gtk_text_btree_is_valid: - * @tree: a #GtkTextBTree + * @tree: a GtkTextBTree * @view_id: ID for the view * - * Check to see if the entire #GtkTextBTree is valid or not for + * Check to see if the entire GtkTextBTree is valid or not for * the given view. * - * Returns: %TRUE if the entire #GtkTextBTree is valid + * Returns: %TRUE if the entire GtkTextBTree is valid **/ gboolean _gtk_text_btree_is_valid (GtkTextBTree *tree, @@ -5208,7 +5210,7 @@ gtk_text_btree_node_validate (BTreeView *view, /** * _gtk_text_btree_validate: - * @tree: a #GtkTextBTree + * @tree: a GtkTextBTree * @view_id: view id * @max_pixels: the maximum number of pixels to validate. (No more * than one paragraph beyond this limit will be validated) @@ -5216,7 +5218,7 @@ gtk_text_btree_node_validate (BTreeView *view, * @old_height: location to store old height of validated region * @new_height: location to store new height of validated region * - * Validate a single contiguous invalid region of a #GtkTextBTree for + * Validate a single contiguous invalid region of a GtkTextBTree for * a given view. * * Returns: %TRUE if a region has been validated, %FALSE if the @@ -5396,7 +5398,7 @@ gtk_text_btree_node_check_valid_downward (GtkTextBTreeNode *node, /** * _gtk_text_btree_validate_line: - * @tree: a #GtkTextBTree + * @tree: a GtkTextBTree * @line: line to validate * @view_id: view ID for the view to validate * diff --git a/gtk/gtktextbuffer.c b/gtk/gtktextbuffer.c index 80127c3fde..61533875fd 100644 --- a/gtk/gtktextbuffer.c +++ b/gtk/gtktextbuffer.c @@ -2462,14 +2462,14 @@ gtk_text_buffer_set_mark (GtkTextBuffer *buffer, * side of the text you’re typing). * * The caller of this function does not own a - * reference to the returned #GtkTextMark, so you can ignore the + * reference to the returned `GtkTextMark`, so you can ignore the * return value if you like. Marks are owned by the buffer and go * away when the buffer does. * * Emits the `GtkTextBuffer`::mark-set signal as notification of * the mark's initial placement. * - * Returns: (transfer none): the new #GtkTextMark object + * Returns: (transfer none): the new `GtkTextMark` object */ GtkTextMark* gtk_text_buffer_create_mark (GtkTextBuffer *buffer, @@ -2615,7 +2615,7 @@ gtk_text_buffer_delete_mark (GtkTextBuffer *buffer, * Returns the mark named @name in buffer @buffer, or %NULL if no such * mark exists in the buffer. * - * Returns: (nullable) (transfer none): a #GtkTextMark + * Returns: (nullable) (transfer none): a `GtkTextMark` **/ GtkTextMark* gtk_text_buffer_get_mark (GtkTextBuffer *buffer, diff --git a/gtk/gtktextbuffer.h b/gtk/gtktextbuffer.h index e7e6a4dc65..83ea8f47cf 100644 --- a/gtk/gtktextbuffer.h +++ b/gtk/gtktextbuffer.h @@ -57,23 +57,23 @@ struct _GtkTextBuffer /** * GtkTextBufferClass: * @parent_class: The object class structure needs to be the first. - * @insert_text: The class handler for the #GtkTextBuffer::insert-text signal. - * @insert_paintable: The class handler for the #GtkTextBuffer::insert-paintable signal. - * @insert_child_anchor: The class handler for the #GtkTextBuffer::insert-child-anchor signal. - * @delete_range: The class handler for the #GtkTextBuffer::delete-range signal. - * @changed: The class handler for the #GtkTextBuffer::changed signal. - * @modified_changed: The class handler for the #GtkTextBuffer::modified-changed signal. - * @mark_set: The class handler for the #GtkTextBuffer::mark-set signal. - * @mark_deleted: The class handler for the #GtkTextBuffer::mark-deleted signal. - * @apply_tag: The class handler for the #GtkTextBuffer::apply-tag signal. - * @remove_tag: The class handler for the #GtkTextBuffer::remove-tag signal. - * @begin_user_action: The class handler for the #GtkTextBuffer::begin-user-action signal. - * @end_user_action: The class handler for the #GtkTextBuffer::end-user-action signal. - * @paste_done: The class handler for the #GtkTextBuffer::paste-done signal. - * @undo: The class handler for the #GtkTextBuffer::undo signal - * @redo: The class handler for the #GtkTextBuffer::redo signal + * @insert_text: The class handler for the `GtkTextBuffer::insert-text` signal. + * @insert_paintable: The class handler for the `GtkTextBuffer::insert-paintable` signal. + * @insert_child_anchor: The class handler for the `GtkTextBuffer::insert-child-anchor` signal. + * @delete_range: The class handler for the `GtkTextBuffer::delete-range` signal. + * @changed: The class handler for the `GtkTextBuffer::changed` signal. + * @modified_changed: The class handler for the `GtkTextBuffer::modified-changed` signal. + * @mark_set: The class handler for the `GtkTextBuffer::mark-set` signal. + * @mark_deleted: The class handler for the `GtkTextBuffer::mark-deleted` signal. + * @apply_tag: The class handler for the `GtkTextBuffer::apply-tag` signal. + * @remove_tag: The class handler for the `GtkTextBuffer::remove-tag` signal. + * @begin_user_action: The class handler for the `GtkTextBuffer::begin-user-action` signal. + * @end_user_action: The class handler for the `GtkTextBuffer::end-user-action` signal. + * @paste_done: The class handler for the `GtkTextBuffer::paste-done` signal. + * @undo: The class handler for the `GtkTextBuffer::undo` signal + * @redo: The class handler for the `GtkTextBuffer::redo` signal * - * The class structure for #GtkTextBuffer. + * The class structure for `GtkTextBuffer`. */ struct _GtkTextBufferClass { diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c index e19befe88d..7157233641 100644 --- a/gtk/gtktextiter.c +++ b/gtk/gtktextiter.c @@ -1370,7 +1370,7 @@ gtk_text_iter_has_tag (const GtkTextIter *iter, /** * gtk_text_iter_get_tags: - * @iter: a #GtkTextIter + * @iter: a `GtkTextIter` * * Returns a list of tags that apply to @iter, in ascending order of * priority. @@ -1421,7 +1421,7 @@ gtk_text_iter_get_tags (const GtkTextIter *iter) * of text. * * Non-editable text is “locked” and can’t be changed by the - * user via #GtkTextView. If no tags applied to this text affect + * user via `GtkTextView`. If no tags applied to this text affect * editability, @default_setting will be returned. * * You don’t want to use this function to decide whether text can be @@ -2490,7 +2490,7 @@ gtk_text_iter_backward_chars (GtkTextIter *iter, int count) /** * gtk_text_iter_forward_text_chars: - * @iter: a #GtkTextIter + * @iter: a `GtkTextIter` * @count: number of chars to move * * Moves forward by @count text characters. @@ -2513,7 +2513,7 @@ gtk_text_iter_forward_text_chars (GtkTextIter *iter, /** * gtk_text_iter_backward_text_chars: - * @iter: a #GtkTextIter + * @iter: a `GtkTextIter` * @count: number of chars to move * * Moves backward by @count text characters (paintables, widgets, diff --git a/gtk/gtktextlayout.c b/gtk/gtktextlayout.c index ec8307a742..ea5e85a577 100644 --- a/gtk/gtktextlayout.c +++ b/gtk/gtktextlayout.c @@ -431,7 +431,7 @@ gtk_text_layout_set_contexts (GtkTextLayout *layout, /** * gtk_text_layout_set_overwrite_mode: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * @overwrite: overwrite mode * * Sets overwrite mode @@ -493,7 +493,7 @@ gtk_text_layout_set_keyboard_direction (GtkTextLayout *layout, /** * gtk_text_layout_get_buffer: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * * Gets the text buffer used by the layout. See * gtk_text_layout_set_buffer(). @@ -526,12 +526,12 @@ gtk_text_layout_set_screen_width (GtkTextLayout *layout, int width) /** * gtk_text_layout_set_cursor_visible: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * @cursor_visible: If %FALSE, then the insertion cursor will not * be shown, even if the text is editable. * * Sets whether the insertion cursor should be shown. Generally, - * widgets using #GtkTextLayout will hide the cursor when the + * widgets using `GtkTextLayout` will hide the cursor when the * widget does not have the input focus. */ void @@ -561,7 +561,7 @@ gtk_text_layout_set_cursor_visible (GtkTextLayout *layout, /** * gtk_text_layout_get_cursor_visible: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * * Returns whether the insertion cursor will be shown. * @@ -576,9 +576,9 @@ gtk_text_layout_get_cursor_visible (GtkTextLayout *layout) /** * gtk_text_layout_set_preedit_string: - * @layout: a #PangoLayout + * @layout: a `PangoLayout` * @preedit_string: a string to display at the insertion point - * @preedit_attrs: a #PangoAttrList of attributes that apply to @preedit_string + * @preedit_attrs: a `PangoAttrList` of attributes that apply to @preedit_string * @cursor_pos: position of cursor within preedit string in chars * * Set the preedit string and attributes. The preedit string is a @@ -859,9 +859,9 @@ gtk_text_layout_free_line_data (GtkTextLayout *layout, /** * gtk_text_layout_is_valid: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * - * Check if there are any invalid regions in a #GtkTextLayout’s buffer + * Check if there are any invalid regions in a `GtkTextLayout`’s buffer * * Returns: %TRUE if any invalid regions were found */ @@ -884,7 +884,7 @@ update_layout_size (GtkTextLayout *layout) /** * gtk_text_layout_validate_yrange: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * @anchor: iter pointing into a line that will be used as the * coordinate origin * @y0_: offset from the top of the line pointed to by @anchor at @@ -894,7 +894,7 @@ update_layout_size (GtkTextLayout *layout) * which to end validation. (The offset here is in pixels * after validation.) * - * Ensure that a region of a #GtkTextLayout is valid. The ::changed + * Ensure that a region of a `GtkTextLayout` is valid. The ::changed * signal will be emitted if any lines are validated. */ void @@ -1022,11 +1022,11 @@ gtk_text_layout_validate_yrange (GtkTextLayout *layout, /** * gtk_text_layout_validate: - * @tree: a #GtkTextLayout + * @tree: a `GtkTextLayout` * @max_pixels: the maximum number of pixels to validate. (No more * than one paragraph beyond this limit will be validated) * - * Validate regions of a #GtkTextLayout. The ::changed signal will + * Validate regions of a `GtkTextLayout`. The ::changed signal will * be emitted for each region validated. **/ void @@ -1785,8 +1785,8 @@ add_child_attrs (GtkTextLayout *layout, /* * get_block_cursor: - * @layout: a #GtkTextLayout - * @display: a #GtkTextLineDisplay + * @layout: a `GtkTextLayout` + * @display: a `GtkTextLineDisplay` * @insert_iter: iter pointing to the cursor location * @insert_index: cursor offset in the @display’s layout, it may * be different from @insert_iter’s offset in case when preedit @@ -2730,7 +2730,7 @@ get_line_at_y (GtkTextLayout *layout, /** * gtk_text_layout_get_line_at_y: - * @layout: a #GtkLayout + * @layout: a `GtkLayout` * @target_iter: the iterator in which the result is stored * @y: the y position * @line_top: location to store the y coordinate of the @@ -2824,8 +2824,8 @@ gtk_text_layout_get_iter_at_position (GtkTextLayout *layout, /** * gtk_text_layout_get_cursor_locations: - * @layout: a #GtkTextLayout - * @iter: a #GtkTextIter + * @layout: a `GtkTextLayout` + * @iter: a `GtkTextIter` * @strong_pos: (out) (optional): location to store the strong cursor position * @weak_pos: (out) (optional): location to store the weak cursor position * @@ -2894,8 +2894,8 @@ gtk_text_layout_get_cursor_locations (GtkTextLayout *layout, /** * _gtk_text_layout_get_block_cursor: - * @layout: a #GtkTextLayout - * @pos: a #GdkRectangle to store block cursor position + * @layout: a `GtkTextLayout` + * @pos: a `GdkRectangle` to store block cursor position * * If layout is to display a block cursor, calculates its position * and returns %TRUE. Otherwise it returns %FALSE. In case when @@ -2955,8 +2955,8 @@ _gtk_text_layout_get_block_cursor (GtkTextLayout *layout, /** * gtk_text_layout_get_line_yrange: - * @layout: a #GtkTextLayout - * @iter: a #GtkTextIter + * @layout: a `GtkTextLayout` + * @iter: a `GtkTextIter` * @y: (nullable): location to store the top of the paragraph in pixels * @height: (nullable): location to store the height of the paragraph in pixels * @@ -3171,8 +3171,8 @@ find_display_line_above (GtkTextLayout *layout, /** * gtk_text_layout_clamp_iter_to_vrange: - * @layout: a #GtkTextLayout - * @iter: a #GtkTextIter + * @layout: a `GtkTextLayout` + * @iter: a `GtkTextIter` * @top: the top of the range * @bottom: the bottom the range * @@ -3217,8 +3217,8 @@ gtk_text_layout_clamp_iter_to_vrange (GtkTextLayout *layout, /** * gtk_text_layout_move_iter_to_previous_line: - * @layout: a #GtkLayout - * @iter: a #GtkTextIter + * @layout: a `GtkLayout` + * @iter: a `GtkTextIter` * * Move the iterator to the beginning of the previous line. The lines * of a wrapped paragraph are treated as distinct for this operation. @@ -3336,8 +3336,8 @@ gtk_text_layout_move_iter_to_previous_line (GtkTextLayout *layout, /** * gtk_text_layout_move_iter_to_next_line: - * @layout: a #GtkLayout - * @iter: a #GtkTextIter + * @layout: a `GtkLayout` + * @iter: a `GtkTextIter` * * Move the iterator to the beginning of the next line. The * lines of a wrapped paragraph are treated as distinct for @@ -3413,7 +3413,7 @@ gtk_text_layout_move_iter_to_next_line (GtkTextLayout *layout, /** * gtk_text_layout_move_iter_to_line_end: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * @direction: if negative, move to beginning of line, otherwise move to end of line. * @@ -3474,7 +3474,7 @@ gtk_text_layout_move_iter_to_line_end (GtkTextLayout *layout, /** * gtk_text_layout_iter_starts_line: - * @layout: a #GtkTextLayout + * @layout: a `GtkTextLayout` * @iter: iterator to test * * Tests whether an iterator is at the start of a display line. @@ -3533,9 +3533,9 @@ gtk_text_layout_get_iter_at_line (GtkTextLayout *layout, /** * gtk_text_layout_move_iter_to_x: - * @layout: a #GtkTextLayout - * @iter: a #GtkTextIter - * @x: X coordinate + * @layout: a `GtkTextLayout` + * @iter: a `GtkTextIter` + * @x: X coordinate * * Keeping the iterator on the same line of the layout, move it to the * specified X coordinate. The lines of a wrapped paragraph are @@ -3592,9 +3592,9 @@ gtk_text_layout_move_iter_to_x (GtkTextLayout *layout, /** * gtk_text_layout_move_iter_visually: - * @layout: a #GtkTextLayout - * @iter: a #GtkTextIter - * @count: number of characters to move (negative moves left, positive moves right) + * @layout: a `GtkTextLayout` + * @iter: a `GtkTextIter` + * @count: number of characters to move (negative moves left, positive moves right) * * Move the iterator a given number of characters visually, treating * it as the strong cursor position. If @count is positive, then the diff --git a/gtk/gtktextlinedisplaycache.c b/gtk/gtktextlinedisplaycache.c index 677de11572..7f2a22c713 100644 --- a/gtk/gtktextlinedisplaycache.c +++ b/gtk/gtktextlinedisplaycache.c @@ -257,9 +257,9 @@ gtk_text_line_display_cache_invalidate_display (GtkTextLineDisplayCache *cache, /* * gtk_text_line_display_cache_get: - * @cache: a #GtkTextLineDisplayCache - * @layout: a GtkTextLayout - * @line: a GtkTextLine + * @cache: a `GtkTextLineDisplayCache` + * @layout: a `GtkTextLayout` + * @line: a `GtkTextLine` * @size_only: if only line sizing is needed * * Gets a GtkTextLineDisplay for @line. @@ -269,7 +269,7 @@ gtk_text_line_display_cache_invalidate_display (GtkTextLineDisplayCache *cache, * It's possible that calling this function will cause some existing * cached displays to be released and destroyed. * - * Returns: (transfer full) (not nullable): a #GtkTextLineDisplay + * Returns: (transfer full) (not nullable): a `GtkTextLineDisplay` */ GtkTextLineDisplay * gtk_text_line_display_cache_get (GtkTextLineDisplayCache *cache, diff --git a/gtk/gtktextprivate.h b/gtk/gtktextprivate.h index 0fde7d8fe4..b6a61843af 100644 --- a/gtk/gtktextprivate.h +++ b/gtk/gtktextprivate.h @@ -34,30 +34,30 @@ typedef struct _GtkTextClass GtkTextClass; /*<private> * GtkTextClass: * @parent_class: The parent class. - * @activate: Class handler for the #GtkText::activate signal. The default + * @activate: Class handler for the `GtkText::activate` signal. The default * implementation activates the gtk.activate-default action. - * @move_cursor: Class handler for the #GtkText::move-cursor signal. The - * default implementation specifies the standard #GtkText cursor movement + * @move_cursor: Class handler for the `GtkText::move-cursor` signal. The + * default implementation specifies the standard `GtkText` cursor movement * behavior. - * @insert_at_cursor: Class handler for the #GtkText::insert-at-cursor signal. + * @insert_at_cursor: Class handler for the `GtkText::insert-at-cursor` signal. * The default implementation inserts text at the cursor. - * @delete_from_cursor: Class handler for the #GtkText::delete-from-cursor + * @delete_from_cursor: Class handler for the `GtkText::delete-from-cursor` * signal. The default implementation deletes the selection or the specified * number of characters or words. - * @backspace: Class handler for the #GtkText::backspace signal. The default + * @backspace: Class handler for the `GtkText::backspace` signal. The default * implementation deletes the selection or a single character or word. - * @cut_clipboard: Class handler for the #GtkText::cut-clipboard signal. The + * @cut_clipboard: Class handler for the `GtkText::cut-clipboard` signal. The * default implementation cuts the selection, if one exists. - * @copy_clipboard: Class handler for the #GtkText::copy-clipboard signal. The + * @copy_clipboard: Class handler for the `GtkText::copy-clipboard` signal. The * default implementation copies the selection, if one exists. - * @paste_clipboard: Class handler for the #GtkText::paste-clipboard signal. + * @paste_clipboard: Class handler for the `GtkText::paste-clipboard` signal. * The default implementation pastes at the current cursor position or over * the current selection if one exists. - * @toggle_overwrite: Class handler for the #GtkText::toggle-overwrite signal. + * @toggle_overwrite: Class handler for the `GtkText::toggle-overwrite` signal. * The default implementation toggles overwrite mode and blinks the cursor. - * @insert_emoji: Class handler for the #GtkText::insert-emoji signal. + * @insert_emoji: Class handler for the `GtkText::insert-emoji` signal. * - * Class structure for #GtkText. All virtual functions have a default + * Class structure for `GtkText`. All virtual functions have a default * implementation. Derived classes may set the virtual function pointers for the * signal handlers to %NULL, but must keep @get_text_area_size and * @get_frame_size non-%NULL; either use the default implementation, or provide diff --git a/gtk/gtktextutil.c b/gtk/gtktextutil.c index 83f45a8e13..24dcc7f8b5 100644 --- a/gtk/gtktextutil.c +++ b/gtk/gtktextutil.c @@ -90,13 +90,13 @@ limit_layout_lines (PangoLayout *layout) /** * gtk_text_util_create_drag_icon: - * @widget: #GtkWidget to extract the pango context + * @widget: `GtkWidget` to extract the pango context * @text: a #char to render the icon * @len: length of @text, or -1 for NUL-terminated text * * Creates a drag and drop icon from @text. * - * Returns: (transfer full): a #GdkPaintable to use as DND icon + * Returns: (transfer full): a `GdkPaintable` to use as DND icon */ GdkPaintable * gtk_text_util_create_drag_icon (GtkWidget *widget, @@ -309,7 +309,7 @@ layout_get_char_width (PangoLayout *layout) /* * _gtk_text_util_get_block_cursor_location - * @layout: a #PangoLayout + * @layout: a `PangoLayout` * @index: index at which cursor is located * @pos: cursor location * @at_line_end: whether cursor is drawn at line end, not over some diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c index d15c020d14..7c2431042f 100644 --- a/gtk/gtktextview.c +++ b/gtk/gtktextview.c @@ -93,7 +93,7 @@ * * ## Accessibility * - * `GtkTextView` uses the #GTK_ACCESSIBLE_ROLE_TEXT_BOX role. + * `GtkTextView` uses the %GTK_ACCESSIBLE_ROLE_TEXT_BOX role. */ /* How scrolling, validation, exposes, etc. work. @@ -1165,7 +1165,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass) /** * GtkTextView::move-cursor: * @text_view: the object which received the signal - * @step: the granularity of the move, as a #GtkMovementStep + * @step: the granularity of the move, as a `GtkMovementStep` * @count: the number of @step units to move * @extend_selection: %TRUE if the move should extend the selection * @@ -1211,7 +1211,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass) /** * GtkTextView::move-viewport: * @text_view: the object which received the signal - * @step: the granularity of the movement, as a #GtkScrollStep + * @step: the granularity of the movement, as a `GtkScrollStep` * @count: the number of @step units to move * * Gets emitted to move the viewport. @@ -1284,7 +1284,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass) /** * GtkTextView::delete-from-cursor: * @text_view: the object which received the signal - * @type: the granularity of the deletion, as a #GtkDeleteType + * @type: the granularity of the deletion, as a `GtkDeleteType` * @count: the number of @type units to delete * * Gets emitted when the user initiates a text deletion. @@ -3697,7 +3697,7 @@ gtk_text_view_get_indent (GtkTextView *text_view) /** * gtk_text_view_set_tabs: (attributes org.gtk.Method.set_property=tabs) * @text_view: a `GtkTextView` - * @tabs: tabs as a #PangoTabArray + * @tabs: tabs as a `PangoTabArray` * * Sets the default tab stops for paragraphs in @text_view. * @@ -9208,7 +9208,7 @@ text_window_get_height (GtkTextWindow *win) /** * gtk_text_view_buffer_to_window_coords: * @text_view: a `GtkTextView` - * @win: a #GtkTextWindowType + * @win: a `GtkTextWindowType` * @buffer_x: buffer x coordinate * @buffer_y: buffer y coordinate * @window_x: (out) (optional): window x coordinate return location @@ -9271,7 +9271,7 @@ gtk_text_view_buffer_to_window_coords (GtkTextView *text_view, /** * gtk_text_view_window_to_buffer_coords: * @text_view: a `GtkTextView` - * @win: a #GtkTextWindowType + * @win: a `GtkTextWindowType` * @window_x: window x coordinate * @window_y: window y coordinate * @buffer_x: (out) (optional): buffer x coordinate return location @@ -9434,7 +9434,7 @@ ensure_child (GtkTextView *text_view, /** * gtk_text_view_add_overlay: * @text_view: a `GtkTextView` - * @child: a #GtkWidget + * @child: a `GtkWidget` * @xpos: X position of child in window coordinates * @ypos: Y position of child in window coordinates * @@ -9447,7 +9447,7 @@ ensure_child (GtkTextView *text_view, * @child will scroll with the text view. * * If instead you want a widget that will not move with the - * `GtkTextView` contents see #GtkOverlay. + * `GtkTextView` contents see `GtkOverlay`. */ void gtk_text_view_add_overlay (GtkTextView *text_view, diff --git a/gtk/gtktextview.h b/gtk/gtktextview.h index 1c18d087b5..2b412e6500 100644 --- a/gtk/gtktextview.h +++ b/gtk/gtktextview.h @@ -51,7 +51,7 @@ G_BEGIN_DECLS * @GTK_TEXT_WINDOW_TOP: Top border window. * @GTK_TEXT_WINDOW_BOTTOM: Bottom border window. * - * Used to reference the parts of #GtkTextView. + * Used to reference the parts of `GtkTextView`. */ typedef enum { @@ -68,7 +68,7 @@ typedef enum * @GTK_TEXT_VIEW_LAYER_BELOW_TEXT: The layer rendered below the text (but above the background). * @GTK_TEXT_VIEW_LAYER_ABOVE_TEXT: The layer rendered above the text. * - * Used to reference the layers of #GtkTextView for the purpose of customized + * Used to reference the layers of `GtkTextView` for the purpose of customized * drawing with the ::snapshot_layer vfunc. */ typedef enum @@ -85,7 +85,7 @@ typedef enum * a triple-click for example. * * Granularity types that extend the text selection. Use the - * #GtkTextView::extend-selection signal to customize the selection. + * `GtkTextView::extend-selection` signal to customize the selection. */ typedef enum { @@ -117,25 +117,25 @@ struct _GtkTextView /** * GtkTextViewClass: * @parent_class: The object class structure needs to be the first - * @move_cursor: The class handler for the #GtkTextView::move-cursor + * @move_cursor: The class handler for the `GtkTextView::move-cursor` * keybinding signal. - * @set_anchor: The class handler for the #GtkTextView::set-anchor + * @set_anchor: The class handler for the `GtkTextView::set-anchor` * keybinding signal. - * @insert_at_cursor: The class handler for the #GtkTextView::insert-at-cursor + * @insert_at_cursor: The class handler for the `GtkTextView::insert-at-cursor` * keybinding signal. - * @delete_from_cursor: The class handler for the #GtkTextView::delete-from-cursor + * @delete_from_cursor: The class handler for the `GtkTextView::delete-from-cursor` * keybinding signal. - * @backspace: The class handler for the #GtkTextView::backspace + * @backspace: The class handler for the `GtkTextView::backspace` * keybinding signal. - * @cut_clipboard: The class handler for the #GtkTextView::cut-clipboard + * @cut_clipboard: The class handler for the `GtkTextView::cut-clipboard` * keybinding signal - * @copy_clipboard: The class handler for the #GtkTextView::copy-clipboard + * @copy_clipboard: The class handler for the `GtkTextView::copy-clipboard` * keybinding signal. - * @paste_clipboard: The class handler for the #GtkTextView::paste-clipboard + * @paste_clipboard: The class handler for the `GtkTextView::paste-clipboard` * keybinding signal. - * @toggle_overwrite: The class handler for the #GtkTextView::toggle-overwrite + * @toggle_overwrite: The class handler for the `GtkTextView::toggle-overwrite` * keybinding signal. - * @create_buffer: The create_buffer vfunc is called to create a #GtkTextBuffer + * @create_buffer: The create_buffer vfunc is called to create a `GtkTextBuffer` * for the text view. The default implementation is to just call * gtk_text_buffer_new(). * @snapshot_layer: The snapshot_layer vfunc is called before and after the text @@ -143,8 +143,8 @@ struct _GtkTextView * in a subclass to draw customized content underneath or above the * text. In the %GTK_TEXT_VIEW_LAYER_BELOW_TEXT and %GTK_TEXT_VIEW_LAYER_ABOVE_TEXT * layers the drawing is done in the buffer coordinate space. - * @extend_selection: The class handler for the #GtkTextView::extend-selection signal. - * @insert_emoji: The class handler for the #GtkTextView::insert-emoji signal. + * @extend_selection: The class handler for the `GtkTextView::extend-selection` signal. + * @insert_emoji: The class handler for the `GtkTextView::insert-emoji` signal. */ struct _GtkTextViewClass { diff --git a/gtk/gtktextviewchild.c b/gtk/gtktextviewchild.c index a44a9e786b..80170f99a2 100644 --- a/gtk/gtktextviewchild.c +++ b/gtk/gtktextviewchild.c @@ -378,8 +378,8 @@ gtk_text_view_child_class_init (GtkTextViewChildClass *klass) /** * GtkTextViewChild:window-type: * - * The "window-type" property is the #GtkTextWindowType of the - * #GtkTextView that the child is attached. + * The "window-type" property is the `GtkTextWindowType` of the + * `GtkTextView` that the child is attached. */ properties[PROP_WINDOW_TYPE] = g_param_spec_enum ("window-type", diff --git a/gtk/gtktooltip.c b/gtk/gtktooltip.c index 62fd6b6c13..9836eb0331 100644 --- a/gtk/gtktooltip.c +++ b/gtk/gtktooltip.c @@ -240,8 +240,8 @@ gtk_tooltip_set_text (GtkTooltip *tooltip, /** * gtk_tooltip_set_icon: - * @tooltip: a #GtkTooltip - * @paintable: (nullable): a #GdkPaintable + * @tooltip: a `GtkTooltip` + * @paintable: (nullable): a `GdkPaintable` * * Sets the icon of the tooltip (which is in front of the text) to be * @paintable. If @paintable is %NULL, the image will be hidden. @@ -258,7 +258,7 @@ gtk_tooltip_set_icon (GtkTooltip *tooltip, /** * gtk_tooltip_set_icon_from_icon_name: - * @tooltip: a #GtkTooltip + * @tooltip: a `GtkTooltip` * @icon_name: (nullable): an icon name * * Sets the icon of the tooltip (which is in front of the text) to be @@ -277,8 +277,8 @@ gtk_tooltip_set_icon_from_icon_name (GtkTooltip *tooltip, /** * gtk_tooltip_set_icon_from_gicon: - * @tooltip: a #GtkTooltip - * @gicon: (nullable): a #GIcon representing the icon + * @tooltip: a `GtkTooltip` + * @gicon: (nullable): a `GIcon` representing the icon * * Sets the icon of the tooltip (which is in front of the text) * to be the icon indicated by @gicon with the size indicated @@ -296,13 +296,13 @@ gtk_tooltip_set_icon_from_gicon (GtkTooltip *tooltip, /** * gtk_tooltip_set_custom: - * @tooltip: a #GtkTooltip - * @custom_widget: (nullable): a #GtkWidget, or %NULL to unset the old custom widget. + * @tooltip: a `GtkTooltip` + * @custom_widget: (nullable): a `GtkWidget`, or %NULL to unset the old custom widget. * * Replaces the widget packed into the tooltip with * @custom_widget. @custom_widget does not get destroyed when the tooltip goes * away. - * By default a box with a #GtkImage and #GtkLabel is embedded in + * By default a box with a `GtkImage` and `GtkLabel` is embedded in * the tooltip, which can be configured using gtk_tooltip_set_markup() * and gtk_tooltip_set_icon(). */ @@ -323,15 +323,15 @@ gtk_tooltip_set_custom (GtkTooltip *tooltip, /** * gtk_tooltip_set_tip_area: - * @tooltip: a #GtkTooltip - * @rect: a #GdkRectangle + * @tooltip: a `GtkTooltip` + * @rect: a `GdkRectangle` * * Sets the area of the widget, where the contents of this tooltip apply, * to be @rect (in widget coordinates). This is especially useful for - * properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews, + * properly setting tooltips on `GtkTreeView` rows and cells, `GtkIconViews`, * etc. * - * For setting tooltips on #GtkTreeView, please refer to the convenience + * For setting tooltips on `GtkTreeView`, please refer to the convenience * functions for this: gtk_tree_view_set_tooltip_row() and * gtk_tree_view_set_tooltip_cell(). */ @@ -352,7 +352,7 @@ gtk_tooltip_set_tip_area (GtkTooltip *tooltip, /* * gtk_tooltip_trigger_tooltip_query: - * @display: a #GdkDisplay + * @display: a `GdkDisplay` * * Triggers a new tooltip query on @display, in order to update the current * visible tooltip, or to show/hide the current tooltip. This function is diff --git a/gtk/gtktrashmonitor.c b/gtk/gtktrashmonitor.c index a0788083a6..1a39ce1871 100644 --- a/gtk/gtktrashmonitor.c +++ b/gtk/gtktrashmonitor.c @@ -228,7 +228,7 @@ _gtk_trash_monitor_init (GtkTrashMonitor *monitor) * _gtk_trash_monitor_get: * * Returns: (transfer full): a new reference to the singleton - * #GtkTrashMonitor object. Be sure to call g_object_unref() on it when you are + * GtkTrashMonitor object. Be sure to call g_object_unref() on it when you are * done with the trash monitor. */ GtkTrashMonitor * @@ -249,9 +249,9 @@ _gtk_trash_monitor_get (void) /* * _gtk_trash_monitor_get_icon: - * @monitor: a #GtkTrashMonitor + * @monitor: a GtkTrashMonitor * - * Returns: (transfer full): the #GIcon that should be used to represent + * Returns: (transfer full): the GIcon that should be used to represent * the state of the trash folder on screen, based on whether there is trash or * not. */ @@ -272,7 +272,7 @@ _gtk_trash_monitor_get_icon (GtkTrashMonitor *monitor) /* * _gtk_trash_monitor_get_has_trash: - * @monitor: a #GtkTrashMonitor + * @monitor: a GtkTrashMonitor * * Returns: #TRUE if there is trash in the trash:/// folder, or #FALSE otherwise. */ diff --git a/gtk/gtktreednd.c b/gtk/gtktreednd.c index 4d1b8fc58e..5f29a4e616 100644 --- a/gtk/gtktreednd.c +++ b/gtk/gtktreednd.c @@ -41,7 +41,7 @@ * On the other hand, if you write to the high-level API, then all the * bookkeeping of rows is done for you, as well as things like hover-to-open * and auto-scroll, but your models have to implement the - * #GtkTreeDragSource and #GtkTreeDragDest interfaces. + * `GtkTreeDragSource` and `GtkTreeDragDest` interfaces. */ /** @@ -113,10 +113,10 @@ gtk_tree_drag_dest_get_type (void) /** * gtk_tree_drag_source_row_draggable: - * @drag_source: a #GtkTreeDragSource + * @drag_source: a `GtkTreeDragSource` * @path: row on which user is initiating a drag * - * Asks the #GtkTreeDragSource whether a particular row can be used as + * Asks the `GtkTreeDragSource` whether a particular row can be used as * the source of a DND operation. If the source doesn’t implement * this interface, the row is assumed draggable. * @@ -142,10 +142,10 @@ gtk_tree_drag_source_row_draggable (GtkTreeDragSource *drag_source, /** * gtk_tree_drag_source_drag_data_delete: - * @drag_source: a #GtkTreeDragSource + * @drag_source: a `GtkTreeDragSource` * @path: row that was being dragged * - * Asks the #GtkTreeDragSource to delete the row at @path, because + * Asks the `GtkTreeDragSource` to delete the row at @path, because * it was moved somewhere else via drag-and-drop. Returns %FALSE * if the deletion fails because @path no longer exists, or for * some model-specific reason. Should robustly handle a @path no @@ -167,14 +167,14 @@ gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source, /** * gtk_tree_drag_source_drag_data_get: - * @drag_source: a #GtkTreeDragSource + * @drag_source: a `GtkTreeDragSource` * @path: row that was dragged * - * Asks the #GtkTreeDragSource to return a #GdkContentProvider representing + * Asks the `GtkTreeDragSource` to return a `GdkContentProvider` representing * the row at @path. Should robustly handle a @path no * longer found in the model! * - * Returns: (nullable) (transfer full): a #GdkContentProvider for the + * Returns: (nullable) (transfer full): a `GdkContentProvider` for the * given @path **/ GdkContentProvider * @@ -191,11 +191,11 @@ gtk_tree_drag_source_drag_data_get (GtkTreeDragSource *drag_source, /** * gtk_tree_drag_dest_drag_data_received: - * @drag_dest: a #GtkTreeDragDest + * @drag_dest: a `GtkTreeDragDest` * @dest: row to drop in front of * @value: data to drop * - * Asks the #GtkTreeDragDest to insert a row before the path @dest, + * Asks the `GtkTreeDragDest` to insert a row before the path @dest, * deriving the contents of the row from @value. If @dest is * outside the tree so that inserting before it is impossible, %FALSE * will be returned. Also, %FALSE may be returned if the new row is @@ -221,7 +221,7 @@ gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest *drag_dest, /** * gtk_tree_drag_dest_row_drop_possible: - * @drag_dest: a #GtkTreeDragDest + * @drag_dest: a `GtkTreeDragDest` * @dest_path: destination row * @value: the data being dropped * @@ -268,12 +268,12 @@ G_DEFINE_BOXED_TYPE (GtkTreeRowData, gtk_tree_row_data, /** * gtk_tree_create_row_drag_content: - * @tree_model: a #GtkTreeModel + * @tree_model: a `GtkTreeModel` * @path: a row in @tree_model * * Creates a content provider for dragging @path from @tree_model. * - * Returns: (transfer full): a new #GdkContentProvider + * Returns: (transfer full): a new `GdkContentProvider` */ GdkContentProvider * gtk_tree_create_row_drag_content (GtkTreeModel *tree_model, @@ -313,8 +313,8 @@ gtk_tree_create_row_drag_content (GtkTreeModel *tree_model, /** * gtk_tree_get_row_drag_data: - * @value: a #GValue - * @tree_model: (nullable) (optional) (transfer none) (out): a #GtkTreeModel + * @value: a `GValue` + * @tree_model: (nullable) (optional) (transfer none) (out): a `GtkTreeModel` * @path: (nullable) (optional) (out): row in @tree_model * * Obtains a @tree_model and @path from value of target type diff --git a/gtk/gtktreednd.h b/gtk/gtktreednd.h index d63b35fa61..df4dacf188 100644 --- a/gtk/gtktreednd.h +++ b/gtk/gtktreednd.h @@ -28,7 +28,7 @@ G_BEGIN_DECLS /** * GTK_TYPE_TREE_ROW_DATA: - * Magic #GType to use when dragging rows in a #GtkTreeModel. + * Magic `GType` to use when dragging rows in a `GtkTreeModel`. * * Data in this format will be provided by gtk_tree_create_row_drag_content() * and can be consumed via gtk_tree_get_row_drag_data(). @@ -48,11 +48,11 @@ typedef struct _GtkTreeDragSourceIface GtkTreeDragSourceIface; /** * GtkTreeDragSourceIface: - * @row_draggable: Asks the #GtkTreeDragSource whether a particular + * @row_draggable: Asks the `GtkTreeDragSource` whether a particular * row can be used as the source of a DND operation. - * @drag_data_get: Asks the #GtkTreeDragSource to fill in + * @drag_data_get: Asks the `GtkTreeDragSource` to fill in * selection_data with a representation of the row at path. - * @drag_data_delete: Asks the #GtkTreeDragSource to delete the row at + * @drag_data_delete: Asks the `GtkTreeDragSource` to delete the row at * path, because it was moved somewhere else via drag-and-drop. */ struct _GtkTreeDragSourceIface @@ -105,7 +105,7 @@ typedef struct _GtkTreeDragDestIface GtkTreeDragDestIface; /** * GtkTreeDragDestIface: - * @drag_data_received: Asks the #GtkTreeDragDest to insert a row + * @drag_data_received: Asks the `GtkTreeDragDest` to insert a row * before the path dest, deriving the contents of the row from * selection_data. * @row_drop_possible: Determines whether a drop is possible before diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c index 77741dc7b2..fff7d836f0 100644 --- a/gtk/gtktreemodel.c +++ b/gtk/gtktreemodel.c @@ -32,17 +32,17 @@ * * The tree interface used by GtkTreeView * - * The #GtkTreeModel interface defines a generic tree interface for - * use by the #GtkTreeView widget. It is an abstract interface, and + * The `GtkTreeModel` interface defines a generic tree interface for + * use by the `GtkTreeView` widget. It is an abstract interface, and * is designed to be usable with any appropriate data structure. The * programmer just has to implement this interface on their own data - * type for it to be viewable by a #GtkTreeView widget. + * type for it to be viewable by a `GtkTreeView` widget. * * The model is represented as a hierarchical tree of strongly-typed, * columned data. In other words, the model can be seen as a tree where * every node has different values depending on which column is being * queried. The type of data found in a column is determined by using - * the GType system (ie. #G_TYPE_INT, #GTK_TYPE_BUTTON, #G_TYPE_POINTER, + * the GType system (ie. %G_TYPE_INT, %GTK_TYPE_BUTTON, %G_TYPE_POINTER, * etc). The types are homogeneous per column across all nodes. It is * important to note that this interface only provides a way of examining * a model and observing changes. The implementation of each individual @@ -50,7 +50,7 @@ * * In order to make life simpler for programmers who do not need to * write their own specialized model, two generic models are provided - * — the #GtkTreeStore and the #GtkListStore. To use these, the + * — the `GtkTreeStore` and the `GtkListStore`. To use these, the * developer simply pushes data into these models as necessary. These * models provide the data structure as well as all appropriate tree * interfaces. As a result, implementing drag and drop, sorting, and @@ -79,14 +79,14 @@ * way. One can convert a path to an iterator by calling * gtk_tree_model_get_iter(). These iterators are the primary way * of accessing a model and are similar to the iterators used by - * #GtkTextBuffer. They are generally statically allocated on the + * `GtkTextBuffer`. They are generally statically allocated on the * stack and only used for a short time. The model interface defines * a set of operations using them for navigating the model. * * It is expected that models fill in the iterator with private data. - * For example, the #GtkListStore model, which is internally a simple + * For example, the `GtkListStore` model, which is internally a simple * linked list, stores a list node in one of the pointers. The - * #GtkTreeModelSort stores an array and an offset in two of the + * `GtkTreeModel`Sort stores an array and an offset in two of the * pointers. Additionally, there is an integer field. This field is * generally filled with a unique stamp per model. This stamp is for * catching errors resulting from using invalid iterators with a model. @@ -97,11 +97,11 @@ * to own all outstanding iterators and nothing needs to be done to * free them from the user’s point of view. Additionally, some models * guarantee that an iterator is valid for as long as the node it refers - * to is valid (most notably the #GtkTreeStore and #GtkListStore). + * to is valid (most notably the `GtkTreeStore` and `GtkListStore`). * Although generally uninteresting, as one always has to allow for * the case where iterators do not persist beyond a signal, some very * important performance enhancements were made in the sort model. - * As a result, the #GTK_TREE_MODEL_ITERS_PERSIST flag was added to + * As a result, the %GTK_TREE_MODEL_ITERS_PERSIST flag was added to * indicate this behavior. * * To help show some common operation of a model, some examples are @@ -142,8 +142,8 @@ * This second example shows a quick way of iterating through a list * and getting a string and an integer from each row. The * populate_model() function used below is not - * shown, as it is specific to the #GtkListStore. For information on - * how to write such a function, see the #GtkListStore documentation. + * shown, as it is specific to the `GtkListStore`. For information on + * how to write such a function, see the `GtkListStore` documentation. * * ## Reading data from a `GtkTreeModel` * @@ -197,11 +197,11 @@ * } * ``` * - * The #GtkTreeModel interface contains two methods for reference + * The `GtkTreeModel` interface contains two methods for reference * counting: gtk_tree_model_ref_node() and gtk_tree_model_unref_node(). * These two methods are optional to implement. The reference counting * is meant as a way for views to let models know when nodes are being - * displayed. #GtkTreeView will take a reference on a node when it is + * displayed. `GtkTreeView` will take a reference on a node when it is * visible, which means the node is either in the toplevel or expanded. * Being displayed does not mean that the node is currently directly * visible to the user in the viewport. Based on this reference counting @@ -351,9 +351,9 @@ gtk_tree_model_base_init (gpointer g_class) /** * GtkTreeModel::row-changed: - * @tree_model: the #GtkTreeModel on which the signal is emitted - * @path: a #GtkTreePath-struct identifying the changed row - * @iter: a valid #GtkTreeIter-struct pointing to the changed row + * @tree_model: the `GtkTreeModel` on which the signal is emitted + * @path: a `GtkTreePath` identifying the changed row + * @iter: a valid `GtkTreeIter` pointing to the changed row * * This signal is emitted when a row in the model has changed. */ @@ -386,9 +386,9 @@ gtk_tree_model_base_init (gpointer g_class) /** * GtkTreeModel::row-inserted: - * @tree_model: the #GtkTreeModel on which the signal is emitted - * @path: a #GtkTreePath-struct identifying the new row - * @iter: a valid #GtkTreeIter-struct pointing to the new row + * @tree_model: the `GtkTreeModel` on which the signal is emitted + * @path: a `GtkTreePath` identifying the new row + * @iter: a valid `GtkTreeIter` pointing to the new row * * This signal is emitted when a new row has been inserted in * the model. @@ -414,9 +414,9 @@ gtk_tree_model_base_init (gpointer g_class) /** * GtkTreeModel::row-has-child-toggled: - * @tree_model: the #GtkTreeModel on which the signal is emitted - * @path: a #GtkTreePath-struct identifying the row - * @iter: a valid #GtkTreeIter-struct pointing to the row + * @tree_model: the `GtkTreeModel` on which the signal is emitted + * @path: a `GtkTreePath` identifying the row + * @iter: a valid `GtkTreeIter` pointing to the row * * This signal is emitted when a row has gotten the first child * row or lost its last child row. @@ -437,8 +437,8 @@ gtk_tree_model_base_init (gpointer g_class) /** * GtkTreeModel::row-deleted: - * @tree_model: the #GtkTreeModel on which the signal is emitted - * @path: a #GtkTreePath-struct identifying the row + * @tree_model: the `GtkTreeModel` on which the signal is emitted + * @path: a `GtkTreePath` identifying the row * * This signal is emitted when a row has been deleted. * @@ -463,17 +463,17 @@ gtk_tree_model_base_init (gpointer g_class) /** * GtkTreeModel::rows-reordered: (skip) - * @tree_model: the #GtkTreeModel on which the signal is emitted - * @path: a #GtkTreePath-struct identifying the tree node whose children + * @tree_model: the `GtkTreeModel` on which the signal is emitted + * @path: a `GtkTreePath` identifying the tree node whose children * have been reordered - * @iter: a valid #GtkTreeIter-struct pointing to the node whose children + * @iter: a valid `GtkTreeIter` pointing to the node whose children * have been reordered, or %NULL if the depth of @path is 0 * @new_order: an array of integers mapping the current position * of each child to its old position before the re-ordering, * i.e. @new_order`[newpos] = oldpos` * * This signal is emitted when the children of a node in the - * #GtkTreeModel have been reordered. + * `GtkTreeModel` have been reordered. * * Note that this signal is not emitted * when rows are reordered by DND, since this is implemented @@ -596,10 +596,10 @@ rows_reordered_marshal (GClosure *closure, /** * gtk_tree_path_new: * - * Creates a new #GtkTreePath-struct. + * Creates a new `GtkTreePath` * This refers to a row. * - * Returns: A newly created #GtkTreePath-struct. + * Returns: A newly created `GtkTreePath`. */ GtkTreePath * gtk_tree_path_new (void) @@ -617,7 +617,7 @@ gtk_tree_path_new (void) * gtk_tree_path_new_from_string: * @path: The string representation of a path * - * Creates a new #GtkTreePath-struct initialized to @path. + * Creates a new `GtkTreePath` initialized to @path. * * @path is expected to be a colon separated list of numbers. * For example, the string “10:4:0” would create a path of depth @@ -625,7 +625,7 @@ gtk_tree_path_new (void) * child of that 11th child, and the 1st child of that 5th child. * If an invalid path string is passed in, %NULL is returned. * - * Returns: (nullable): A newly-created #GtkTreePath + * Returns: (nullable): A newly-created `GtkTreePath` */ GtkTreePath * gtk_tree_path_new_from_string (const char *path) @@ -673,7 +673,7 @@ gtk_tree_path_new_from_string (const char *path) * * Creates a new path with @first_index and @varargs as indices. * - * Returns: A newly created #GtkTreePath-struct + * Returns: A newly created `GtkTreePath` */ GtkTreePath * gtk_tree_path_new_from_indices (int first_index, @@ -706,7 +706,7 @@ gtk_tree_path_new_from_indices (int first_index, * * Creates a new path with the given @indices array of @length. * - * Returns: A newly created #GtkTreePath-struct + * Returns: A newly created `GtkTreePath` */ GtkTreePath * gtk_tree_path_new_from_indicesv (int *indices, @@ -769,11 +769,11 @@ gtk_tree_path_to_string (GtkTreePath *path) /** * gtk_tree_path_new_first: * - * Creates a new #GtkTreePath-struct. + * Creates a new `GtkTreePath`. * * The string representation of this path is “0”. * - * Returns: A new #GtkTreePath-struct + * Returns: A new `GtkTreePath` */ GtkTreePath * gtk_tree_path_new_first (void) @@ -788,7 +788,7 @@ gtk_tree_path_new_first (void) /** * gtk_tree_path_append_index: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * @index_: the index * * Appends a new index to a path. @@ -814,7 +814,7 @@ gtk_tree_path_append_index (GtkTreePath *path, /** * gtk_tree_path_prepend_index: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * @index_: the index * * Prepends a new index to a path. @@ -843,7 +843,7 @@ gtk_tree_path_prepend_index (GtkTreePath *path, /** * gtk_tree_path_get_depth: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * * Returns the current depth of @path. * @@ -859,7 +859,7 @@ gtk_tree_path_get_depth (GtkTreePath *path) /** * gtk_tree_path_get_indices: (skip) - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * * Returns the current indices of @path. * @@ -907,7 +907,7 @@ gtk_tree_path_get_indices_with_depth (GtkTreePath *path, /** * gtk_tree_path_free: - * @path: (nullable): a #GtkTreePath-struct + * @path: (nullable): a `GtkTreePath` * * Frees @path. If @path is %NULL, it simply returns. */ @@ -923,11 +923,11 @@ gtk_tree_path_free (GtkTreePath *path) /** * gtk_tree_path_copy: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * - * Creates a new #GtkTreePath-struct as a copy of @path. + * Creates a new `GtkTreePath` as a copy of @path. * - * Returns: a new #GtkTreePath-struct + * Returns: a new `GtkTreePath` */ GtkTreePath * gtk_tree_path_copy (const GtkTreePath *path) @@ -950,8 +950,8 @@ G_DEFINE_BOXED_TYPE (GtkTreePath, gtk_tree_path, /** * gtk_tree_path_compare: - * @a: a #GtkTreePath-struct - * @b: a #GtkTreePath-struct to compare with + * @a: a `GtkTreePath` + * @b: a `GtkTreePath` to compare with * * Compares two paths. * @@ -986,8 +986,8 @@ gtk_tree_path_compare (const GtkTreePath *a, /** * gtk_tree_path_is_ancestor: - * @path: a #GtkTreePath-struct - * @descendant: another #GtkTreePath-struct + * @path: a `GtkTreePath` + * @descendant: another `GtkTreePath` * * Returns %TRUE if @descendant is a descendant of @path. * @@ -1019,8 +1019,8 @@ gtk_tree_path_is_ancestor (GtkTreePath *path, /** * gtk_tree_path_is_descendant: - * @path: a #GtkTreePath-struct - * @ancestor: another #GtkTreePath-struct + * @path: a `GtkTreePath` + * @ancestor: another `GtkTreePath` * * Returns %TRUE if @path is a descendant of @ancestor. * @@ -1053,7 +1053,7 @@ gtk_tree_path_is_descendant (GtkTreePath *path, /** * gtk_tree_path_next: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * * Moves the @path to point to the next node at the current depth. */ @@ -1068,7 +1068,7 @@ gtk_tree_path_next (GtkTreePath *path) /** * gtk_tree_path_prev: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * * Moves the @path to point to the previous node at the * current depth, if it exists. @@ -1094,7 +1094,7 @@ gtk_tree_path_prev (GtkTreePath *path) /** * gtk_tree_path_up: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * * Moves the @path to point to its parent node, if it has a parent. * @@ -1115,7 +1115,7 @@ gtk_tree_path_up (GtkTreePath *path) /** * gtk_tree_path_down: - * @path: a #GtkTreePath-struct + * @path: a `GtkTreePath` * * Moves @path to point to the first child of the current path. */ @@ -1129,7 +1129,7 @@ gtk_tree_path_down (GtkTreePath *path) /** * gtk_tree_iter_copy: - * @iter: a #GtkTreeIter-struct + * @iter: a `GtkTreeIter` * * Creates a dynamically allocated tree iterator as a copy of @iter. * @@ -1175,11 +1175,11 @@ G_DEFINE_BOXED_TYPE (GtkTreeIter, gtk_tree_iter, /** * gtk_tree_model_get_flags: - * @tree_model: a #GtkTreeModel + * @tree_model: a `GtkTreeModel` * * Returns a set of flags supported by this interface. * - * The flags are a bitwise combination of #GtkTreeModelFlags. + * The flags are a bitwise combination of `GtkTreeModel`Flags. * The flags supported should not change during the lifetime * of the @tree_model. * @@ -1201,7 +1201,7 @@ gtk_tree_model_get_flags (GtkTreeModel *tree_model) /** * gtk_tree_model_get_n_columns: - * @tree_model: a #GtkTreeModel + * @tree_model: a `GtkTreeModel` * * Returns the number of columns supported by @tree_model. * @@ -1221,7 +1221,7 @@ gtk_tree_model_get_n_columns (GtkTreeModel *tree_model) /** * gtk_tree_model_get_column_type: - * @tree_model: a #GtkTreeModel + * @tree_model: a `GtkTreeModel` * @index_: the column index * * Returns the type of the column. @@ -1245,9 +1245,9 @@ gtk_tree_model_get_column_type (GtkTreeModel *tree_model, /** * gtk_tree_model_get_iter: - * @tree_model: a #GtkTreeModel - * @iter: (out): the uninitialized #GtkTreeIter-struct - * @path: the #GtkTreePath-struct + * @tree_model: a `GtkTreeModel` + * @iter: (out): the uninitialized `GtkTreeIter` + * @path: the `GtkTreePath` * * Sets @iter to a valid iterator pointing to @path. If @path does * not exist, @iter is set to an invalid iterator and %FALSE is returned. @@ -1276,9 +1276,9 @@ gtk_tree_model_get_iter (GtkTreeModel *tree_model, /** * gtk_tree_model_get_iter_from_string: - * @tree_model: a #GtkTreeModel - * @iter: (out): an uninitialized #GtkTreeIter-struct - * @path_string: a string representation of a #GtkTreePath-struct + * @tree_model: a `GtkTreeModel` + * @iter: (out): an uninitialized `GtkTreeIter` + * @path_string: a string representation of a `GtkTreePath` * * Sets @iter to a valid iterator pointing to @path_string, if it * exists. Otherwise, @iter is left invalid and %FALSE is returned. @@ -1342,8 +1342,8 @@ gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model, /** * gtk_tree_model_get_iter_first: - * @tree_model: a #GtkTreeModel - * @iter: (out): the uninitialized #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: (out): the uninitialized `GtkTreeIter` * * Initializes @iter with the first iterator in the tree * (the one at the path "0") and returns %TRUE. Returns @@ -1370,14 +1370,14 @@ gtk_tree_model_get_iter_first (GtkTreeModel *tree_model, /** * gtk_tree_model_get_path: - * @tree_model: a #GtkTreeModel - * @iter: the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: the `GtkTreeIter` * - * Returns a newly-created #GtkTreePath-struct referenced by @iter. + * Returns a newly-created `GtkTreePath` referenced by @iter. * * This path should be freed with gtk_tree_path_free(). * - * Returns: a newly-created #GtkTreePath-struct + * Returns: a newly-created `GtkTreePath` */ GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model, @@ -1396,10 +1396,10 @@ gtk_tree_model_get_path (GtkTreeModel *tree_model, /** * gtk_tree_model_get_value: - * @tree_model: a #GtkTreeModel - * @iter: the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: the `GtkTreeIter` * @column: the column to lookup the value at - * @value: (out) (transfer none): an empty #GValue to set + * @value: (out) (transfer none): an empty `GValue` to set * * Initializes and sets @value to that at @column. * @@ -1426,8 +1426,8 @@ gtk_tree_model_get_value (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_next: - * @tree_model: a #GtkTreeModel - * @iter: (in): the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: (in): the `GtkTreeIter` * * Sets @iter to point to the node following it at the current level. * @@ -1474,8 +1474,8 @@ gtk_tree_model_iter_previous_default (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_previous: - * @tree_model: a #GtkTreeModel - * @iter: (in): the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: (in): the `GtkTreeIter` * * Sets @iter to point to the previous node at the current level. * @@ -1506,9 +1506,9 @@ gtk_tree_model_iter_previous (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_children: - * @tree_model: a #GtkTreeModel - * @iter: (out): the new #GtkTreeIter-struct to be set to the child - * @parent: (nullable): the #GtkTreeIter + * @tree_model: a `GtkTreeModel` + * @iter: (out): the new `GtkTreeIter` to be set to the child + * @parent: (nullable): the `GtkTreeIter` * * Sets @iter to point to the first child of @parent. * @@ -1541,8 +1541,8 @@ gtk_tree_model_iter_children (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_has_child: - * @tree_model: a #GtkTreeModel - * @iter: the #GtkTreeIter-struct to test for children + * @tree_model: a `GtkTreeModel` + * @iter: the `GtkTreeIter` to test for children * * Returns %TRUE if @iter has children, %FALSE otherwise. * @@ -1565,8 +1565,8 @@ gtk_tree_model_iter_has_child (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_n_children: - * @tree_model: a #GtkTreeModel - * @iter: (nullable): the #GtkTreeIter + * @tree_model: a `GtkTreeModel` + * @iter: (nullable): the `GtkTreeIter` * * Returns the number of children that @iter has. * @@ -1591,9 +1591,9 @@ gtk_tree_model_iter_n_children (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_nth_child: - * @tree_model: a #GtkTreeModel - * @iter: (out): the #GtkTreeIter to set to the nth child - * @parent: (nullable): the #GtkTreeIter to get the child from + * @tree_model: a `GtkTreeModel` + * @iter: (out): the `GtkTreeIter` to set to the nth child + * @parent: (nullable): the `GtkTreeIter` to get the child from * @n: the index of the desired child * * Sets @iter to be the child of @parent, using the given index. @@ -1628,9 +1628,9 @@ gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model, /** * gtk_tree_model_iter_parent: - * @tree_model: a #GtkTreeModel - * @iter: (out): the new #GtkTreeIter-struct to set to the parent - * @child: the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: (out): the new `GtkTreeIter` to set to the parent + * @child: the `GtkTreeIter` * * Sets @iter to be the parent of @child. * @@ -1665,8 +1665,8 @@ gtk_tree_model_iter_parent (GtkTreeModel *tree_model, /** * gtk_tree_model_ref_node: - * @tree_model: a #GtkTreeModel - * @iter: the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: the `GtkTreeIter` * * Lets the tree ref the node. * @@ -1701,8 +1701,8 @@ gtk_tree_model_ref_node (GtkTreeModel *tree_model, /** * gtk_tree_model_unref_node: - * @tree_model: a #GtkTreeModel - * @iter: the #GtkTreeIter-struct + * @tree_model: a `GtkTreeModel` + * @iter: the `GtkTreeIter` * * Lets the tree unref the node. * @@ -1764,7 +1764,7 @@ gtk_tree_model_get (GtkTreeModel *tree_model, /** * gtk_tree_model_get_valist: - * @tree_model: a #GtkTreeModel + * @tree_model: a `GtkTreeModel` * @iter: a row in @tree_model * @var_args: va_list of column/return location pairs * @@ -1816,11 +1816,11 @@ gtk_tree_model_get_valist (GtkTreeModel *tree_model, /** * gtk_tree_model_row_changed: - * @tree_model: a #GtkTreeModel - * @path: a #GtkTreePath-struct pointing to the changed row - * @iter: a valid #GtkTreeIter-struct pointing to the changed row + * @tree_model: a `GtkTreeModel` + * @path: a `GtkTreePath` pointing to the changed row + * @iter: a valid `GtkTreeIter` pointing to the changed row * - * Emits the #GtkTreeModel::row-changed signal on @tree_model. + * Emits the `GtkTreeModel::row-changed` signal on @tree_model. */ void gtk_tree_model_row_changed (GtkTreeModel *tree_model, @@ -1836,11 +1836,11 @@ gtk_tree_model_row_changed (GtkTreeModel *tree_model, /** * gtk_tree_model_row_inserted: - * @tree_model: a #GtkTreeModel - * @path: a #GtkTreePath-struct pointing to the inserted row - * @iter: a valid #GtkTreeIter-struct pointing to the inserted row + * @tree_model: a `GtkTreeModel` + * @path: a `GtkTreePath` pointing to the inserted row + * @iter: a valid `GtkTreeIter` pointing to the inserted row * - * Emits the #GtkTreeModel::row-inserted signal on @tree_model. + * Emits the `GtkTreeModel::row-inserted` signal on @tree_model. */ void gtk_tree_model_row_inserted (GtkTreeModel *tree_model, @@ -1856,11 +1856,11 @@ gtk_tree_model_row_inserted (GtkTreeModel *tree_model, /** * gtk_tree_model_row_has_child_toggled: - * @tree_model: a #GtkTreeModel - * @path: a #GtkTreePath-struct pointing to the changed row - * @iter: a valid #GtkTreeIter-struct pointing to the changed row + * @tree_model: a `GtkTreeModel` + * @path: a `GtkTreePath` pointing to the changed row + * @iter: a valid `GtkTreeIter` pointing to the changed row * - * Emits the #GtkTreeModel::row-has-child-toggled signal on + * Emits the `GtkTreeModel::row-has-child-toggled` signal on * @tree_model. This should be called by models after the child * state of a node changes. */ @@ -1882,7 +1882,7 @@ gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model, * @path: a `GtkTreePath` pointing to the previous location of * the deleted row * - * Emits the #GtkTreeModel::row-deleted signal on @tree_model. + * Emits the `GtkTreeModel`::row-deleted signal on @tree_model. * * This should be called by models after a row has been removed. * The location pointed to by @path should be the location that @@ -1934,7 +1934,7 @@ gtk_tree_model_rows_reordered (GtkTreeModel *tree_model, * @tree_model: a `GtkTreeModel` * @path: a `GtkTreePath` pointing to the tree node whose children * have been reordered - * @iter: (nullable): a valid #GtkTreeIter-struct pointing to the node + * @iter: (nullable): a valid `GtkTreeIter` pointing to the node * whose children have been reordered, or %NULL if the depth * of @path is 0 * @new_order: (array length=length): an array of integers @@ -2003,7 +2003,7 @@ gtk_tree_model_foreach_helper (GtkTreeModel *model, /** * gtk_tree_model_foreach: - * @model: a #GtkTreeModel + * @model: a `GtkTreeModel` * @func: (scope call): a function to be called on each row * @user_data: (closure): user data to passed to @func * @@ -2277,8 +2277,8 @@ gtk_tree_row_reference_unref_path (GtkTreePath *path, /** * gtk_tree_row_reference_new: - * @model: a #GtkTreeModel - * @path: a valid #GtkTreePath-struct to monitor + * @model: a `GtkTreeModel` + * @path: a valid `GtkTreePath` to monitor * * Creates a row reference based on @path. * @@ -2287,7 +2287,7 @@ gtk_tree_row_reference_unref_path (GtkTreePath *path, * propagated, and the path is updated appropriately. If * @path isn’t a valid path in @model, then %NULL is returned. * - * Returns: (nullable): a newly allocated #GtkTreeRowReference + * Returns: (nullable): a newly allocated `GtkTreeRowReference` */ GtkTreeRowReference * gtk_tree_row_reference_new (GtkTreeModel *model, @@ -2305,9 +2305,9 @@ gtk_tree_row_reference_new (GtkTreeModel *model, /** * gtk_tree_row_reference_new_proxy: - * @proxy: a proxy #GObject - * @model: a #GtkTreeModel - * @path: a valid #GtkTreePath-struct to monitor + * @proxy: a proxy `GObject` + * @model: a `GtkTreeModel` + * @path: a valid `GtkTreePath` to monitor * * You do not need to use this function. * @@ -2325,7 +2325,7 @@ gtk_tree_row_reference_new (GtkTreeModel *model, * These functions must be called exactly once per proxy when the * corresponding signal on the model is emitted. This single call * updates all row references for that proxy. Since built-in GTK - * objects like #GtkTreeView already use this mechanism internally, + * objects like `GtkTreeView` already use this mechanism internally, * using them as the proxy object will produce unpredictable results. * Further more, passing the same object as @model and @proxy * doesn’t work for reasons of internal implementation. @@ -2334,7 +2334,7 @@ gtk_tree_row_reference_new (GtkTreeModel *model, * need to carefully monitor exactly when a row reference updates * itself, and is not generally needed by most applications. * - * Returns: (nullable): a newly allocated #GtkTreeRowReference + * Returns: (nullable): a newly allocated `GtkTreeRowReference` */ GtkTreeRowReference * gtk_tree_row_reference_new_proxy (GObject *proxy, @@ -2395,7 +2395,7 @@ gtk_tree_row_reference_new_proxy (GObject *proxy, /** * gtk_tree_row_reference_get_path: - * @reference: a #GtkTreeRowReference + * @reference: a `GtkTreeRowReference` * * Returns a path that the row reference currently points to, * or %NULL if the path pointed to is no longer valid. @@ -2418,7 +2418,7 @@ gtk_tree_row_reference_get_path (GtkTreeRowReference *reference) /** * gtk_tree_row_reference_get_model: - * @reference: a #GtkTreeRowReference + * @reference: a `GtkTreeRowReference` * * Returns the model that the row reference is monitoring. * @@ -2434,7 +2434,7 @@ gtk_tree_row_reference_get_model (GtkTreeRowReference *reference) /** * gtk_tree_row_reference_valid: - * @reference: (nullable): a #GtkTreeRowReference + * @reference: (nullable): a `GtkTreeRowReference` * * Returns %TRUE if the @reference is non-%NULL and refers to * a current valid path. @@ -2453,9 +2453,9 @@ gtk_tree_row_reference_valid (GtkTreeRowReference *reference) /** * gtk_tree_row_reference_copy: - * @reference: a #GtkTreeRowReference + * @reference: a `GtkTreeRowReference` * - * Copies a #GtkTreeRowReference. + * Copies a `GtkTreeRowReference`. * * Returns: a copy of @reference */ @@ -2469,7 +2469,7 @@ gtk_tree_row_reference_copy (GtkTreeRowReference *reference) /** * gtk_tree_row_reference_free: - * @reference: (nullable): a #GtkTreeRowReference + * @reference: (nullable): a `GtkTreeRowReference` * * Free’s @reference. @reference may be %NULL */ @@ -2511,12 +2511,12 @@ gtk_tree_row_reference_free (GtkTreeRowReference *reference) /** * gtk_tree_row_reference_inserted: - * @proxy: a #GObject + * @proxy: a `GObject` * @path: the row position that was inserted * * Lets a set of row reference created by * gtk_tree_row_reference_new_proxy() know that the - * model emitted the #GtkTreeModel::row-inserted signal. + * model emitted the `GtkTreeModel`::row-inserted signal. */ void gtk_tree_row_reference_inserted (GObject *proxy, @@ -2529,12 +2529,12 @@ gtk_tree_row_reference_inserted (GObject *proxy, /** * gtk_tree_row_reference_deleted: - * @proxy: a #GObject + * @proxy: a `GObject` * @path: the path position that was deleted * * Lets a set of row reference created by * gtk_tree_row_reference_new_proxy() know that the - * model emitted the #GtkTreeModel::row-deleted signal. + * model emitted the `GtkTreeModel`::row-deleted signal. */ void gtk_tree_row_reference_deleted (GObject *proxy, @@ -2547,14 +2547,14 @@ gtk_tree_row_reference_deleted (GObject *proxy, /** * gtk_tree_row_reference_reordered: (skip) - * @proxy: a #GObject + * @proxy: a `GObject` * @path: the parent path of the reordered signal * @iter: the iter pointing to the parent of the reordered * @new_order: (array): the new order of rows * * Lets a set of row reference created by * gtk_tree_row_reference_new_proxy() know that the - * model emitted the #GtkTreeModel::rows-reordered signal. + * model emitted the `GtkTreeModel`::rows-reordered signal. */ void gtk_tree_row_reference_reordered (GObject *proxy, diff --git a/gtk/gtktreemodel.h b/gtk/gtktreemodel.h index d802bdbd77..db862be0e9 100644 --- a/gtk/gtktreemodel.h +++ b/gtk/gtktreemodel.h @@ -44,9 +44,9 @@ typedef struct _GtkTreeModelIface GtkTreeModelIface; /** * GtkTreeModelForeachFunc: - * @model: the #GtkTreeModel being iterated - * @path: the current #GtkTreePath - * @iter: the current #GtkTreeIter + * @model: the `GtkTreeModel` being iterated + * @path: the current `GtkTreePath` + * @iter: the current `GtkTreeIter` * @data: (closure): The user data passed to gtk_tree_model_foreach() * * Type of the callback passed to gtk_tree_model_foreach() to @@ -68,7 +68,7 @@ typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath * * * They are returned by [method@Gtk.TreeModel.get_flags], and must be * static for the lifetime of the object. A more complete description - * of #GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of + * of %GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of * this section. */ typedef enum @@ -84,8 +84,8 @@ typedef enum * @user_data2: model-specific data * @user_data3: model-specific data * - * The #GtkTreeIter is the primary structure - * for accessing a #GtkTreeModel. Models are expected to put a unique + * The `GtkTreeIter` is the primary structure + * for accessing a `GtkTreeModel`. Models are expected to put a unique * integer in the @stamp member, and put * model-specific data in the three @user_data * members. @@ -108,11 +108,11 @@ struct _GtkTreeIter * @row_deleted: Signal emitted when a row has been deleted. * @rows_reordered: Signal emitted when the children of a node in the * GtkTreeModel have been reordered. - * @get_flags: Get #GtkTreeModelFlags supported by this interface. + * @get_flags: Get `GtkTreeModelFlags` supported by this interface. * @get_n_columns: Get the number of columns supported by the model. * @get_column_type: Get the type of the column. * @get_iter: Sets iter to a valid iterator pointing to path. - * @get_path: Gets a newly-created #GtkTreePath referenced by iter. + * @get_path: Gets a newly-created `GtkTreePath` referenced by iter. * @get_value: Initializes and sets value to that at column. * @iter_next: Sets iter to point to the node following it at the * current level. @@ -250,7 +250,7 @@ gboolean gtk_tree_path_is_descendant (GtkTreePath *path, * GtkTreeRowReference: * * A GtkTreeRowReference tracks model changes so that it always refers to the - * same row (a #GtkTreePath refers to a position, not a fixed row). Create a + * same row (a `GtkTreePath` refers to a position, not a fixed row). Create a * new GtkTreeRowReference with gtk_tree_row_reference_new(). */ diff --git a/gtk/gtktreemodelfilter.c b/gtk/gtktreemodelfilter.c index 8bf686488d..68310fc2d5 100644 --- a/gtk/gtktreemodelfilter.c +++ b/gtk/gtktreemodelfilter.c @@ -27,9 +27,9 @@ /** * GtkTreeModelFilter: * - * A GtkTreeModel which hides parts of an underlying tree model + * A `GtkTreeModel` which hides parts of an underlying tree model * - * A #GtkTreeModelFilter is a tree model which wraps another tree model, + * A `GtkTreeModelFilter` is a tree model which wraps another tree model, * and can do the following things: * * - Filter specific rows, based on data from a “visible column”, a column @@ -44,21 +44,21 @@ * on the given child model. * * - Set a different root node, also known as a “virtual root”. You can pass - * in a #GtkTreePath indicating the root node for the filter at construction + * in a `GtkTreePath` indicating the root node for the filter at construction * time. * - * The basic API is similar to #GtkTreeModelSort. For an example on its usage, - * see the section on #GtkTreeModelSort. + * The basic API is similar to `GtkTreeModelSort`. For an example on its usage, + * see the section on `GtkTreeModelSort`. * - * When using #GtkTreeModelFilter, it is important to realize that - * #GtkTreeModelFilter maintains an internal cache of all nodes which are + * When using `GtkTreeModelFilter`, it is important to realize that + * `GtkTreeModelFilter` maintains an internal cache of all nodes which are * visible in its clients. The cache is likely to be a subtree of the tree - * exposed by the child model. #GtkTreeModelFilter will not cache the entire + * exposed by the child model. `GtkTreeModelFilter` will not cache the entire * child model when unnecessary to not compromise the caching mechanism * that is exposed by the reference counting scheme. If the child model * implements reference counting, unnecessary signals may not be emitted - * because of reference counting rule 3, see the #GtkTreeModel - * documentation. (Note that e.g. #GtkTreeStore does not implement + * because of reference counting rule 3, see the `GtkTreeModel` + * documentation. (Note that e.g. `GtkTreeStore` does not implement * reference counting and will always emit all signals, even when * the receiving node is not visible). * @@ -68,29 +68,29 @@ * or its parents. Usually, having a dependency on the state of any child * node is not possible, unless references are taken on these explicitly. * When no such reference exists, no signals may be received for these child - * nodes (see reference counting rule number 3 in the #GtkTreeModel section). + * nodes (see reference counting rule number 3 in the `GtkTreeModel` section). * * Determining the visibility state of a given node based on the state * of its child nodes is a frequently occurring use case. Therefore, - * #GtkTreeModelFilter explicitly supports this. For example, when a node + * `GtkTreeModelFilter` explicitly supports this. For example, when a node * does not have any children, you might not want the node to be visible. * As soon as the first row is added to the node’s child level (or the * last row removed), the node’s visibility should be updated. * * This introduces a dependency from the node on its child nodes. In order - * to accommodate this, #GtkTreeModelFilter must make sure the necessary + * to accommodate this, `GtkTreeModelFilter` must make sure the necessary * signals are received from the child model. This is achieved by building, - * for all nodes which are exposed as visible nodes to #GtkTreeModelFilter's + * for all nodes which are exposed as visible nodes to `GtkTreeModelFilter`'s * clients, the child level (if any) and take a reference on the first node * in this level. Furthermore, for every row-inserted, row-changed or * row-deleted signal (also these which were not handled because the node - * was not cached), #GtkTreeModelFilter will check if the visibility state + * was not cached), `GtkTreeModelFilter` will check if the visibility state * of any parent node has changed. * * Beware, however, that this explicit support is limited to these two * cases. For example, if you want a node to be visible only if two nodes * in a child’s child level (2 levels deeper) are visible, you are on your - * own. In this case, either rely on #GtkTreeStore to emit all signals + * own. In this case, either rely on `GtkTreeStore` to emit all signals * because it does not implement reference counting, or for models that * do implement reference counting, obtain references on these child levels * yourself. @@ -3753,13 +3753,13 @@ gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter, /** * gtk_tree_model_filter_new: - * @child_model: A #GtkTreeModel. - * @root: (nullable): A #GtkTreePath + * @child_model: A `GtkTreeModel`. + * @root: (nullable): A `GtkTreePath` * - * Creates a new #GtkTreeModel, with @child_model as the child_model + * Creates a new `GtkTreeModel`, with @child_model as the child_model * and @root as the virtual root. * - * Returns: (transfer full): A new #GtkTreeModel. + * Returns: (transfer full): A new `GtkTreeModel`. */ GtkTreeModel * gtk_tree_model_filter_new (GtkTreeModel *child_model, @@ -3775,11 +3775,11 @@ gtk_tree_model_filter_new (GtkTreeModel *child_model, /** * gtk_tree_model_filter_get_model: - * @filter: A #GtkTreeModelFilter. + * @filter: A `GtkTreeModelFilter` * * Returns a pointer to the child model of @filter. * - * Returns: (transfer none): A pointer to a #GtkTreeModel. + * Returns: (transfer none): A pointer to a `GtkTreeModel` */ GtkTreeModel * gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter) @@ -3791,8 +3791,8 @@ gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter) /** * gtk_tree_model_filter_set_visible_func: - * @filter: A #GtkTreeModelFilter - * @func: A #GtkTreeModelFilterVisibleFunc, the visible function + * @filter: A `GtkTreeModelFilter` + * @func: A `GtkTreeModelFilterVisibleFunc`, the visible function * @data: (nullable): User data to pass to the visible function * @destroy: (nullable): Destroy notifier of @data * @@ -3851,10 +3851,10 @@ gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter, /** * gtk_tree_model_filter_set_modify_func: - * @filter: A #GtkTreeModelFilter. + * @filter: A `GtkTreeModelFilter` * @n_columns: The number of columns in the filter model. - * @types: (array length=n_columns): The #GTypes of the columns. - * @func: A #GtkTreeModelFilterModifyFunc + * @types: (array length=n_columns): The `GType`s of the columns. + * @func: A `GtkTreeModelFilterModifyFunc` * @data: (nullable): User data to pass to the modify function * @destroy: (nullable): Destroy notifier of @data * @@ -3893,8 +3893,8 @@ gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter, /** * gtk_tree_model_filter_set_visible_column: - * @filter: A #GtkTreeModelFilter - * @column: A #int which is the column containing the visible information + * @filter: A `GtkTreeModelFilter` + * @column: A `int` which is the column containing the visible information * * Sets @column of the child_model to be the column where @filter should * look for visibility information. @columns should be a column of type @@ -3922,9 +3922,9 @@ gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter, /** * gtk_tree_model_filter_convert_child_iter_to_iter: - * @filter: A #GtkTreeModelFilter. - * @filter_iter: (out): An uninitialized #GtkTreeIter. - * @child_iter: A valid #GtkTreeIter pointing to a row on the child model. + * @filter: A `GtkTreeModelFilter` + * @filter_iter: (out): An uninitialized `GtkTreeIter` + * @child_iter: A valid `GtkTreeIter` pointing to a row on the child model. * * Sets @filter_iter to point to the row in @filter that corresponds to the * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is @@ -3967,9 +3967,9 @@ gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter, /** * gtk_tree_model_filter_convert_iter_to_child_iter: - * @filter: A #GtkTreeModelFilter. - * @child_iter: (out): An uninitialized #GtkTreeIter. - * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter. + * @filter: A `GtkTreeModelFilter` + * @child_iter: (out): An uninitialized `GtkTreeIter` + * @filter_iter: A valid `GtkTreeIter` pointing to a row on @filter. * * Sets @child_iter to point to the row pointed to by @filter_iter. */ @@ -4099,8 +4099,8 @@ gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filte /** * gtk_tree_model_filter_convert_child_path_to_path: - * @filter: A #GtkTreeModelFilter. - * @child_path: A #GtkTreePath to convert. + * @filter: A `GtkTreeModelFilter` + * @child_path: A `GtkTreePath` to convert. * * Converts @child_path to a path relative to @filter. That is, @child_path * points to a path in the child model. The rerturned path will point to the @@ -4108,7 +4108,7 @@ gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filte * child model or points to a row which is not visible in @filter, then %NULL * is returned. * - * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath + * Returns: (nullable) (transfer full): A newly allocated `GtkTreePath` */ GtkTreePath * gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter, @@ -4141,15 +4141,15 @@ gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter, /** * gtk_tree_model_filter_convert_path_to_child_path: - * @filter: A #GtkTreeModelFilter. - * @filter_path: A #GtkTreePath to convert. + * @filter: A `GtkTreeModelFilter` + * @filter_path: A `GtkTreePath` to convert. * * Converts @filter_path to a path on the child model of @filter. That is, * @filter_path points to a location in @filter. The returned path will * point to the same location in the model not being filtered. If @filter_path * does not point to a location in the child model, %NULL is returned. * - * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath + * Returns: (nullable) (transfer full): A newly allocated `GtkTreePath` */ GtkTreePath * gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter, @@ -4228,7 +4228,7 @@ gtk_tree_model_filter_refilter_helper (GtkTreeModel *model, /** * gtk_tree_model_filter_refilter: - * @filter: A #GtkTreeModelFilter. + * @filter: A `GtkTreeModelFilter` * * Emits ::row_changed for each row in the child model, which causes * the filter to re-evaluate whether a row is visible or not. @@ -4246,7 +4246,7 @@ gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter) /** * gtk_tree_model_filter_clear_cache: - * @filter: A #GtkTreeModelFilter. + * @filter: A `GtkTreeModelFilter` * * This function should almost never be called. It clears the @filter * of any cached iterators that haven’t been reffed with diff --git a/gtk/gtktreemodelfilter.h b/gtk/gtktreemodelfilter.h index 28ca44c996..f29509289a 100644 --- a/gtk/gtktreemodelfilter.h +++ b/gtk/gtktreemodelfilter.h @@ -36,8 +36,8 @@ G_BEGIN_DECLS /** * GtkTreeModelFilterVisibleFunc: - * @model: the child model of the #GtkTreeModelFilter - * @iter: a #GtkTreeIter pointing to the row in @model whose visibility + * @model: the child model of the `GtkTreeModelFilter` + * @iter: a `GtkTreeIter` pointing to the row in @model whose visibility * is determined * @data: (closure): user data given to gtk_tree_model_filter_set_visible_func() * @@ -51,9 +51,9 @@ typedef gboolean (* GtkTreeModelFilterVisibleFunc) (GtkTreeModel *model, /** * GtkTreeModelFilterModifyFunc: - * @model: the #GtkTreeModelFilter - * @iter: a #GtkTreeIter pointing to the row whose display values are determined - * @value: (out caller-allocates): A #GValue which is already initialized for + * @model: the `GtkTreeModelFilter` + * @iter: a `GtkTreeIter` pointing to the row whose display values are determined + * @value: (out caller-allocates): A `GValue` which is already initialized for * with the correct type for the column @column. * @column: the column whose display value is determined * @data: (closure): user data given to gtk_tree_model_filter_set_modify_func() diff --git a/gtk/gtktreemodelsort.c b/gtk/gtktreemodelsort.c index 104bf304c7..1ef440da06 100644 --- a/gtk/gtktreemodelsort.c +++ b/gtk/gtktreemodelsort.c @@ -33,23 +33,23 @@ * * A GtkTreeModel which makes an underlying tree model sortable * - * The #GtkTreeModelSort is a model which implements the #GtkTreeSortable + * The `GtkTreeModelSort` is a model which implements the `GtkTreeSortable` * interface. It does not hold any data itself, but rather is created with * a child model and proxies its data. It has identical column types to * this child model, and the changes in the child are propagated. The * primary purpose of this model is to provide a way to sort a different * model without modifying it. Note that the sort function used by - * #GtkTreeModelSort is not guaranteed to be stable. + * `GtkTreeModelSort` is not guaranteed to be stable. * * The use of this is best demonstrated through an example. In the - * following sample code we create two #GtkTreeView widgets each with a + * following sample code we create two `GtkTreeView` widgets each with a * view of the same data. As the model is wrapped here by a - * #GtkTreeModelSort, the two #GtkTreeViews can each sort their + * `GtkTreeModelSort`, the two `GtkTreeView`s can each sort their * view of the data without affecting the other. By contrast, if we * simply put the same model in each widget, then sorting the first would * sort the second. * - * ## Using a #GtkTreeModelSort + * ## Using a `GtkTreeModelSort` * * |[<!-- language="C" --> * { @@ -79,8 +79,8 @@ * ]| * * To demonstrate how to access the underlying child model from the sort - * model, the next example will be a callback for the #GtkTreeSelection - * #GtkTreeSelection::changed signal. In this callback, we get a string + * model, the next example will be a callback for the `GtkTreeSelection` + * `GtkTreeSelection::changed` signal. In this callback, we get a string * from COLUMN_1 of the model. We then modify the string, find the same * selected row on the child model, and change the row there. * @@ -526,11 +526,11 @@ gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface) /** * gtk_tree_model_sort_new_with_model: (constructor) - * @child_model: A #GtkTreeModel + * @child_model: A `GtkTreeModel` * - * Creates a new #GtkTreeModelSort, with @child_model as the child model. + * Creates a new `GtkTreeModelSort`, with @child_model as the child model. * - * Returns: (transfer full) (type Gtk.TreeModelSort): A new #GtkTreeModelSort. + * Returns: (transfer full) (type Gtk.TreeModelSort): A new `GtkTreeModelSort`. */ GtkTreeModel * gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model) @@ -2110,8 +2110,8 @@ gtk_tree_model_sort_elt_get_path (SortLevel *level, /** * gtk_tree_model_sort_set_model: - * @tree_model_sort: The #GtkTreeModelSort. - * @child_model: (nullable): A #GtkTreeModel + * @tree_model_sort: The `GtkTreeModelSort`. + * @child_model: (nullable): A `GtkTreeModel` * * Sets the model of @tree_model_sort to be @model. If @model is %NULL, * then the old model is unset. The sort function is unset as a result @@ -2194,9 +2194,9 @@ gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort, /** * gtk_tree_model_sort_get_model: - * @tree_model: a #GtkTreeModelSort + * @tree_model: a `GtkTreeModelSort` * - * Returns the model the #GtkTreeModelSort is sorting. + * Returns the model the `GtkTreeModelSort` is sorting. * * Returns: (transfer none): the "child model" being sorted **/ @@ -2272,15 +2272,15 @@ gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_mode /** * gtk_tree_model_sort_convert_child_path_to_path: - * @tree_model_sort: A #GtkTreeModelSort - * @child_path: A #GtkTreePath to convert + * @tree_model_sort: A `GtkTreeModelSort` + * @child_path: A `GtkTreePath` to convert * * Converts @child_path to a path relative to @tree_model_sort. That is, * @child_path points to a path in the child model. The returned path will * point to the same row in the sorted model. If @child_path isn’t a valid * path on the child model, then %NULL is returned. * - * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath + * Returns: (nullable) (transfer full): A newly allocated `GtkTreePath` **/ GtkTreePath * gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort, @@ -2295,9 +2295,9 @@ gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sor /** * gtk_tree_model_sort_convert_child_iter_to_iter: - * @tree_model_sort: A #GtkTreeModelSort - * @sort_iter: (out): An uninitialized #GtkTreeIter. - * @child_iter: A valid #GtkTreeIter pointing to a row on the child model + * @tree_model_sort: A `GtkTreeModelSort` + * @sort_iter: (out): An uninitialized `GtkTreeIter` + * @child_iter: A valid `GtkTreeIter` pointing to a row on the child model * * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to * the row pointed at by @child_iter. If @sort_iter was not set, %FALSE @@ -2344,8 +2344,8 @@ gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sor /** * gtk_tree_model_sort_convert_path_to_child_path: - * @tree_model_sort: A #GtkTreeModelSort - * @sorted_path: A #GtkTreePath to convert + * @tree_model_sort: A `GtkTreeModelSort` + * @sorted_path: A `GtkTreePath` to convert * * Converts @sorted_path to a path on the child model of @tree_model_sort. * That is, @sorted_path points to a location in @tree_model_sort. The @@ -2353,7 +2353,7 @@ gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sor * sorted. If @sorted_path does not point to a location in the child model, * %NULL is returned. * - * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath + * Returns: (nullable) (transfer full): A newly allocated `GtkTreePath` **/ GtkTreePath * gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort, @@ -2414,9 +2414,9 @@ gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sor /** * gtk_tree_model_sort_convert_iter_to_child_iter: - * @tree_model_sort: A #GtkTreeModelSort - * @child_iter: (out): An uninitialized #GtkTreeIter - * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort. + * @tree_model_sort: A `GtkTreeModelSort` + * @child_iter: (out): An uninitialized `GtkTreeIter` + * @sorted_iter: A valid `GtkTreeIter` pointing to a row on @tree_model_sort. * * Sets @child_iter to point to the row pointed to by @sorted_iter. **/ @@ -2680,11 +2680,11 @@ gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort, /** * gtk_tree_model_sort_reset_default_sort_func: - * @tree_model_sort: A #GtkTreeModelSort + * @tree_model_sort: A `GtkTreeModelSort` * * This resets the default sort function to be in the “unsorted” state. That * is, it is in the same order as the child model. It will re-sort the model - * to be in the same order as the child model only if the #GtkTreeModelSort + * to be in the same order as the child model only if the `GtkTreeModelSort` * is in “unsorted” state. **/ void @@ -2713,7 +2713,7 @@ gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort) /** * gtk_tree_model_sort_clear_cache: - * @tree_model_sort: A #GtkTreeModelSort + * @tree_model_sort: A `GtkTreeModelSort` * * This function should almost never be called. It clears the @tree_model_sort * of any cached iterators that haven’t been reffed with @@ -2757,13 +2757,13 @@ gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter, /** * gtk_tree_model_sort_iter_is_valid: - * @tree_model_sort: A #GtkTreeModelSort. - * @iter: A #GtkTreeIter. + * @tree_model_sort: A `GtkTreeModelSort`. + * @iter: A `GtkTreeIter` * * > This function is slow. Only use it for debugging and/or testing * > purposes. * - * Checks if the given iter is a valid iter for this #GtkTreeModelSort. + * Checks if the given iter is a valid iter for this `GtkTreeModelSort`. * * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. **/ diff --git a/gtk/gtktreeselection.c b/gtk/gtktreeselection.c index 368d3e77ec..f3ab4d449b 100644 --- a/gtk/gtktreeselection.c +++ b/gtk/gtktreeselection.c @@ -31,15 +31,15 @@ * * The selection object for GtkTreeView * - * The #GtkTreeSelection object is a helper object to manage the selection - * for a #GtkTreeView widget. The #GtkTreeSelection object is - * automatically created when a new #GtkTreeView widget is created, and + * The `GtkTreeSelection` object is a helper object to manage the selection + * for a `GtkTreeView` widget. The `GtkTreeSelection` object is + * automatically created when a new `GtkTreeView` widget is created, and * cannot exist independently of this widget. The primary reason the - * #GtkTreeSelection objects exists is for cleanliness of code and API. + * `GtkTreeSelection` objects exists is for cleanliness of code and API. * That is, there is no conceptual reason all these functions could not be - * methods on the #GtkTreeView widget instead of a separate function. + * methods on the `GtkTreeView` widget instead of a separate function. * - * The #GtkTreeSelection object is gotten from a #GtkTreeView by calling + * The `GtkTreeSelection` object is gotten from a `GtkTreeView` by calling * gtk_tree_view_get_selection(). It can be manipulated to check the * selection status of the tree, as well as select and deselect individual * rows. Selection is done completely view side. As a result, multiple @@ -49,9 +49,9 @@ * first. * * One of the important things to remember when monitoring the selection of - * a view is that the #GtkTreeSelection::changed signal is mostly a hint. + * a view is that the `GtkTreeSelection`::changed signal is mostly a hint. * That is, it may only emit one signal when a range of rows is selected. - * Additionally, it may on occasion emit a #GtkTreeSelection::changed signal + * Additionally, it may on occasion emit a `GtkTreeSelection`::changed signal * when nothing has happened (mostly as a result of programmers calling * select_row on an already selected row). */ @@ -220,10 +220,10 @@ gtk_tree_selection_get_property (GObject *object, /** * _gtk_tree_selection_new: * - * Creates a new #GtkTreeSelection object. This function should not be invoked, - * as each #GtkTreeView will create its own #GtkTreeSelection. + * Creates a new `GtkTreeSelection` object. This function should not be invoked, + * as each `GtkTreeView` will create its own `GtkTreeSelection`. * - * Returns: A newly created #GtkTreeSelection object. + * Returns: A newly created `GtkTreeSelection` object. **/ GtkTreeSelection* _gtk_tree_selection_new (void) @@ -237,12 +237,12 @@ _gtk_tree_selection_new (void) /** * _gtk_tree_selection_new_with_tree_view: - * @tree_view: The #GtkTreeView. + * @tree_view: The `GtkTreeView`. * - * Creates a new #GtkTreeSelection object. This function should not be invoked, - * as each #GtkTreeView will create its own #GtkTreeSelection. + * Creates a new `GtkTreeSelection` object. This function should not be invoked, + * as each `GtkTreeView` will create its own `GtkTreeSelection`. * - * Returns: A newly created #GtkTreeSelection object. + * Returns: A newly created `GtkTreeSelection` object. **/ GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView *tree_view) @@ -259,11 +259,11 @@ _gtk_tree_selection_new_with_tree_view (GtkTreeView *tree_view) /** * _gtk_tree_selection_set_tree_view: - * @selection: A #GtkTreeSelection. - * @tree_view: The #GtkTreeView. + * @selection: A `GtkTreeSelection`. + * @tree_view: The `GtkTreeView`. * - * Sets the #GtkTreeView of @selection. This function should not be invoked, as - * it is used internally by #GtkTreeView. + * Sets the `GtkTreeView` of @selection. This function should not be invoked, as + * it is used internally by `GtkTreeView`. **/ void _gtk_tree_selection_set_tree_view (GtkTreeSelection *selection, @@ -279,11 +279,11 @@ _gtk_tree_selection_set_tree_view (GtkTreeSelection *selection, /** * gtk_tree_selection_set_mode: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * @type: The selection mode * * Sets the selection mode of the @selection. If the previous type was - * #GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was + * %GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was * previously selected. **/ void @@ -354,7 +354,7 @@ gtk_tree_selection_set_mode (GtkTreeSelection *selection, /** * gtk_tree_selection_get_mode: - * @selection: a #GtkTreeSelection + * @selection: a `GtkTreeSelection` * * Gets the selection mode for @selection. See * gtk_tree_selection_set_mode(). @@ -371,7 +371,7 @@ gtk_tree_selection_get_mode (GtkTreeSelection *selection) /** * gtk_tree_selection_set_select_function: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * @func: (nullable): The selection function. May be %NULL * @data: The selection function’s data. May be %NULL * @destroy: The destroy function for user data. May be %NULL @@ -402,7 +402,7 @@ gtk_tree_selection_set_select_function (GtkTreeSelection *selection, /** * gtk_tree_selection_get_select_function: (skip) - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * * Returns the current selection function. * @@ -418,7 +418,7 @@ gtk_tree_selection_get_select_function (GtkTreeSelection *selection) /** * gtk_tree_selection_get_user_data: (skip) - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * * Returns the user data for the selection function. * @@ -434,11 +434,11 @@ gtk_tree_selection_get_user_data (GtkTreeSelection *selection) /** * gtk_tree_selection_get_tree_view: - * @selection: A #GtkTreeSelection + * @selection: A `GtkTreeSelection` * * Returns the tree view associated with @selection. * - * Returns: (transfer none): A #GtkTreeView + * Returns: (transfer none): A `GtkTreeView` **/ GtkTreeView * gtk_tree_selection_get_tree_view (GtkTreeSelection *selection) @@ -450,15 +450,15 @@ gtk_tree_selection_get_tree_view (GtkTreeSelection *selection) /** * gtk_tree_selection_get_selected: - * @selection: A #GtkTreeSelection. - * @model: (out) (optional) (transfer none): A pointer to set to the #GtkTreeModel, or NULL. - * @iter: (out) (optional): The #GtkTreeIter, or NULL. + * @selection: A `GtkTreeSelection`. + * @model: (out) (optional) (transfer none): A pointer to set to the `GtkTreeModel` + * @iter: (out) (optional): The `GtkTreeIter` * * Sets @iter to the currently selected node if @selection is set to - * #GTK_SELECTION_SINGLE or #GTK_SELECTION_BROWSE. @iter may be NULL if you + * %GTK_SELECTION_SINGLE or %GTK_SELECTION_BROWSE. @iter may be NULL if you * just want to test if @selection has any selected nodes. @model is filled * with the current model as a convenience. This function will not work if you - * use @selection is #GTK_SELECTION_MULTIPLE. + * use @selection is %GTK_SELECTION_MULTIPLE. * * Returns: TRUE, if there is a selected node. **/ @@ -520,12 +520,12 @@ gtk_tree_selection_get_selected (GtkTreeSelection *selection, /** * gtk_tree_selection_get_selected_rows: - * @selection: A #GtkTreeSelection. - * @model: (out) (optional) (transfer none): A pointer to set to the #GtkTreeModel + * @selection: A `GtkTreeSelection`. + * @model: (out) (optional) (transfer none): A pointer to set to the `GtkTreeModel` * * Creates a list of path of all selected rows. Additionally, if you are * planning on modifying the model after calling this function, you may - * want to convert the returned list into a list of #GtkTreeRowReferences. + * want to convert the returned list into a list of `GtkTreeRowReference`s. * To do this, you can use gtk_tree_row_reference_new(). * * To free the return value, use: @@ -533,7 +533,7 @@ gtk_tree_selection_get_selected (GtkTreeSelection *selection, * g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); * ]| * - * Returns: (element-type GtkTreePath) (transfer full): A #GList containing a #GtkTreePath for each selected row. + * Returns: (element-type GtkTreePath) (transfer full): A `GList` containing a `GtkTreePath` for each selected row. **/ GList * gtk_tree_selection_get_selected_rows (GtkTreeSelection *selection, @@ -644,7 +644,7 @@ gtk_tree_selection_count_selected_rows_helper (GtkTreeRBTree *tree, /** * gtk_tree_selection_count_selected_rows: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * * Returns the number of rows that have been selected in @tree. * @@ -692,7 +692,7 @@ model_changed (gpointer data) /** * gtk_tree_selection_selected_foreach: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * @func: (scope call): The function to call for each selected node. * @data: user data to pass to the function. * @@ -829,8 +829,8 @@ out: /** * gtk_tree_selection_select_path: - * @selection: A #GtkTreeSelection. - * @path: The #GtkTreePath to be selected. + * @selection: A `GtkTreeSelection`. + * @path: The `GtkTreePath` to be selected. * * Select the row at @path. **/ @@ -869,8 +869,8 @@ gtk_tree_selection_select_path (GtkTreeSelection *selection, /** * gtk_tree_selection_unselect_path: - * @selection: A #GtkTreeSelection. - * @path: The #GtkTreePath to be unselected. + * @selection: A `GtkTreeSelection`. + * @path: The `GtkTreePath` to be unselected. * * Unselects the row at @path. **/ @@ -905,8 +905,8 @@ gtk_tree_selection_unselect_path (GtkTreeSelection *selection, /** * gtk_tree_selection_select_iter: - * @selection: A #GtkTreeSelection. - * @iter: The #GtkTreeIter to be selected. + * @selection: A `GtkTreeSelection`. + * @iter: The `GtkTreeIter` to be selected. * * Selects the specified iterator. **/ @@ -936,8 +936,8 @@ gtk_tree_selection_select_iter (GtkTreeSelection *selection, /** * gtk_tree_selection_unselect_iter: - * @selection: A #GtkTreeSelection. - * @iter: The #GtkTreeIter to be unselected. + * @selection: A `GtkTreeSelection`. + * @iter: The `GtkTreeIter` to be unselected. * * Unselects the specified iterator. **/ @@ -966,8 +966,8 @@ gtk_tree_selection_unselect_iter (GtkTreeSelection *selection, /** * gtk_tree_selection_path_is_selected: - * @selection: A #GtkTreeSelection. - * @path: A #GtkTreePath to check selection on. + * @selection: A `GtkTreeSelection`. + * @path: A `GtkTreePath` to check selection on. * * Returns %TRUE if the row pointed to by @path is currently selected. If @path * does not point to a valid location, %FALSE is returned @@ -1003,8 +1003,8 @@ gtk_tree_selection_path_is_selected (GtkTreeSelection *selection, /** * gtk_tree_selection_iter_is_selected: - * @selection: A #GtkTreeSelection - * @iter: A valid #GtkTreeIter + * @selection: A `GtkTreeSelection` + * @iter: A valid `GtkTreeIter` * * Returns %TRUE if the row at @iter is currently selected. * @@ -1096,9 +1096,9 @@ gtk_tree_selection_real_select_all (GtkTreeSelection *selection) /** * gtk_tree_selection_select_all: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * - * Selects all the nodes. @selection must be set to #GTK_SELECTION_MULTIPLE + * Selects all the nodes. @selection must be set to %GTK_SELECTION_MULTIPLE * mode. **/ void @@ -1200,7 +1200,7 @@ gtk_tree_selection_real_unselect_all (GtkTreeSelection *selection) /** * gtk_tree_selection_unselect_all: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * * Unselects all the nodes. **/ @@ -1311,12 +1311,12 @@ gtk_tree_selection_real_modify_range (GtkTreeSelection *selection, /** * gtk_tree_selection_select_range: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * @start_path: The initial node of the range. * @end_path: The final node of the range. * * Selects a range of nodes, determined by @start_path and @end_path inclusive. - * @selection must be set to #GTK_SELECTION_MULTIPLE mode. + * @selection must be set to %GTK_SELECTION_MULTIPLE mode. **/ void gtk_tree_selection_select_range (GtkTreeSelection *selection, @@ -1335,7 +1335,7 @@ gtk_tree_selection_select_range (GtkTreeSelection *selection, /** * gtk_tree_selection_unselect_range: - * @selection: A #GtkTreeSelection. + * @selection: A `GtkTreeSelection`. * @start_path: The initial node of the range. * @end_path: The initial node of the range. * diff --git a/gtk/gtktreeselection.h b/gtk/gtktreeselection.h index 40f46fac6d..ca82a24164 100644 --- a/gtk/gtktreeselection.h +++ b/gtk/gtktreeselection.h @@ -33,9 +33,9 @@ G_BEGIN_DECLS /** * GtkTreeSelectionFunc: - * @selection: A #GtkTreeSelection - * @model: A #GtkTreeModel being viewed - * @path: The #GtkTreePath of the row in question + * @selection: A `GtkTreeSelection` + * @model: A `GtkTreeModel` being viewed + * @path: The `GtkTreePath` of the row in question * @path_currently_selected: %TRUE, if the path is currently selected * @data: (closure): user data * @@ -56,9 +56,9 @@ typedef gboolean (* GtkTreeSelectionFunc) (GtkTreeSelection *selection, /** * GtkTreeSelectionForeachFunc: - * @model: The #GtkTreeModel being viewed - * @path: The #GtkTreePath of a selected row - * @iter: A #GtkTreeIter pointing to a selected row + * @model: The `GtkTreeModel` being viewed + * @path: The `GtkTreePath` of a selected row + * @iter: A `GtkTreeIter` pointing to a selected row * @data: (closure): user data * * A function used by gtk_tree_selection_selected_foreach() to map all diff --git a/gtk/gtktreesortable.c b/gtk/gtktreesortable.c index dca92dc513..622bc24603 100644 --- a/gtk/gtktreesortable.c +++ b/gtk/gtktreesortable.c @@ -27,8 +27,8 @@ * * The interface for sortable models used by GtkTreeView * - * #GtkTreeSortable is an interface to be implemented by tree models which - * support sorting. The #GtkTreeView uses the methods provided by this interface + * `GtkTreeSortable` is an interface to be implemented by tree models which + * support sorting. The `GtkTreeView` uses the methods provided by this interface * to sort the model. */ @@ -93,9 +93,9 @@ gtk_tree_sortable_base_init (gpointer g_class) /** * gtk_tree_sortable_sort_column_changed: - * @sortable: A #GtkTreeSortable + * @sortable: A `GtkTreeSortable` * - * Emits a #GtkTreeSortable::sort-column-changed signal on @sortable. + * Emits a `GtkTreeSortable::sort-column-changed` signal on @sortable. */ void gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable) @@ -107,9 +107,9 @@ gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable) /** * gtk_tree_sortable_get_sort_column_id: - * @sortable: A #GtkTreeSortable + * @sortable: A `GtkTreeSortable` * @sort_column_id: (out): The sort column id to be filled in - * @order: (out): The #GtkSortType to be filled in + * @order: (out): The `GtkSortType` to be filled in * * Fills in @sort_column_id and @order with the current sort column and the * order. It returns %TRUE unless the @sort_column_id is @@ -138,13 +138,13 @@ gtk_tree_sortable_get_sort_column_id (GtkTreeSortable *sortable, /** * gtk_tree_sortable_set_sort_column_id: - * @sortable: A #GtkTreeSortable + * @sortable: A `GtkTreeSortable` * @sort_column_id: the sort column id to set * @order: The sort order of the column * * Sets the current sort column to be @sort_column_id. The @sortable will * resort itself to reflect this change, after emitting a - * #GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be + * `GtkTreeSortable::sort-column-changed` signal. @sort_column_id may either be * a regular column id, or one of the following special values: * * - %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function @@ -171,7 +171,7 @@ gtk_tree_sortable_set_sort_column_id (GtkTreeSortable *sortable, /** * gtk_tree_sortable_set_sort_func: - * @sortable: A #GtkTreeSortable + * @sortable: A `GtkTreeSortable` * @sort_column_id: the sort column id to set the function for * @sort_func: The comparison function * @user_data: (closure): User data to pass to @sort_func @@ -204,7 +204,7 @@ gtk_tree_sortable_set_sort_func (GtkTreeSortable *sortable, /** * gtk_tree_sortable_set_default_sort_func: - * @sortable: A #GtkTreeSortable + * @sortable: A `GtkTreeSortable` * @sort_func: The comparison function * @user_data: (closure): User data to pass to @sort_func * @destroy: (nullable): Destroy notifier of @user_data @@ -239,7 +239,7 @@ gtk_tree_sortable_set_default_sort_func (GtkTreeSortable *sortable, /** * gtk_tree_sortable_has_default_sort_func: - * @sortable: A #GtkTreeSortable + * @sortable: A `GtkTreeSortable` * * Returns %TRUE if the model has a default sort function. This is used * primarily by GtkTreeViewColumns in order to determine if a model can diff --git a/gtk/gtktreesortable.h b/gtk/gtktreesortable.h index 56f3567305..04eb918899 100644 --- a/gtk/gtktreesortable.h +++ b/gtk/gtktreesortable.h @@ -57,9 +57,9 @@ typedef struct _GtkTreeSortableIface GtkTreeSortableIface; /** * GtkTreeIterCompareFunc: - * @model: The #GtkTreeModel the comparison is within - * @a: A #GtkTreeIter in @model - * @b: Another #GtkTreeIter in @model + * @model: The `GtkTreeModel` the comparison is within + * @a: A `GtkTreeIter` in @model + * @b: Another `GtkTreeIter` in @model * @user_data: Data passed when the compare func is assigned e.g. by * gtk_tree_sortable_set_sort_func() * @@ -68,7 +68,7 @@ typedef struct _GtkTreeSortableIface GtkTreeSortableIface; * respectively. * * If two iters compare as equal, their order in the sorted model - * is undefined. In order to ensure that the #GtkTreeSortable behaves as + * is undefined. In order to ensure that the `GtkTreeSortable` behaves as * expected, the GtkTreeIterCompareFunc must define a partial order on * the model, i.e. it must be reflexive, antisymmetric and transitive. * diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c index 0374f36b2d..0d0ac54c0a 100644 --- a/gtk/gtktreestore.c +++ b/gtk/gtktreestore.c @@ -33,17 +33,17 @@ * * A tree-like data structure that can be used with the GtkTreeView * - * The #GtkTreeStore object is a list model for use with a #GtkTreeView - * widget. It implements the #GtkTreeModel interface, and consequently, + * The `GtkTreeStore` object is a list model for use with a `GtkTreeView` + * widget. It implements the `GtkTreeModel` interface, and consequently, * can use all of the methods available there. It also implements the - * #GtkTreeSortable interface so it can be sorted by the view. Finally, + * `GtkTreeSortable` interface so it can be sorted by the view. Finally, * it also implements the tree * [drag and drop][gtk3-GtkTreeView-drag-and-drop] * interfaces. * * # GtkTreeStore as GtkBuildable * - * The GtkTreeStore implementation of the #GtkBuildable interface allows + * The GtkTreeStore implementation of the `GtkBuildable` interface allows * to specify the model columns with a <columns> element that may contain * multiple <column> elements, each specifying one model column. The “type” * attribute specifies the data type for the column. @@ -301,17 +301,22 @@ gtk_tree_store_init (GtkTreeStore *tree_store) /** * gtk_tree_store_new: * @n_columns: number of columns in the tree store - * @...: all #GType types for the columns, from first to last + * @...: all `GType` types for the columns, from first to last * * Creates a new tree store as with @n_columns columns each of the types passed * in. Note that only types derived from standard GObject fundamental types * are supported. * - * As an example, `gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING, - * GDK_TYPE_TEXTURE);` will create a new #GtkTreeStore with three columns, of type - * #int, #gchararray, and #GdkTexture respectively. + * As an example, * - * Returns: a new #GtkTreeStore + * ``` + * gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING, GDK_TYPE_TEXTURE); + * ``` + * + * will create a new `GtkTreeStore` with three columns, of type + * `int`, `gchararray`, and `GdkTexture` respectively. + * + * Returns: a new `GtkTreeStore` **/ GtkTreeStore * gtk_tree_store_new (int n_columns, @@ -347,11 +352,11 @@ gtk_tree_store_new (int n_columns, /** * gtk_tree_store_newv: (rename-to gtk_tree_store_new) * @n_columns: number of columns in the tree store - * @types: (array length=n_columns): an array of #GType types for the columns, from first to last + * @types: (array length=n_columns): an array of `GType` types for the columns, from first to last * * Non vararg creation function. Used primarily by language bindings. * - * Returns: (transfer full): a new #GtkTreeStore + * Returns: (transfer full): a new `GtkTreeStore` **/ GtkTreeStore * gtk_tree_store_newv (int n_columns, @@ -382,14 +387,14 @@ gtk_tree_store_newv (int n_columns, /** * gtk_tree_store_set_column_types: - * @tree_store: A #GtkTreeStore + * @tree_store: A `GtkTreeStore` * @n_columns: Number of columns for the tree store - * @types: (array length=n_columns): An array of #GType types, one for each column + * @types: (array length=n_columns): An array of `GType` types, one for each column * - * This function is meant primarily for #GObjects that inherit from - * #GtkTreeStore, and should only be used when constructing a new - * #GtkTreeStore. It will not function after a row has been added, - * or a method on the #GtkTreeModel interface is called. + * This function is meant primarily for `GObjects` that inherit from + * `GtkTreeStore`, and should only be used when constructing a new + * `GtkTreeStore`. It will not function after a row has been added, + * or a method on the `GtkTreeModel` interface is called. **/ void gtk_tree_store_set_column_types (GtkTreeStore *tree_store, @@ -436,7 +441,7 @@ gtk_tree_store_set_n_columns (GtkTreeStore *tree_store, /** * gtk_tree_store_set_column_type: - * @tree_store: a #GtkTreeStore + * @tree_store: a `GtkTreeStore` * @column: column number * @type: type of the data to be stored in @column * @@ -932,8 +937,8 @@ gtk_tree_store_real_set_value (GtkTreeStore *tree_store, /** * gtk_tree_store_set_value: - * @tree_store: a #GtkTreeStore - * @iter: A valid #GtkTreeIter for the row being modified + * @tree_store: a `GtkTreeStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @column: column number to modify * @value: new value for the cell * @@ -1077,8 +1082,8 @@ gtk_tree_store_set_valist_internal (GtkTreeStore *tree_store, /** * gtk_tree_store_set_valuesv: (rename-to gtk_tree_store_set) - * @tree_store: A #GtkTreeStore - * @iter: A valid #GtkTreeIter for the row being modified + * @tree_store: A `GtkTreeStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @columns: (array length=n_values): an array of column numbers * @values: (array length=n_values): an array of GValues * @n_values: the length of the @columns and @values arrays @@ -1122,8 +1127,8 @@ gtk_tree_store_set_valuesv (GtkTreeStore *tree_store, /** * gtk_tree_store_set_valist: - * @tree_store: A #GtkTreeStore - * @iter: A valid #GtkTreeIter for the row being modified + * @tree_store: A `GtkTreeStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @var_args: va_list of column/value pairs * * See gtk_tree_store_set(); this version takes a va_list for @@ -1162,8 +1167,8 @@ gtk_tree_store_set_valist (GtkTreeStore *tree_store, /** * gtk_tree_store_set: - * @tree_store: A #GtkTreeStore - * @iter: A valid #GtkTreeIter for the row being modified + * @tree_store: A `GtkTreeStore` + * @iter: A valid `GtkTreeIter` for the row being modified * @...: pairs of column number and value, terminated with -1 * * Sets the value of one or more cells in the row referenced by @iter. @@ -1190,8 +1195,8 @@ gtk_tree_store_set (GtkTreeStore *tree_store, /** * gtk_tree_store_remove: - * @tree_store: A #GtkTreeStore - * @iter: A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: A valid `GtkTreeIter` * * Removes @iter from @tree_store. After being removed, @iter is set to the * next valid row at that level, or invalidated if it previously pointed to the @@ -1258,9 +1263,9 @@ gtk_tree_store_remove (GtkTreeStore *tree_store, /** * gtk_tree_store_insert: - * @tree_store: A #GtkTreeStore - * @iter: (out): An unset #GtkTreeIter to set to the new row - * @parent: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out): An unset `GtkTreeIter` to set to the new row + * @parent: (nullable): A valid `GtkTreeIter` * @position: position to insert the new row, or -1 for last * * Creates a new row at @position. If parent is non-%NULL, then the row will be @@ -1320,10 +1325,10 @@ gtk_tree_store_insert (GtkTreeStore *tree_store, /** * gtk_tree_store_insert_before: - * @tree_store: A #GtkTreeStore - * @iter: (out): An unset #GtkTreeIter to set to the new row - * @parent: (nullable): A valid #GtkTreeIter - * @sibling: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out): An unset `GtkTreeIter` to set to the new row + * @parent: (nullable): A valid `GtkTreeIter` + * @sibling: (nullable): A valid `GtkTreeIter` * * Inserts a new row before @sibling. If @sibling is %NULL, then the row will * be appended to @parent ’s children. If @parent and @sibling are %NULL, then @@ -1401,10 +1406,10 @@ gtk_tree_store_insert_before (GtkTreeStore *tree_store, /** * gtk_tree_store_insert_after: - * @tree_store: A #GtkTreeStore - * @iter: (out): An unset #GtkTreeIter to set to the new row - * @parent: (nullable): A valid #GtkTreeIter - * @sibling: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out): An unset `GtkTreeIter` to set to the new row + * @parent: (nullable): A valid `GtkTreeIter` + * @sibling: (nullable): A valid `GtkTreeIter` * * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be * prepended to @parent ’s children. If @parent and @sibling are %NULL, then @@ -1483,9 +1488,9 @@ gtk_tree_store_insert_after (GtkTreeStore *tree_store, /** * gtk_tree_store_insert_with_values: - * @tree_store: A #GtkTreeStore - * @iter: (out) (optional): An unset #GtkTreeIter to set the new row - * @parent: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out) (optional): An unset `GtkTreeIter` to set the new row + * @parent: (nullable): A valid `GtkTreeIter` * @position: position to insert the new row, or -1 to append after existing rows * @...: pairs of column number and value, terminated with -1 * @@ -1573,9 +1578,9 @@ gtk_tree_store_insert_with_values (GtkTreeStore *tree_store, /** * gtk_tree_store_insert_with_valuesv: (rename-to gtk_tree_store_insert_with_values) - * @tree_store: A #GtkTreeStore - * @iter: (out) (optional): An unset #GtkTreeIter to set the new row - * @parent: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out) (optional): An unset `GtkTreeIter` to set the new row + * @parent: (nullable): A valid `GtkTreeIter` * @position: position to insert the new row, or -1 for last * @columns: (array length=n_values): an array of column numbers * @values: (array length=n_values): an array of GValues @@ -1649,9 +1654,9 @@ gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store, /** * gtk_tree_store_prepend: - * @tree_store: A #GtkTreeStore - * @iter: (out): An unset #GtkTreeIter to set to the prepended row - * @parent: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out): An unset `GtkTreeIter` to set to the prepended row + * @parent: (nullable): A valid `GtkTreeIter` * * Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend * the new row before the first child of @parent, otherwise it will prepend a row @@ -1708,9 +1713,9 @@ gtk_tree_store_prepend (GtkTreeStore *tree_store, /** * gtk_tree_store_append: - * @tree_store: A #GtkTreeStore - * @iter: (out): An unset #GtkTreeIter to set to the appended row - * @parent: (nullable): A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: (out): An unset `GtkTreeIter` to set to the appended row + * @parent: (nullable): A valid `GtkTreeIter` * * Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the * new row after the last child of @parent, otherwise it will append a row to @@ -1767,9 +1772,9 @@ gtk_tree_store_append (GtkTreeStore *tree_store, /** * gtk_tree_store_is_ancestor: - * @tree_store: A #GtkTreeStore - * @iter: A valid #GtkTreeIter - * @descendant: A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: A valid `GtkTreeIter` + * @descendant: A valid `GtkTreeIter` * * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the * parent (or grandparent or great-grandparent) of @descendant. @@ -1792,8 +1797,8 @@ gtk_tree_store_is_ancestor (GtkTreeStore *tree_store, /** * gtk_tree_store_iter_depth: - * @tree_store: A #GtkTreeStore - * @iter: A valid #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: A valid `GtkTreeIter` * * Returns the depth of @iter. This will be 0 for anything on the root level, 1 * for anything down a level, etc. @@ -1864,7 +1869,7 @@ gtk_tree_store_increment_stamp (GtkTreeStore *tree_store) /** * gtk_tree_store_clear: - * @tree_store: a #GtkTreeStore + * @tree_store: a `GtkTreeStore` * * Removes all rows from @tree_store **/ @@ -1903,13 +1908,13 @@ gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter, /** * gtk_tree_store_iter_is_valid: - * @tree_store: A #GtkTreeStore. - * @iter: A #GtkTreeIter. + * @tree_store: A `GtkTreeStore`. + * @iter: A `GtkTreeIter`. * * WARNING: This function is slow. Only use it for debugging and/or testing * purposes. * - * Checks if the given iter is a valid iter for this #GtkTreeStore. + * Checks if the given iter is a valid iter for this `GtkTreeStore`. * * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. **/ @@ -2319,9 +2324,9 @@ gtk_tree_store_reorder (GtkTreeStore *tree_store, /** * gtk_tree_store_swap: - * @tree_store: A #GtkTreeStore. - * @a: A #GtkTreeIter. - * @b: Another #GtkTreeIter. + * @tree_store: A `GtkTreeStore`. + * @a: A `GtkTreeIter`. + * @b: Another `GtkTreeIter`. * * Swaps @a and @b in the same level of @tree_store. Note that this function * only works with unsorted stores. @@ -2783,9 +2788,9 @@ free_paths_and_out: /** * gtk_tree_store_move_before: - * @tree_store: A #GtkTreeStore. - * @iter: A #GtkTreeIter. - * @position: (nullable): A #GtkTreeIter + * @tree_store: A `GtkTreeStore` + * @iter: A `GtkTreeIter` + * @position: (nullable): A `GtkTreeIter` * * Moves @iter in @tree_store to the position before @position. @iter and * @position should be in the same level. Note that this function only @@ -2802,9 +2807,9 @@ gtk_tree_store_move_before (GtkTreeStore *tree_store, /** * gtk_tree_store_move_after: - * @tree_store: A #GtkTreeStore. - * @iter: A #GtkTreeIter. - * @position: (nullable): A #GtkTreeIter. + * @tree_store: A `GtkTreeStore` + * @iter: A `GtkTreeIter`. + * @position: (nullable): A `GtkTreeIter`. * * Moves @iter in @tree_store to the position after @position. @iter and * @position should be in the same level. Note that this function only diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c index 2d67d3e5ad..5ee23dea7c 100644 --- a/gtk/gtktreeview.c +++ b/gtk/gtktreeview.c @@ -1045,7 +1045,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) * GtkTreeView:fixed-height-mode: * * Setting the ::fixed-height-mode property to %TRUE speeds up - * #GtkTreeView by assuming that all rows have the same height. + * `GtkTreeView` by assuming that all rows have the same height. * Only enable this option if all rows are the same height. * Please see gtk_tree_view_set_fixed_height_mode() for more * information on this option. @@ -1066,7 +1066,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) * %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE. * * This mode is primarily intended for treeviews in popups, e.g. - * in #GtkComboBox or #GtkEntryCompletion. + * in `GtkComboBox` or `GtkEntryCompletion`. */ tree_view_props[PROP_HOVER_SELECTION] = g_param_spec_boolean ("hover-selection", @@ -1083,7 +1083,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) * over them. * * This mode is primarily intended for treeviews in popups, e.g. - * in #GtkComboBox or #GtkEntryCompletion. + * in `GtkComboBox` or `GtkEntryCompletion`. */ tree_view_props[PROP_HOVER_EXPAND] = g_param_spec_boolean ("hover-expand", @@ -1166,8 +1166,8 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) /** * GtkTreeView::row-activated: * @tree_view: the object on which the signal is emitted - * @path: the #GtkTreePath for the activated row - * @column: the #GtkTreeViewColumn in which the activation occurred + * @path: the `GtkTreePath` for the activated row + * @column: the `GtkTreeViewColumn` in which the activation occurred * * The "row-activated" signal is emitted when the method * gtk_tree_view_row_activated() is called, when the user double @@ -1179,7 +1179,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) * * For selection handling refer to the * [tree widget conceptual overview][TreeWidget] - * as well as #GtkTreeSelection. + * as well as `GtkTreeSelection`. */ tree_view_signals[ROW_ACTIVATED] = g_signal_new (I_("row-activated"), @@ -1322,7 +1322,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) /** * GtkTreeView::move-cursor: * @tree_view: the object on which the signal is emitted. - * @step: the granularity of the move, as a #GtkMovementStep. + * @step: the granularity of the move, as a `GtkMovementStep`. * %GTK_MOVEMENT_LOGICAL_POSITIONS, %GTK_MOVEMENT_VISUAL_POSITIONS, * %GTK_MOVEMENT_DISPLAY_LINES, %GTK_MOVEMENT_PAGES and * %GTK_MOVEMENT_BUFFER_ENDS are supported. @@ -1333,7 +1333,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) * @extend: whether to extend the selection * @modify: whether to modify the selection * - * The #GtkTreeView::move-cursor signal is a [keybinding + * The `GtkTreeView`::move-cursor signal is a [keybinding * signal][GtkSignalAction] which gets emitted when the user * presses one of the cursor keys. * @@ -1341,7 +1341,7 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) * g_signal_emit_by_name() if they need to control the cursor * programmatically. In contrast to gtk_tree_view_set_cursor() and * gtk_tree_view_set_cursor_on_cell() when moving horizontally - * #GtkTreeView::move-cursor does not reset the current selection. + * `GtkTreeView`::move-cursor does not reset the current selection. * * Returns: %TRUE if @step is supported, %FALSE otherwise. */ @@ -7554,11 +7554,11 @@ column_sizing_notify (GObject *object, /** * gtk_tree_view_set_fixed_height_mode: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @enable: %TRUE to enable fixed height mode * * Enables or disables the fixed height mode of @tree_view. - * Fixed height mode speeds up #GtkTreeView by assuming that all + * Fixed height mode speeds up `GtkTreeView` by assuming that all * rows have the same height. * Only enable this option if all rows are the same height and all * columns are of type %GTK_TREE_VIEW_COLUMN_FIXED. @@ -7605,7 +7605,7 @@ gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view, /** * gtk_tree_view_get_fixed_height_mode: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns whether fixed height mode is turned on for @tree_view. * @@ -10183,9 +10183,9 @@ gtk_tree_view_adjustment_changed (GtkAdjustment *adjustment, /** * gtk_tree_view_new: * - * Creates a new #GtkTreeView widget. + * Creates a new `GtkTreeView` widget. * - * Returns: A newly created #GtkTreeView widget. + * Returns: A newly created `GtkTreeView` widget. **/ GtkWidget * gtk_tree_view_new (void) @@ -10197,9 +10197,9 @@ gtk_tree_view_new (void) * gtk_tree_view_new_with_model: * @model: the model. * - * Creates a new #GtkTreeView widget with the model initialized to @model. + * Creates a new `GtkTreeView` widget with the model initialized to @model. * - * Returns: A newly created #GtkTreeView widget. + * Returns: A newly created `GtkTreeView` widget. **/ GtkWidget * gtk_tree_view_new_with_model (GtkTreeModel *model) @@ -10212,12 +10212,12 @@ gtk_tree_view_new_with_model (GtkTreeModel *model) /** * gtk_tree_view_get_model: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * - * Returns the model the #GtkTreeView is based on. Returns %NULL if the + * Returns the model the `GtkTreeView` is based on. Returns %NULL if the * model is unset. * - * Returns: (transfer none) (nullable): A #GtkTreeModel + * Returns: (transfer none) (nullable): A `GtkTreeModel` **/ GtkTreeModel * gtk_tree_view_get_model (GtkTreeView *tree_view) @@ -10231,10 +10231,10 @@ gtk_tree_view_get_model (GtkTreeView *tree_view) /** * gtk_tree_view_set_model: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @model: (nullable): The model. * - * Sets the model for a #GtkTreeView. If the @tree_view already has a model + * Sets the model for a `GtkTreeView`. If the @tree_view already has a model * set, it will remove it before setting the new model. If @model is %NULL, * then it will unset the old model. **/ @@ -10384,11 +10384,11 @@ gtk_tree_view_set_model (GtkTreeView *tree_view, /** * gtk_tree_view_get_selection: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * - * Gets the #GtkTreeSelection associated with @tree_view. + * Gets the `GtkTreeSelection` associated with @tree_view. * - * Returns: (transfer none): A #GtkTreeSelection object. + * Returns: (transfer none): A `GtkTreeSelection` object. **/ GtkTreeSelection * gtk_tree_view_get_selection (GtkTreeView *tree_view) @@ -10467,7 +10467,7 @@ gtk_tree_view_do_set_vadjustment (GtkTreeView *tree_view, /** * gtk_tree_view_get_headers_visible: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * * Returns %TRUE if the headers on the @tree_view are visible. * @@ -10485,7 +10485,7 @@ gtk_tree_view_get_headers_visible (GtkTreeView *tree_view) /** * gtk_tree_view_set_headers_visible: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @headers_visible: %TRUE if the headers are visible * * Sets the visibility state of the headers. @@ -10536,7 +10536,7 @@ gtk_tree_view_set_headers_visible (GtkTreeView *tree_view, /** * gtk_tree_view_columns_autosize: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * * Resizes all columns to their optimal width. Only works after the * treeview has been realized. @@ -10566,7 +10566,7 @@ gtk_tree_view_columns_autosize (GtkTreeView *tree_view) /** * gtk_tree_view_set_headers_clickable: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @setting: %TRUE if the columns are clickable. * * Allow the column title buttons to be clicked. @@ -10597,7 +10597,7 @@ gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view, /** * gtk_tree_view_get_headers_clickable: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * * Returns whether all header columns are clickable. * @@ -10620,10 +10620,10 @@ gtk_tree_view_get_headers_clickable (GtkTreeView *tree_view) /** * gtk_tree_view_set_activate_on_single_click: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @single: %TRUE to emit row-activated on a single click * - * Cause the #GtkTreeView::row-activated signal to be emitted + * Cause the `GtkTreeView`::row-activated signal to be emitted * on a single click instead of a double click. **/ void @@ -10645,7 +10645,7 @@ gtk_tree_view_set_activate_on_single_click (GtkTreeView *tree_view, /** * gtk_tree_view_get_activate_on_single_click: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Gets the setting set by gtk_tree_view_set_activate_on_single_click(). * @@ -10666,8 +10666,8 @@ gtk_tree_view_get_activate_on_single_click (GtkTreeView *tree_view) /** * gtk_tree_view_append_column: - * @tree_view: A #GtkTreeView. - * @column: The #GtkTreeViewColumn to add. + * @tree_view: A `GtkTreeView`. + * @column: The `GtkTreeViewColumn` to add. * * Appends @column to the list of columns. If @tree_view has “fixed_height” * mode enabled, then @column must have its “sizing” property set to be @@ -10688,8 +10688,8 @@ gtk_tree_view_append_column (GtkTreeView *tree_view, /** * gtk_tree_view_remove_column: - * @tree_view: A #GtkTreeView. - * @column: The #GtkTreeViewColumn to remove. + * @tree_view: A `GtkTreeView`. + * @column: The `GtkTreeViewColumn` to remove. * * Removes @column from @tree_view. * @@ -10752,8 +10752,8 @@ gtk_tree_view_remove_column (GtkTreeView *tree_view, /** * gtk_tree_view_insert_column: - * @tree_view: A #GtkTreeView. - * @column: The #GtkTreeViewColumn to be inserted. + * @tree_view: A `GtkTreeView`. + * @column: The `GtkTreeViewColumn` to be inserted. * @position: The position to insert @column in. * * This inserts the @column into the @tree_view at @position. If @position is @@ -10818,13 +10818,13 @@ gtk_tree_view_insert_column (GtkTreeView *tree_view, /** * gtk_tree_view_insert_column_with_attributes: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @position: The position to insert the new column in * @title: The title to set the header to - * @cell: The #GtkCellRenderer + * @cell: The `GtkCellRenderer` * @...: A %NULL-terminated list of attributes * - * Creates a new #GtkTreeViewColumn and inserts it into the @tree_view at + * Creates a new `GtkTreeViewColumn` and inserts it into the @tree_view at * @position. If @position is -1, then the newly created column is inserted at * the end. The column is initialized with the attributes given. If @tree_view * has “fixed_height” mode enabled, then the new column will have its sizing @@ -10872,7 +10872,7 @@ gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view, /** * gtk_tree_view_insert_column_with_data_func: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @position: Position to insert, -1 for append * @title: column title * @cell: cell renderer for column @@ -10880,8 +10880,8 @@ gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view, * @data: data for @func * @dnotify: destroy notifier for @data * - * Convenience function that inserts a new column into the #GtkTreeView - * with the given cell renderer and a #GtkTreeCellDataFunc to set cell renderer + * Convenience function that inserts a new column into the `GtkTreeView` + * with the given cell renderer and a `GtkTreeCellDataFunc` to set cell renderer * attributes (normally using data from the model). See also * gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). * If @tree_view has “fixed_height” mode enabled, then the new column will have its @@ -10916,7 +10916,7 @@ gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_vie /** * gtk_tree_view_get_n_columns: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Queries the number of columns in the given @tree_view. * @@ -10934,12 +10934,12 @@ gtk_tree_view_get_n_columns (GtkTreeView *tree_view) /** * gtk_tree_view_get_column: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @n: The position of the column, counting from 0. * - * Gets the #GtkTreeViewColumn at the given position in the #tree_view. + * Gets the `GtkTreeViewColumn` at the given position in the #tree_view. * - * Returns: (nullable) (transfer none): The #GtkTreeViewColumn, or %NULL if the + * Returns: (nullable) (transfer none): The `GtkTreeViewColumn`, or %NULL if the * position is outside the range of columns. **/ GtkTreeViewColumn * @@ -10961,12 +10961,12 @@ gtk_tree_view_get_column (GtkTreeView *tree_view, /** * gtk_tree_view_get_columns: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * - * Returns a #GList of all the #GtkTreeViewColumn s currently in @tree_view. + * Returns a `GList` of all the `GtkTreeViewColumn`s currently in @tree_view. * The returned list must be freed with g_list_free (). * - * Returns: (element-type GtkTreeViewColumn) (transfer container): A list of #GtkTreeViewColumn s + * Returns: (element-type GtkTreeViewColumn) (transfer container): A list of `GtkTreeViewColumn`s **/ GList * gtk_tree_view_get_columns (GtkTreeView *tree_view) @@ -10980,9 +10980,9 @@ gtk_tree_view_get_columns (GtkTreeView *tree_view) /** * gtk_tree_view_move_column_after: - * @tree_view: A #GtkTreeView - * @column: The #GtkTreeViewColumn to be moved. - * @base_column: (nullable): The #GtkTreeViewColumn to be moved relative to + * @tree_view: A `GtkTreeView` + * @column: The `GtkTreeViewColumn` to be moved. + * @base_column: (nullable): The `GtkTreeViewColumn` to be moved relative to * * Moves @column to be after to @base_column. If @base_column is %NULL, then * @column is placed in the first position. @@ -11036,7 +11036,7 @@ gtk_tree_view_move_column_after (GtkTreeView *tree_view, /** * gtk_tree_view_set_expander_column: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @column: (nullable): %NULL, or the column to draw the expander arrow at. * * Sets the column to draw the expander arrow at. It must be in @tree_view. @@ -11065,7 +11065,7 @@ gtk_tree_view_set_expander_column (GtkTreeView *tree_view, /** * gtk_tree_view_get_expander_column: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * * Returns the column that is the current expander column, * or %NULL if none has been set. @@ -11090,7 +11090,7 @@ gtk_tree_view_get_expander_column (GtkTreeView *tree_view) /** * gtk_tree_view_set_column_drag_function: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @func: (nullable): A function to determine which columns are reorderable * @user_data: (closure): User data to be passed to @func * @destroy: (nullable): Destroy notifier for @user_data @@ -11098,9 +11098,9 @@ gtk_tree_view_get_expander_column (GtkTreeView *tree_view) * Sets a user function for determining where a column may be dropped when * dragged. This function is called on every column pair in turn at the * beginning of a column drag to determine where a drop can take place. The - * arguments passed to @func are: the @tree_view, the #GtkTreeViewColumn being - * dragged, the two #GtkTreeViewColumn s determining the drop spot, and - * @user_data. If either of the #GtkTreeViewColumn arguments for the drop spot + * arguments passed to @func are: the @tree_view, the `GtkTreeViewColumn` being + * dragged, the two `GtkTreeViewColumn`s determining the drop spot, and + * @user_data. If either of the `GtkTreeViewColumn` arguments for the drop spot * are %NULL, then they indicate an edge. If @func is set to be %NULL, then * @tree_view reverts to the default behavior of allowing all columns to be * dropped everywhere. @@ -11125,7 +11125,7 @@ gtk_tree_view_set_column_drag_function (GtkTreeView *tree_view, /** * gtk_tree_view_scroll_to_point: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @tree_x: X coordinate of new top-left pixel of visible area, or -1 * @tree_y: Y coordinate of new top-left pixel of visible area, or -1 * @@ -11160,9 +11160,9 @@ gtk_tree_view_scroll_to_point (GtkTreeView *tree_view, /** * gtk_tree_view_scroll_to_cell: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @path: (nullable): The path of the row to move to - * @column: (nullable): The #GtkTreeViewColumn to move horizontally to + * @column: (nullable): The `GtkTreeViewColumn` to move horizontally to * @use_align: whether to use alignment arguments, or %FALSE. * @row_align: The vertical alignment of the row specified by @path. * @col_align: The horizontal alignment of the column specified by @column. @@ -11281,9 +11281,9 @@ gtk_tree_view_scroll_to_cell (GtkTreeView *tree_view, /** * gtk_tree_view_row_activated: - * @tree_view: A #GtkTreeView - * @path: The #GtkTreePath to be activated. - * @column: The #GtkTreeViewColumn to be activated. + * @tree_view: A `GtkTreeView` + * @path: The `GtkTreePath` to be activated. + * @column: The `GtkTreeViewColumn` to be activated. * * Activates the cell determined by @path and @column. **/ @@ -11330,7 +11330,7 @@ gtk_tree_view_expand_all_emission_helper (GtkTreeRBTree *tree, /** * gtk_tree_view_expand_all: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * * Recursively expands all nodes in the @tree_view. **/ @@ -11362,7 +11362,7 @@ gtk_tree_view_expand_all (GtkTreeView *tree_view) /** * gtk_tree_view_collapse_all: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * * Recursively collapses all visible, expanded nodes in @tree_view. **/ @@ -11400,7 +11400,7 @@ gtk_tree_view_collapse_all (GtkTreeView *tree_view) /** * gtk_tree_view_expand_to_path: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @path: path to a row. * * Expands the row at @path. This will also expand all parent rows of @@ -11527,7 +11527,7 @@ gtk_tree_view_real_expand_row (GtkTreeView *tree_view, /** * gtk_tree_view_expand_row: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @path: path to a row * @open_all: whether to recursively expand, or just expand immediate children * @@ -11666,7 +11666,7 @@ gtk_tree_view_real_collapse_row (GtkTreeView *tree_view, /** * gtk_tree_view_collapse_row: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @path: path to a row in the @tree_view * * Collapses a row (hides its child rows, if they exist). @@ -11727,7 +11727,7 @@ gtk_tree_view_map_expanded_rows_helper (GtkTreeView *tree_view, /** * gtk_tree_view_map_expanded_rows: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @func: (scope call): A function to be called * @data: User data to be passed to the function. * @@ -11755,8 +11755,8 @@ gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view, /** * gtk_tree_view_row_expanded: - * @tree_view: A #GtkTreeView. - * @path: A #GtkTreePath to test expansion state. + * @tree_view: A `GtkTreeView`. + * @path: A `GtkTreePath` to test expansion state. * * Returns %TRUE if the node pointed to by @path is expanded in @tree_view. * @@ -11782,7 +11782,7 @@ gtk_tree_view_row_expanded (GtkTreeView *tree_view, /** * gtk_tree_view_get_reorderable: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Retrieves whether the user can reorder the tree via drag-and-drop. See * gtk_tree_view_set_reorderable(). @@ -11801,16 +11801,16 @@ gtk_tree_view_get_reorderable (GtkTreeView *tree_view) /** * gtk_tree_view_set_reorderable: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @reorderable: %TRUE, if the tree can be reordered. * * This function is a convenience function to allow you to reorder - * models that support the #GtkTreeDragSourceIface and the - * #GtkTreeDragDestIface. Both #GtkTreeStore and #GtkListStore support + * models that support the `GtkTreeDragSourceIface` and the + * `GtkTreeDragDestIface`. Both `GtkTreeStore` and `GtkListStore` support * these. If @reorderable is %TRUE, then the user can reorder the * model by dragging and dropping rows. The developer can listen to - * these changes by connecting to the model’s #GtkTreeModel::row-inserted - * and #GtkTreeModel::row-deleted signals. The reordering is implemented + * these changes by connecting to the model’s `GtkTreeModel::row-inserted` + * and `GtkTreeModel::row-deleted` signals. The reordering is implemented * by setting up the tree view as a drag source and destination. * Therefore, drag and drop can not be used in a reorderable view for any * other purpose. @@ -11930,7 +11930,7 @@ gtk_tree_view_real_set_cursor (GtkTreeView *tree_view, /** * gtk_tree_view_get_cursor: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @path: (out) (transfer full) (optional) (nullable): A pointer to be * filled with the current cursor path * @focus_column: (out) (transfer none) (optional) (nullable): A @@ -11940,7 +11940,7 @@ gtk_tree_view_real_set_cursor (GtkTreeView *tree_view, * the cursor isn’t currently set, then *@path will be %NULL. If no column * currently has focus, then *@focus_column will be %NULL. * - * The returned #GtkTreePath must be freed with gtk_tree_path_free() when + * The returned `GtkTreePath` must be freed with gtk_tree_path_free() when * you are done with it. **/ void @@ -11969,9 +11969,9 @@ gtk_tree_view_get_cursor (GtkTreeView *tree_view, /** * gtk_tree_view_set_cursor: - * @tree_view: A #GtkTreeView - * @path: A #GtkTreePath - * @focus_column: (nullable): A #GtkTreeViewColumn + * @tree_view: A `GtkTreeView` + * @path: A `GtkTreePath` + * @focus_column: (nullable): A `GtkTreeViewColumn` * @start_editing: %TRUE if the specified cell should start being edited. * * Sets the current keyboard focus to be at @path, and selects it. This is @@ -11998,10 +11998,10 @@ gtk_tree_view_set_cursor (GtkTreeView *tree_view, /** * gtk_tree_view_set_cursor_on_cell: - * @tree_view: A #GtkTreeView - * @path: A #GtkTreePath - * @focus_column: (nullable): A #GtkTreeViewColumn - * @focus_cell: (nullable): A #GtkCellRenderer + * @tree_view: A `GtkTreeView` + * @path: A `GtkTreePath` + * @focus_column: (nullable): A `GtkTreeViewColumn` + * @focus_cell: (nullable): A `GtkCellRenderer` * @start_editing: %TRUE if the specified cell should start being edited. * * Sets the current keyboard focus to be at @path, and selects it. This is @@ -12074,13 +12074,13 @@ gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view, /** * gtk_tree_view_get_path_at_pos: - * @tree_view: A #GtkTreeView. + * @tree_view: A `GtkTreeView`. * @x: The x position to be identified (relative to bin_window). * @y: The y position to be identified (relative to bin_window). - * @path: (out) (optional) (nullable): A pointer to a #GtkTreePath + * @path: (out) (optional) (nullable): A pointer to a `GtkTreePath` * pointer to be filled in * @column: (out) (transfer none) (optional) (nullable): A pointer to - * a #GtkTreeViewColumn pointer to be filled in + * a `GtkTreeViewColumn` pointer to be filled in * @cell_x: (out) (optional): A pointer where the X coordinate * relative to the cell can be placed * @cell_y: (out) (optional): A pointer where the Y coordinate @@ -12091,7 +12091,7 @@ gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view, * coordinates must be converted using * gtk_tree_view_convert_widget_to_bin_window_coords(). It is primarily for * things like popup menus. If @path is non-%NULL, then it will be filled - * with the #GtkTreePath at that point. This path should be freed with + * with the `GtkTreePath` at that point. This path should be freed with * gtk_tree_path_free(). If @column is non-%NULL, then it will be filled * with the column at that point. @cell_x and @cell_y return the coordinates * relative to the cell background (i.e. the @background_area passed to @@ -12245,9 +12245,9 @@ gtk_tree_view_get_cell_area_y_offset (GtkTreeView *tree_view, /** * gtk_tree_view_get_cell_area: - * @tree_view: a #GtkTreeView - * @path: (nullable): a #GtkTreePath for the row, or %NULL to get only horizontal coordinates - * @column: (nullable): a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates + * @tree_view: a `GtkTreeView` + * @path: (nullable): a `GtkTreePath` for the row, or %NULL to get only horizontal coordinates + * @column: (nullable): a `GtkTreeViewColumn` for the column, or %NULL to get only vertical coordinates * @rect: (out): rectangle to fill with cell rect * * Fills the bounding rectangle in bin_window coordinates for the cell at the @@ -12371,9 +12371,9 @@ gtk_tree_view_get_row_y_offset (GtkTreeView *tree_view, /** * gtk_tree_view_get_background_area: - * @tree_view: a #GtkTreeView - * @path: (nullable): a #GtkTreePath for the row, or %NULL to get only horizontal coordinates - * @column: (nullable): a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates + * @tree_view: a `GtkTreeView` + * @path: (nullable): a `GtkTreePath` for the row, or %NULL to get only horizontal coordinates + * @column: (nullable): a `GtkTreeViewColumn` for the column, or %NULL to get only vertical coordinates * @rect: (out): rectangle to fill with cell background rect * * Fills the bounding rectangle in bin_window coordinates for the cell at the @@ -12428,7 +12428,7 @@ gtk_tree_view_get_background_area (GtkTreeView *tree_view, /** * gtk_tree_view_get_visible_rect: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @visible_rect: (out): rectangle to fill * * Fills @visible_rect with the currently-visible region of the @@ -12461,7 +12461,7 @@ gtk_tree_view_get_visible_rect (GtkTreeView *tree_view, /** * gtk_tree_view_convert_widget_to_tree_coords: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @wx: X coordinate relative to the widget * @wy: Y coordinate relative to the widget * @tx: (out): return location for tree X coordinate @@ -12491,7 +12491,7 @@ gtk_tree_view_convert_widget_to_tree_coords (GtkTreeView *tree_view, /** * gtk_tree_view_convert_tree_to_widget_coords: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @tx: X coordinate relative to the tree * @ty: Y coordinate relative to the tree * @wx: (out): return location for widget X coordinate @@ -12521,7 +12521,7 @@ gtk_tree_view_convert_tree_to_widget_coords (GtkTreeView *tree_view, /** * gtk_tree_view_convert_widget_to_bin_window_coords: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @wx: X coordinate relative to the widget * @wy: Y coordinate relative to the widget * @bx: (out): return location for bin_window X coordinate @@ -12548,7 +12548,7 @@ gtk_tree_view_convert_widget_to_bin_window_coords (GtkTreeView *tree_view, /** * gtk_tree_view_convert_bin_window_to_widget_coords: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @bx: bin_window X coordinate * @by: bin_window Y coordinate * @wx: (out): return location for widget X coordinate @@ -12575,7 +12575,7 @@ gtk_tree_view_convert_bin_window_to_widget_coords (GtkTreeView *tree_view, /** * gtk_tree_view_convert_tree_to_bin_window_coords: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @tx: tree X coordinate * @ty: tree Y coordinate * @bx: (out): return location for X coordinate relative to bin_window @@ -12603,7 +12603,7 @@ gtk_tree_view_convert_tree_to_bin_window_coords (GtkTreeView *tree_view, /** * gtk_tree_view_convert_bin_window_to_tree_coords: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @bx: X coordinate relative to bin_window * @by: Y coordinate relative to bin_window * @tx: (out): return location for tree X coordinate @@ -12693,13 +12693,13 @@ gtk_tree_view_get_visible_range (GtkTreeView *tree_view, /** * gtk_tree_view_is_blank_at_pos: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @x: The x position to be identified (relative to bin_window) * @y: The y position to be identified (relative to bin_window) - * @path: (out) (optional) (nullable): A pointer to a #GtkTreePath pointer to + * @path: (out) (optional) (nullable): A pointer to a `GtkTreePath` pointer to * be filled in * @column: (out) (transfer none) (optional) (nullable): A pointer to a - * #GtkTreeViewColumn pointer to be filled in + * `GtkTreeViewColumn` pointer to be filled in * @cell_x: (out) (optional): A pointer where the X coordinate relative to the * cell can be placed * @cell_y: (out) (optional): A pointer where the Y coordinate relative to the @@ -12811,14 +12811,14 @@ unset_reorderable (GtkTreeView *tree_view) /** * gtk_tree_view_enable_model_drag_source: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @start_button_mask: Mask of allowed buttons to start drag * @formats: the target formats that the drag will support * @actions: the bitmask of possible actions for a drag from this * widget * * Turns @tree_view into a drag source for automatic DND. Calling this - * method sets #GtkTreeView:reorderable to %FALSE. + * method sets `GtkTreeView`:reorderable to %FALSE. **/ void gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view, @@ -12844,13 +12844,13 @@ gtk_tree_view_enable_model_drag_source (GtkTreeView *tree_view, /** * gtk_tree_view_enable_model_drag_dest: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @formats: the target formats that the drag will support * @actions: the bitmask of possible actions for a drag from this * widget * * Turns @tree_view into a drop destination for automatic DND. Calling - * this method sets #GtkTreeView:reorderable to %FALSE. + * this method sets `GtkTreeView`:reorderable to %FALSE. **/ void gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view, @@ -12885,11 +12885,11 @@ gtk_tree_view_enable_model_drag_dest (GtkTreeView *tree_view, /** * gtk_tree_view_unset_rows_drag_source: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Undoes the effect of * gtk_tree_view_enable_model_drag_source(). Calling this method sets - * #GtkTreeView:reorderable to %FALSE. + * `GtkTreeView`:reorderable to %FALSE. **/ void gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view) @@ -12917,11 +12917,11 @@ gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view) /** * gtk_tree_view_unset_rows_drag_dest: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Undoes the effect of * gtk_tree_view_enable_model_drag_dest(). Calling this method sets - * #GtkTreeView:reorderable to %FALSE. + * `GtkTreeView`:reorderable to %FALSE. **/ void gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view) @@ -12953,7 +12953,7 @@ gtk_tree_view_unset_rows_drag_dest (GtkTreeView *tree_view) /** * gtk_tree_view_set_drag_dest_row: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @path: (nullable): The path of the row to highlight * @pos: Specifies whether to drop before, after or into the row * @@ -13019,7 +13019,7 @@ gtk_tree_view_set_drag_dest_row (GtkTreeView *tree_view, /** * gtk_tree_view_get_drag_dest_row: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @path: (out) (optional) (nullable): Return location for the path of the highlighted row * @pos: (out) (optional): Return location for the drop position * @@ -13053,7 +13053,7 @@ gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view, /** * gtk_tree_view_get_dest_row_at_pos: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @drag_x: the position to determine the destination row for * @drag_y: the position to determine the destination row for * @path: (out) (optional) (nullable): Return location for the path of @@ -13172,10 +13172,10 @@ gtk_treeview_snapshot_border (GtkSnapshot *snapshot, /* KEEP IN SYNC WITH GTK_TREE_VIEW_BIN_EXPOSE */ /** * gtk_tree_view_create_row_drag_icon: - * @tree_view: a #GtkTreeView - * @path: a #GtkTreePath in @tree_view + * @tree_view: a `GtkTreeView` + * @path: a `GtkTreePath` in @tree_view * - * Creates a #cairo_surface_t representation of the row at @path. + * Creates a `cairo_surface_t` representation of the row at @path. * This image is used for a drag icon. * * Returns: (transfer full) (nullable): a newly-allocated surface of the drag icon. @@ -13327,7 +13327,7 @@ gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view, /** * gtk_tree_view_set_enable_search: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @enable_search: %TRUE, if the user can search interactively * * If @enable_search is set, then the user can type in text to search through @@ -13355,7 +13355,7 @@ gtk_tree_view_set_enable_search (GtkTreeView *tree_view, /** * gtk_tree_view_get_enable_search: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * * Returns whether or not the tree allows to start interactive searching * by typing in text. @@ -13375,7 +13375,7 @@ gtk_tree_view_get_enable_search (GtkTreeView *tree_view) /** * gtk_tree_view_get_search_column: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * * Gets the column searched on by the interactive search code. * @@ -13393,7 +13393,7 @@ gtk_tree_view_get_search_column (GtkTreeView *tree_view) /** * gtk_tree_view_set_search_column: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @column: the column of the model to search in, or -1 to disable searching * * Sets @column as the column where the interactive search code should @@ -13424,7 +13424,7 @@ gtk_tree_view_set_search_column (GtkTreeView *tree_view, /** * gtk_tree_view_get_search_equal_func: (skip) - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * * Returns the compare function currently in use. * @@ -13443,14 +13443,14 @@ gtk_tree_view_get_search_equal_func (GtkTreeView *tree_view) /** * gtk_tree_view_set_search_equal_func: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @search_equal_func: the compare function to use during the search * @search_user_data: (nullable): user data to pass to @search_equal_func * @search_destroy: (nullable): Destroy notifier for @search_user_data * * Sets the compare function for the interactive search capabilities; note * that somewhat like strcmp() returning 0 for equality - * #GtkTreeViewSearchEqualFunc returns %FALSE on matches. + * `GtkTreeView`SearchEqualFunc returns %FALSE on matches. **/ void gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view, @@ -13475,9 +13475,9 @@ gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view, /** * gtk_tree_view_get_search_entry: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * - * Returns the #GtkEntry which is currently in use as interactive search + * Returns the `GtkEntry` which is currently in use as interactive search * entry for @tree_view. In case the built-in entry is being used, %NULL * will be returned. * @@ -13498,7 +13498,7 @@ gtk_tree_view_get_search_entry (GtkTreeView *tree_view) /** * gtk_tree_view_set_search_entry: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @entry: (nullable): the entry the interactive search code of @tree_view should use * * Sets the entry which the interactive search code will use for this @@ -14168,7 +14168,7 @@ gtk_tree_view_stop_editing (GtkTreeView *tree_view, /** * gtk_tree_view_set_hover_selection: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @hover: %TRUE to enable hover selection mode * * Enables or disables the hover selection mode of @tree_view. @@ -14194,7 +14194,7 @@ gtk_tree_view_set_hover_selection (GtkTreeView *tree_view, /** * gtk_tree_view_get_hover_selection: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns whether hover selection mode is turned on for @tree_view. * @@ -14212,7 +14212,7 @@ gtk_tree_view_get_hover_selection (GtkTreeView *tree_view) /** * gtk_tree_view_set_hover_expand: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @expand: %TRUE to enable hover selection mode * * Enables or disables the hover expansion mode of @tree_view. @@ -14237,7 +14237,7 @@ gtk_tree_view_set_hover_expand (GtkTreeView *tree_view, /** * gtk_tree_view_get_hover_expand: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns whether hover expansion mode is turned on for @tree_view. * @@ -14255,11 +14255,11 @@ gtk_tree_view_get_hover_expand (GtkTreeView *tree_view) /** * gtk_tree_view_set_rubber_banding: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @enable: %TRUE to enable rubber banding * * Enables or disables rubber banding in @tree_view. If the selection mode - * is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select + * is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select * multiple rows by dragging the mouse. **/ void @@ -14280,10 +14280,10 @@ gtk_tree_view_set_rubber_banding (GtkTreeView *tree_view, /** * gtk_tree_view_get_rubber_banding: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns whether rubber banding is turned on for @tree_view. If the - * selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the + * selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the * user to select multiple rows by dragging the mouse. * * Returns: %TRUE if rubber banding in @tree_view is enabled. @@ -14298,7 +14298,7 @@ gtk_tree_view_get_rubber_banding (GtkTreeView *tree_view) /** * gtk_tree_view_is_rubber_banding_active: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns whether a rubber banding operation is currently being done * in @tree_view. @@ -14322,7 +14322,7 @@ gtk_tree_view_is_rubber_banding_active (GtkTreeView *tree_view) /** * gtk_tree_view_get_row_separator_func: (skip) - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns the current row separator function. * @@ -14340,8 +14340,8 @@ gtk_tree_view_get_row_separator_func (GtkTreeView *tree_view) /** * gtk_tree_view_set_row_separator_func: - * @tree_view: a #GtkTreeView - * @func: (nullable): a #GtkTreeViewRowSeparatorFunc + * @tree_view: a `GtkTreeView` + * @func: (nullable): a `GtkTreeView`RowSeparatorFunc * @data: (nullable): user data to pass to @func * @destroy: (nullable): destroy notifier for @data * @@ -14373,11 +14373,11 @@ gtk_tree_view_set_row_separator_func (GtkTreeView *tree_view, /** * gtk_tree_view_get_grid_lines: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns which grid lines are enabled in @tree_view. * - * Returns: a #GtkTreeViewGridLines value indicating which grid lines + * Returns: a `GtkTreeView`GridLines value indicating which grid lines * are enabled. */ GtkTreeViewGridLines @@ -14392,8 +14392,8 @@ gtk_tree_view_get_grid_lines (GtkTreeView *tree_view) /** * gtk_tree_view_set_grid_lines: - * @tree_view: a #GtkTreeView - * @grid_lines: a #GtkTreeViewGridLines value indicating which grid lines to + * @tree_view: a `GtkTreeView` + * @grid_lines: a `GtkTreeView`GridLines value indicating which grid lines to * enable. * * Sets which grid lines to draw in @tree_view. @@ -14420,7 +14420,7 @@ gtk_tree_view_set_grid_lines (GtkTreeView *tree_view, /** * gtk_tree_view_get_enable_tree_lines: - * @tree_view: a #GtkTreeView. + * @tree_view: a `GtkTreeView`. * * Returns whether or not tree lines are drawn in @tree_view. * @@ -14439,7 +14439,7 @@ gtk_tree_view_get_enable_tree_lines (GtkTreeView *tree_view) /** * gtk_tree_view_set_enable_tree_lines: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @enabled: %TRUE to enable tree line drawing, %FALSE otherwise. * * Sets whether to draw lines interconnecting the expanders in @tree_view. @@ -14471,7 +14471,7 @@ gtk_tree_view_set_enable_tree_lines (GtkTreeView *tree_view, /** * gtk_tree_view_set_show_expanders: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @enabled: %TRUE to enable expander drawing, %FALSE otherwise. * * Sets whether to draw and enable expanders and indent child rows in @@ -14501,7 +14501,7 @@ gtk_tree_view_set_show_expanders (GtkTreeView *tree_view, /** * gtk_tree_view_get_show_expanders: - * @tree_view: a #GtkTreeView. + * @tree_view: a `GtkTreeView`. * * Returns whether or not expanders are drawn in @tree_view. * @@ -14520,7 +14520,7 @@ gtk_tree_view_get_show_expanders (GtkTreeView *tree_view) /** * gtk_tree_view_set_level_indentation: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @indentation: the amount, in pixels, of extra indentation in @tree_view. * * Sets the amount of extra indentation for child levels to use in @tree_view @@ -14542,7 +14542,7 @@ gtk_tree_view_set_level_indentation (GtkTreeView *tree_view, /** * gtk_tree_view_get_level_indentation: - * @tree_view: a #GtkTreeView. + * @tree_view: a `GtkTreeView`. * * Returns the amount, in pixels, of extra indentation for child levels * in @tree_view. @@ -14562,9 +14562,9 @@ gtk_tree_view_get_level_indentation (GtkTreeView *tree_view) /** * gtk_tree_view_set_tooltip_row: - * @tree_view: a #GtkTreeView - * @tooltip: a #GtkTooltip - * @path: a #GtkTreePath + * @tree_view: a `GtkTreeView` + * @tooltip: a `GtkTooltip` + * @path: a `GtkTreePath` * * Sets the tip area of @tooltip to be the area covered by the row at @path. * See also gtk_tree_view_set_tooltip_column() for a simpler alternative. @@ -14583,11 +14583,11 @@ gtk_tree_view_set_tooltip_row (GtkTreeView *tree_view, /** * gtk_tree_view_set_tooltip_cell: - * @tree_view: a #GtkTreeView - * @tooltip: a #GtkTooltip - * @path: (nullable): a #GtkTreePath - * @column: (nullable): a #GtkTreeViewColumn - * @cell: (nullable): a #GtkCellRenderer + * @tree_view: a `GtkTreeView` + * @tooltip: a `GtkTooltip` + * @path: (nullable): a `GtkTreePath` + * @column: (nullable): a `GtkTreeViewColumn` + * @cell: (nullable): a `GtkCellRenderer` * * Sets the tip area of @tooltip to the area @path, @column and @cell have * in common. For example if @path is %NULL and @column is set, the tip @@ -14801,16 +14801,16 @@ gtk_tree_view_set_tooltip_query_cb (GtkWidget *widget, /** * gtk_tree_view_set_tooltip_column: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * @column: an integer, which is a valid column number for @tree_view’s model * * If you only plan to have simple (text-only) tooltips on full rows, you - * can use this function to have #GtkTreeView handle these automatically + * can use this function to have `GtkTreeView` handle these automatically * for you. @column should be set to the column in @tree_view’s model * containing the tooltip texts, or -1 to disable this feature. * - * When enabled, #GtkWidget:has-tooltip will be set to %TRUE and - * @tree_view will connect a #GtkWidget::query-tooltip signal handler. + * When enabled, `GtkWidget:has-tooltip` will be set to %TRUE and + * @tree_view will connect a `GtkWidget::query-tooltip` signal handler. * * Note that the signal handler sets the text with gtk_tooltip_set_markup(), * so &, <, etc have to be escaped in the text. @@ -14849,7 +14849,7 @@ gtk_tree_view_set_tooltip_column (GtkTreeView *tree_view, /** * gtk_tree_view_get_tooltip_column: - * @tree_view: a #GtkTreeView + * @tree_view: a `GtkTreeView` * * Returns the column of @tree_view’s model which is being used for * displaying tooltips on @tree_view’s rows. diff --git a/gtk/gtktreeview.h b/gtk/gtktreeview.h index 0910ad23ac..878b4b0b44 100644 --- a/gtk/gtktreeview.h +++ b/gtk/gtktreeview.h @@ -63,10 +63,10 @@ typedef struct _GtkTreeSelection GtkTreeSelection; /** * GtkTreeViewColumnDropFunc: - * @tree_view: A #GtkTreeView - * @column: The #GtkTreeViewColumn being dragged - * @prev_column: A #GtkTreeViewColumn on one side of @column - * @next_column: A #GtkTreeViewColumn on the other side of @column + * @tree_view: A `GtkTreeView` + * @column: The `GtkTreeViewColumn` being dragged + * @prev_column: A `GtkTreeViewColumn` on one side of @column + * @next_column: A `GtkTreeViewColumn` on the other side of @column * @data: (closure): user data * * Function type for determining whether @column can be dropped in a @@ -88,7 +88,7 @@ typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView *tree_vi /** * GtkTreeViewMappingFunc: - * @tree_view: A #GtkTreeView + * @tree_view: A `GtkTreeView` * @path: The path that’s expanded * @user_data: user data * @@ -100,10 +100,10 @@ typedef void (* GtkTreeViewMappingFunc) (GtkTreeView *tree_vi /** * GtkTreeViewSearchEqualFunc: - * @model: the #GtkTreeModel being searched + * @model: the `GtkTreeModel` being searched * @column: the search column set by gtk_tree_view_set_search_column() * @key: the key string to compare with - * @iter: a #GtkTreeIter pointing the row of @model that should be compared + * @iter: a `GtkTreeIter` pointing the row of @model that should be compared * with @key. * @search_data: (closure): user data from gtk_tree_view_set_search_equal_func() * @@ -122,13 +122,13 @@ typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel *model, /** * GtkTreeViewRowSeparatorFunc: - * @model: the #GtkTreeModel - * @iter: a #GtkTreeIter pointing at a row in @model + * @model: the `GtkTreeModel` + * @iter: a `GtkTreeIter` pointing at a row in @model * @data: (closure): user data * * Function type for determining whether the row pointed to by @iter should * be rendered as a separator. A common way to implement this is to have a - * boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc + * boolean column in the model, whose values the `GtkTreeViewRowSeparatorFunc` * returns. * * Returns: %TRUE if the row is a separator diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c index 46350b5dbb..66ac2ad02e 100644 --- a/gtk/gtktreeviewcolumn.c +++ b/gtk/gtktreeviewcolumn.c @@ -48,13 +48,13 @@ * * A visible column in a GtkTreeView widget * - * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget. + * The GtkTreeViewColumn object represents a visible column in a `GtkTreeView` widget. * It allows to set properties of the column header, and functions as a holding pen * for the cell renderers which determine how the data in the column is displayed. * * Please refer to the [tree widget conceptual overview][TreeWidget] * for an overview of all the objects and data types related to the tree widget and - * how they work together, and to the #GtkTreeView documentation for specifics about + * how they work together, and to the `GtkTreeView` documentation for specifics about * the CSS node structure for treeviews and their headers. */ @@ -258,7 +258,7 @@ gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class) /** * GtkTreeViewColumn::clicked: - * @column: the #GtkTreeViewColumn that emitted the signal + * @column: the `GtkTreeViewColumn` that emitted the signal * * Emitted when the column's header has been clicked. */ @@ -415,10 +415,10 @@ gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class) /** * GtkTreeViewColumn:cell-area: * - * The #GtkCellArea used to layout cell renderers for this column. + * The `GtkCellArea` used to layout cell renderers for this column. * * If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area() - * a horizontally oriented #GtkCellAreaBox will be used. + * a horizontally oriented `GtkCellAreaBox` will be used. */ tree_column_props[PROP_CELL_AREA] = g_param_spec_object ("cell-area", @@ -1487,9 +1487,9 @@ _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column, /** * gtk_tree_view_column_new: * - * Creates a new #GtkTreeViewColumn. + * Creates a new `GtkTreeViewColumn`. * - * Returns: A newly created #GtkTreeViewColumn. + * Returns: A newly created `GtkTreeViewColumn`. **/ GtkTreeViewColumn * gtk_tree_view_column_new (void) @@ -1503,11 +1503,11 @@ gtk_tree_view_column_new (void) /** * gtk_tree_view_column_new_with_area: - * @area: the #GtkCellArea that the newly created column should use to layout cells. + * @area: the `GtkCellArea` that the newly created column should use to layout cells. * - * Creates a new #GtkTreeViewColumn using @area to render its cells. + * Creates a new `GtkTreeViewColumn` using @area to render its cells. * - * Returns: A newly created #GtkTreeViewColumn. + * Returns: A newly created `GtkTreeViewColumn`. */ GtkTreeViewColumn * gtk_tree_view_column_new_with_area (GtkCellArea *area) @@ -1523,13 +1523,13 @@ gtk_tree_view_column_new_with_area (GtkCellArea *area) /** * gtk_tree_view_column_new_with_attributes: * @title: The title to set the header to - * @cell: The #GtkCellRenderer + * @cell: The `GtkCellRenderer` * @...: A %NULL-terminated list of attributes * - * Creates a new #GtkTreeViewColumn with a number of default values. + * Creates a new `GtkTreeViewColumn` with a number of default values. * This is equivalent to calling gtk_tree_view_column_set_title(), * gtk_tree_view_column_pack_start(), and - * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn. + * gtk_tree_view_column_set_attributes() on the newly created `GtkTreeViewColumn`. * * Here’s a simple example: * |[<!-- language="C" --> @@ -1547,7 +1547,7 @@ gtk_tree_view_column_new_with_area (GtkCellArea *area) * } * ]| * - * Returns: A newly created #GtkTreeViewColumn. + * Returns: A newly created `GtkTreeViewColumn`. **/ GtkTreeViewColumn * gtk_tree_view_column_new_with_attributes (const char *title, @@ -1571,8 +1571,8 @@ gtk_tree_view_column_new_with_attributes (const char *title, /** * gtk_tree_view_column_pack_start: - * @tree_column: A #GtkTreeViewColumn. - * @cell: The #GtkCellRenderer. + * @tree_column: A `GtkTreeViewColumn`. + * @cell: The `GtkCellRenderer` * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column. * * Packs the @cell into the beginning of the column. If @expand is %FALSE, then @@ -1589,8 +1589,8 @@ gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_pack_end: - * @tree_column: A #GtkTreeViewColumn. - * @cell: The #GtkCellRenderer. + * @tree_column: A `GtkTreeViewColumn`. + * @cell: The `GtkCellRenderer` * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column. * * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell @@ -1607,7 +1607,7 @@ gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_clear: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * * Unsets all the mappings on all renderers on the @tree_column. **/ @@ -1619,16 +1619,18 @@ gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_add_attribute: - * @tree_column: A #GtkTreeViewColumn. - * @cell_renderer: the #GtkCellRenderer to set attributes on + * @tree_column: A `GtkTreeViewColumn` + * @cell_renderer: the `GtkCellRenderer` to set attributes on * @attribute: An attribute on the renderer * @column: The column position on the model to get the attribute from. * - * Adds an attribute mapping to the list in @tree_column. The @column is the + * Adds an attribute mapping to the list in @tree_column. + * + * The @column is the * column of the model to get a value from, and the @attribute is the * parameter on @cell_renderer to be set from the value. So for example * if column 2 of the model contains strings, you could have the - * “text” attribute of a #GtkCellRendererText get its values from + * “text” attribute of a `GtkCellRendererText` get its values from * column 2. **/ void @@ -1666,11 +1668,12 @@ gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_set_attributes: - * @tree_column: A #GtkTreeViewColumn - * @cell_renderer: the #GtkCellRenderer we’re setting the attributes of + * @tree_column: A `GtkTreeViewColumn` + * @cell_renderer: the `GtkCellRenderer` we’re setting the attributes of * @...: A %NULL-terminated list of attributes * * Sets the attributes in the list as the attributes of @tree_column. + * * The attributes should be in attribute/column order, as in * gtk_tree_view_column_add_attribute(). All existing attributes * are removed, and replaced with the new attributes. @@ -1693,13 +1696,15 @@ gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_set_cell_data_func: - * @tree_column: A #GtkTreeViewColumn - * @cell_renderer: A #GtkCellRenderer - * @func: (nullable): The #GtkTreeCellDataFunc to use. + * @tree_column: A `GtkTreeViewColumn` + * @cell_renderer: A `GtkCellRenderer` + * @func: (nullable): The `GtkTreeCellDataFunc` to use. * @func_data: (closure): The user data for @func. * @destroy: The destroy notification for @func_data * - * Sets the #GtkTreeCellDataFunc to use for the column. This + * Sets the `GtkTreeCellDataFunc` to use for the column. + * + * This * function is used instead of the standard attributes mapping for * setting the column value, and should set the value of @tree_column's * cell renderer as appropriate. @func may be %NULL to remove an @@ -1721,9 +1726,9 @@ gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_clear_attributes: - * @tree_column: a #GtkTreeViewColumn - * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on. - * + * @tree_column: a `GtkTreeViewColumn` + * @cell_renderer: a `GtkCellRenderer` to clear the attribute mapping on. + * * Clears all existing attributes previously set with * gtk_tree_view_column_set_attributes(). **/ @@ -1737,7 +1742,7 @@ gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_set_spacing: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @spacing: distance between cell renderers in pixels. * * Sets the spacing field of @tree_column, which is the number of pixels to @@ -1765,7 +1770,7 @@ gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_spacing: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the spacing of @tree_column. * @@ -1787,7 +1792,7 @@ gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_visible: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @visible: %TRUE if the @tree_column is visible. * * Sets the visibility of @tree_column. @@ -1819,7 +1824,7 @@ gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_visible: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns %TRUE if @tree_column is visible. * @@ -1836,13 +1841,15 @@ gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_resizable: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * @resizable: %TRUE, if the column can be resized * * If @resizable is %TRUE, then the user can explicitly resize the column by - * grabbing the outer edge of the column button. If resizable is %TRUE and - * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing - * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY. + * grabbing the outer edge of the column button. + * + * If resizable is %TRUE and + * sizing mode of the column is %GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing + * mode is changed to %GTK_TREE_VIEW_COLUMN_GROW_ONLY. **/ void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column, @@ -1870,7 +1877,7 @@ gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_resizable: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * * Returns %TRUE if the @tree_column can be resized by the end user. * @@ -1887,8 +1894,8 @@ gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_sizing: - * @tree_column: A #GtkTreeViewColumn. - * @type: The #GtkTreeViewColumnSizing. + * @tree_column: A `GtkTreeViewColumn`. + * @type: The `GtkTreeViewColumn`Sizing. * * Sets the growth behavior of @tree_column to @type. **/ @@ -1917,7 +1924,7 @@ gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_sizing: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the current type of @tree_column. * @@ -1933,7 +1940,7 @@ gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_get_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the current size of @tree_column in pixels. * @@ -1949,7 +1956,7 @@ gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_get_x_offset: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the current X offset of @tree_column in pixels. * @@ -2048,14 +2055,14 @@ _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_set_fixed_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @fixed_width: The new fixed width, in pixels, or -1. * * If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise * unsets it. The effective value of @fixed_width is clamped between the * minimum and maximum width of the column; however, the value stored in the * “fixed-width” property is not clamped. If the column sizing is - * #GTK_TREE_VIEW_COLUMN_GROW_ONLY or #GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting + * %GTK_TREE_VIEW_COLUMN_GROW_ONLY or %GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting * a fixed width overrides the automatically calculated width. Note that * @fixed_width is only a hint to GTK; the width actually allocated to the * column may be greater or less than requested. @@ -2088,7 +2095,7 @@ gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_fixed_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Gets the fixed width of the column. This may not be the actual displayed * width of the column; for that, use gtk_tree_view_column_get_width(). @@ -2105,7 +2112,7 @@ gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_min_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @min_width: The minimum width of the column in pixels, or -1. * * Sets the minimum width of the @tree_column. If @min_width is -1, then the @@ -2150,7 +2157,7 @@ gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_min_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum * width is set. @@ -2167,7 +2174,7 @@ gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_max_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @max_width: The maximum width of the column in pixels, or -1. * * Sets the maximum width of the @tree_column. If @max_width is -1, then the @@ -2214,7 +2221,7 @@ gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_max_width: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum * width is set. @@ -2231,7 +2238,7 @@ gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_clicked: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * * Emits the “clicked” signal on the column. This function will only work if * @tree_column is clickable. @@ -2251,7 +2258,7 @@ gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_title: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @title: The title of the @tree_column. * * Sets the title of the @tree_column. If a custom widget has been set, then @@ -2278,7 +2285,7 @@ gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_title: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the title of the widget. * @@ -2295,7 +2302,7 @@ gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_expand: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @expand: %TRUE if the column should expand to fill available space. * * Sets the column to take available extra space. This space is shared equally @@ -2333,7 +2340,7 @@ gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_expand: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns %TRUE if the column expands to fill available space. * @@ -2349,7 +2356,7 @@ gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_clickable: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @clickable: %TRUE if the header is active. * * Sets the header to be active if @clickable is %TRUE. When the header is @@ -2376,7 +2383,7 @@ gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_clickable: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * * Returns %TRUE if the user can click on the header for the column. * @@ -2392,11 +2399,11 @@ gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_widget: - * @tree_column: A #GtkTreeViewColumn. - * @widget: (nullable): A child #GtkWidget + * @tree_column: A `GtkTreeViewColumn`. + * @widget: (nullable): A child `GtkWidget` * * Sets the widget in the header to be @widget. If widget is %NULL, then the - * header button is set with a #GtkLabel set to the title of @tree_column. + * header button is set with a `GtkLabel` set to the title of @tree_column. **/ void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column, @@ -2440,7 +2447,7 @@ gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_alignment: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @xalign: The alignment, which is between [0.0 and 1.0] inclusive. * * Sets the alignment of the title or custom widget inside the column header. @@ -2469,7 +2476,7 @@ gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_alignment: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * * Returns the current x alignment of @tree_column. This value can range * between 0.0 and 1.0. @@ -2486,7 +2493,7 @@ gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_reorderable: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * @reorderable: %TRUE, if the column can be reordered. * * If @reorderable is %TRUE, then the column can be reordered by the end user @@ -2515,7 +2522,7 @@ gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_reorderable: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * * Returns %TRUE if the @tree_column can be reordered by the user. * @@ -2532,7 +2539,7 @@ gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_sort_column_id: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * @sort_column_id: The @sort_column_id of the model to sort on. * * Sets the logical @sort_column_id that this column sorts on when this column @@ -2612,7 +2619,7 @@ gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_sort_indicator: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * @setting: %TRUE to display an indicator that the column is sorted * * Call this function with a @setting of %TRUE to display an arrow in @@ -2639,7 +2646,7 @@ gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_sort_indicator: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * * Gets the value set by gtk_tree_view_column_set_sort_indicator(). * @@ -2655,7 +2662,7 @@ gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_sort_order: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * @order: sort order that the sort indicator should indicate * * Changes the appearance of the sort indicator. @@ -2686,7 +2693,7 @@ gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_get_sort_order: - * @tree_column: a #GtkTreeViewColumn + * @tree_column: a `GtkTreeViewColumn` * * Gets the value set by gtk_tree_view_column_set_sort_order(). * @@ -2702,16 +2709,16 @@ gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_cell_set_cell_data: - * @tree_column: A #GtkTreeViewColumn. - * @tree_model: The #GtkTreeModel to get the cell renderers attributes from. - * @iter: The #GtkTreeIter to get the cell renderer’s attributes from. + * @tree_column: A `GtkTreeViewColumn`. + * @tree_model: The `GtkTreeModel` to get the cell renderers attributes from. + * @iter: The `GtkTreeIter` to get the cell renderer’s attributes from. * @is_expander: %TRUE, if the row has children * @is_expanded: %TRUE, if the row has visible children * * Sets the cell renderer based on the @tree_model and @iter. That is, for * every attribute mapping in @tree_column, it will get a value from the set * column on the @iter, and use that value to set the attribute on the cell - * renderer. This is used primarily by the #GtkTreeView. + * renderer. This is used primarily by the `GtkTreeView`. **/ void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column, @@ -2731,14 +2738,14 @@ gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_cell_get_size: - * @tree_column: A #GtkTreeViewColumn. + * @tree_column: A `GtkTreeViewColumn`. * @x_offset: (out) (optional): location to return x offset of a cell relative to @cell_area * @y_offset: (out) (optional): location to return y offset of a cell relative to @cell_area * @width: (out) (optional): location to return width needed to render a cell * @height: (out) (optional): location to return height needed to render a cell * * Obtains the width and height needed to render the column. This is used - * primarily by the #GtkTreeView. + * primarily by the `GtkTreeView`. **/ void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column, @@ -2784,14 +2791,14 @@ gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_cell_snapshot: - * @tree_column: A #GtkTreeViewColumn. - * @snapshot: #GtkSnapshot to draw to + * @tree_column: A `GtkTreeViewColumn`. + * @snapshot: `GtkSnapshot` to draw to * @background_area: entire cell area (including tree expanders and maybe padding on the sides) * @cell_area: area normally rendered by a cell renderer * @flags: flags that affect rendering * * Renders the cell contained by #tree_column. This is used primarily by the - * #GtkTreeView. + * `GtkTreeView`. **/ void gtk_tree_view_column_cell_snapshot (GtkTreeViewColumn *tree_column, @@ -2838,7 +2845,7 @@ _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_cell_is_visible: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * * Returns %TRUE if any of the cells packed into the @tree_column are visible. * For this to be meaningful, you must first initialize the cells with @@ -2874,8 +2881,8 @@ gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_focus_cell: - * @tree_column: A #GtkTreeViewColumn - * @cell: A #GtkCellRenderer + * @tree_column: A `GtkTreeViewColumn` + * @cell: A `GtkCellRenderer` * * Sets the current keyboard focus to be at @cell, if the column contains * 2 or more editable and activatable cells. @@ -2977,7 +2984,7 @@ gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_queue_resize: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * * Flags the column, and the cell renderers added to this column, to have * their sizes renegotiated. @@ -2993,9 +3000,9 @@ gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_get_tree_view: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * - * Returns the #GtkTreeView wherein @tree_column has been inserted. + * Returns the `GtkTreeView` wherein @tree_column has been inserted. * If @column is currently not inserted in any tree view, %NULL is * returned. * @@ -3012,7 +3019,7 @@ gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_get_button: - * @tree_column: A #GtkTreeViewColumn + * @tree_column: A `GtkTreeViewColumn` * * Returns the button used in the treeview column header * diff --git a/gtk/gtktreeviewcolumn.h b/gtk/gtktreeviewcolumn.h index cac13b4cdc..ae13503a0a 100644 --- a/gtk/gtktreeviewcolumn.h +++ b/gtk/gtktreeviewcolumn.h @@ -56,10 +56,10 @@ typedef enum /** * GtkTreeCellDataFunc: - * @tree_column: A #GtkTreeViewColumn - * @cell: The #GtkCellRenderer that is being rendered by @tree_column - * @tree_model: The #GtkTreeModel being rendered - * @iter: A #GtkTreeIter of the current row rendered + * @tree_column: A `GtkTreeViewColumn` + * @cell: The `GtkCellRenderer` that is being rendered by @tree_column + * @tree_model: The `GtkTreeModel` being rendered + * @iter: A `GtkTreeIter` of the current row rendered * @data: (closure): user data * * A function to set the properties of a cell instead of just using the diff --git a/gtk/gtktypes.h b/gtk/gtktypes.h index 342b62c843..79720618f0 100644 --- a/gtk/gtktypes.h +++ b/gtk/gtktypes.h @@ -59,12 +59,15 @@ typedef struct _GtkWindow GtkWindow; /** * GTK_INVALID_LIST_POSITION: * - * The value used to refer to a guaranteed invalid position in a #GListModel. This - * value may be returned from some functions, others may accept it as input. - * Its interpretation may differ for different functions. + * The value used to refer to a guaranteed invalid position + * in a `GListModel`. * - * Refer to each function's documentation for if this value is allowed and what it - * does. + * This value may be returned from some functions, others may + * accept it as input. Its interpretation may differ for different + * functions. + * + * Refer to each function's documentation for if this value is + * allowed and what it does. */ #define GTK_INVALID_LIST_POSITION (0xffffffffU) diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c index 4015465632..7b106f6c85 100644 --- a/gtk/gtkwidget.c +++ b/gtk/gtkwidget.c @@ -1920,7 +1920,7 @@ gtk_widget_class_init (GtkWidgetClass *klass) * @y: the y coordinate of the cursor position where the request has * been emitted, relative to @widget's top * @keyboard_mode: %TRUE if the tooltip was triggered using the keyboard - * @tooltip: a #GtkTooltip + * @tooltip: a `GtkTooltip` * * Emitted when the widgets tooltip is about to be shown. * @@ -3027,7 +3027,7 @@ static guint tick_callback_id; * frame or every few frames. The tick callback does not automatically * imply a relayout or repaint. If you want a repaint or relayout, and * aren’t changing widget properties that would trigger that (for example, - * changing the text of a #GtkLabel), then you will have to call + * changing the text of a `GtkLabel`), then you will have to call * [method@Gtk.Widget.queue_resize] or [method@Gtk.Widget.queue_draw] * yourself. * @@ -6479,7 +6479,7 @@ gtk_widget_update_pango_context (GtkWidget *widget) /** * gtk_widget_set_font_options: * @widget: a `GtkWidget` - * @options: (nullable): a #cairo_font_options_t + * @options: (nullable): a `cairo_font_options_t` * to unset any previously set default font options * * Sets the `cairo_font_options_t` used for Pango rendering @@ -6907,7 +6907,7 @@ gtk_widget_child_focus (GtkWidget *widget, * * The default [signal@Gtk.Widget::keynav-failed] handler returns * %FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. - * For the other values of #GtkDirectionType it returns %TRUE. + * For the other values of `GtkDirectionType` it returns %TRUE. * * Whenever the default handler returns %TRUE, it also calls * [method@Gtk.Widget.error_bell] to notify the user of the @@ -7773,7 +7773,7 @@ gtk_widget_adjust_baseline_request (GtkWidget *widget, * _gtk_widget_list_devices: * @widget: a `GtkWidget` * - * Returns the list of pointer #GdkDevices that are currently + * Returns the list of pointer `GdkDevice`s that are currently * on top of @widget. Free the list * with g_free(), the elements are owned by GTK and must * not be freed. @@ -7808,7 +7808,7 @@ _gtk_widget_list_devices (GtkWidget *widget, * _gtk_widget_synthesize_crossing: * @from: the `GtkWidget` the virtual pointer is leaving. * @to: the `GtkWidget` the virtual pointer is moving to. - * @mode: the #GdkCrossingMode to place on the synthesized events. + * @mode: the `GdkCrossingMode` to place on the synthesized events. * * Generate crossing event(s) on widget state (sensitivity) or GTK grab change. */ @@ -11254,7 +11254,7 @@ gtk_widget_class_bind_template_child_full (GtkWidgetClass *widget_class, /** * gtk_widget_get_template_child: * @widget: A `GtkWidget` - * @widget_type: The #GType to get a template child for + * @widget_type: The `GType` to get a template child for * @name: The “id” of the child defined in the template XML * * Fetch an object build from the template XML for @widget_type in @@ -11427,7 +11427,7 @@ gtk_widget_cancel_event_sequence (GtkWidget *widget, /** * gtk_widget_add_controller: * @widget: a `GtkWidget` - * @controller: (transfer full): a #GtkEventController that hasn't been + * @controller: (transfer full): a `GtkEventController` that hasn't been * added to a widget yet * * Adds @controller to @widget so that it will receive events. @@ -11456,7 +11456,7 @@ gtk_widget_add_controller (GtkWidget *widget, /** * gtk_widget_remove_controller: * @widget: a `GtkWidget` - * @controller: (transfer none): a #GtkEventController + * @controller: (transfer none): a `GtkEventController` * * Removes @controller from @widget, so that it doesn't process * events anymore. diff --git a/gtk/gtkwidget.h b/gtk/gtkwidget.h index 53f218b133..fd1cc031f5 100644 --- a/gtk/gtkwidget.h +++ b/gtk/gtkwidget.h @@ -86,7 +86,7 @@ typedef gboolean (*GtkTickCallback) (GtkWidget *widget, * @width: the widget’s desired width * @height: the widget’s desired height * - * A #GtkRequisition-struct represents the desired size of a widget. See + * A `GtkRequisition` represents the desired size of a widget. See * [GtkWidget’s geometry management section][geometry-management] for * more information. */ @@ -126,14 +126,16 @@ struct _GtkWidget * means that either it or any of its parents up to the toplevel * widget have been set as hidden. * @realize: Signal emitted when widget is associated with a - * #GdkSurface, which means that gtk_widget_realize() has been called or + * `GdkSurface`, which means that gtk_widget_realize() has been called or * the widget has been mapped (that is, it is going to be drawn). * @unrealize: Signal emitted when the GdkSurface associated with * widget is destroyed, which means that gtk_widget_unrealize() has * been called or the widget has been unmapped (that is, it is going * to be hidden). - * @root: Called when the widget gets added to a #GtkRoot widget. Must chain up - * @unroot: Called when the widget is about to be removed from its #GtkRoot widget. Must chain up + * @root: Called when the widget gets added to a `GtkRoot` widget. Must + * chain up + * @unroot: Called when the widget is about to be removed from its + * `GtkRoot` widget. Must chain up * @size_allocate: Called to set the allocation, if the widget does * not have a layout manager. * @state_flags_changed: Signal emitted when the widget state changes, @@ -146,14 +148,14 @@ struct _GtkWidget * it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode. * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have - * #GtkWidgetClass.measure() called first to get the default width (passing + * `GtkWidgetClass.measure()` called first to get the default width (passing * a for_size of -1), then again to get the height for said default width. * %GTK_SIZE_REQUEST_CONSTANT_SIZE disables any height-for-width or * width-for-height geometry management for said widget and is the * default return. * It’s important to note that any widget * which trades height-for-width or width-for-height must respond properly - * to a for_size value >= -1 passed to #GtkWidgetClass.measure, for both + * to a for_size value >= -1 passed to `GtkWidgetClass.measure`, for both * possible orientations. * @measure: Called to obtain the minimum and natural size of the widget, * if the widget does not have a layout manager. @@ -163,7 +165,7 @@ struct _GtkWidget * @mnemonic_activate: Activates the @widget if @group_cycling is * %FALSE, and just grabs the focus if @group_cycling is %TRUE. * @grab_focus: Causes @widget to have the keyboard focus for the - * #GtkWindow it’s inside. + * `GtkWindow` it’s inside. * @focus: Vfunc for gtk_widget_child_focus() * @set_focus_child: Sets the focused child of a widget. Must chain up * @move_focus: Signal emitted when a change of focus is requested @@ -725,7 +727,7 @@ void gtk_widget_remove_tick_callback (GtkWidget *widget, /** * gtk_widget_class_bind_template_callback: - * @widget_class: a #GtkWidgetClass + * @widget_class: a `GtkWidgetClass` * @callback: the callback symbol * * Binds a callback function defined in a template to the @widget_class. @@ -742,7 +744,7 @@ void gtk_widget_remove_tick_callback (GtkWidget *widget, /** * gtk_widget_class_bind_template_child: - * @widget_class: a #GtkWidgetClass + * @widget_class: a `GtkWidgetClass` * @TypeName: the type name of this widget * @member_name: name of the instance member in the instance struct for @data_type * @@ -762,7 +764,7 @@ void gtk_widget_remove_tick_callback (GtkWidget *widget, /** * gtk_widget_class_bind_template_child_internal: - * @widget_class: a #GtkWidgetClass + * @widget_class: a `GtkWidgetClass` * @TypeName: the type name, in CamelCase * @member_name: name of the instance member in the instance struct for @data_type * @@ -784,7 +786,7 @@ void gtk_widget_remove_tick_callback (GtkWidget *widget, /** * gtk_widget_class_bind_template_child_private: - * @widget_class: a #GtkWidgetClass + * @widget_class: a `GtkWidgetClass` * @TypeName: the type name of this widget * @member_name: name of the instance private member in the private struct for @data_type * @@ -805,7 +807,7 @@ void gtk_widget_remove_tick_callback (GtkWidget *widget, /** * gtk_widget_class_bind_template_child_internal_private: - * @widget_class: a #GtkWidgetClass + * @widget_class: a `GtkWidgetClass` * @TypeName: the type name, in CamelCase * @member_name: name of the instance private member on the private struct for @data_type * diff --git a/gtk/gtkwidgetprivate.h b/gtk/gtkwidgetprivate.h index 2863787e24..bc6eb0bf7f 100644 --- a/gtk/gtkwidgetprivate.h +++ b/gtk/gtkwidgetprivate.h @@ -139,7 +139,7 @@ struct _GtkWidgetPrivate char *name; /* The root this widget belongs to or %NULL if widget is not - * rooted or is a #GtkRoot itself. + * rooted or is a GtkRoot itself. */ GtkRoot *root; diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index 4d9830d607..501341bd22 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -4503,7 +4503,7 @@ update_window_style_classes (GtkWindow *window) } /* _gtk_window_set_allocation: - * @window: a #GtkWindow + * @window: a `GtkWindow` * @allocation: the original allocation for the window * @allocation_out: @allocation taking decorations into * consideration @@ -5146,7 +5146,7 @@ gtk_window_css_changed (GtkWidget *widget, /* * _gtk_window_unset_focus_and_default: - * @window: a #GtkWindow + * @window: a `GtkWindow` * @widget: a widget inside of @window * * Checks whether the focus and default widgets of @window are @@ -6805,7 +6805,7 @@ gtk_window_grab_notify (GtkWindow *window, /** * gtk_window_set_handle_menubar_accel: (attributes org.gtk.Method.set_property=handle-menubar-accel) - * @window: a #GtkWindow + * @window: a `GtkWindow` * @handle_menubar_accel: %TRUE to make @window handle F10 * * Sets whether this window should react to F10 key presses @@ -6834,7 +6834,7 @@ gtk_window_set_handle_menubar_accel (GtkWindow *window, /** * gtk_window_get_handle_menubar_accel: (attributes org.gtk.Method.get_property=handle-menubar-accel) - * @window: a #GtkWindow + * @window: a `GtkWindow` * * Returns whether this window reacts to F10 key presses by * activating a menubar it contains. diff --git a/gtk/gtkwindow.h b/gtk/gtkwindow.h index a7e9a5bc4f..c60a1d426f 100644 --- a/gtk/gtkwindow.h +++ b/gtk/gtkwindow.h @@ -60,9 +60,9 @@ struct _GtkWindow * @activate_default: Activates the default widget for the window. * @keys_changed: Signal gets emitted when the set of accelerators or * mnemonics that are associated with window changes. - * @enable_debugging: Class handler for the #GtkWindow::enable-debugging + * @enable_debugging: Class handler for the `GtkWindow::enable-debugging` * keybinding signal. - * @close_request: Class handler for the #GtkWindow::close-request signal. + * @close_request: Class handler for the `GtkWindow::close-request` signal. */ struct _GtkWindowClass { diff --git a/gtk/timsort/gtktimsort.c b/gtk/timsort/gtktimsort.c index 7aadef0dda..67846674e2 100644 --- a/gtk/timsort/gtktimsort.c +++ b/gtk/timsort/gtktimsort.c @@ -186,7 +186,7 @@ gtk_tim_sort_set_change (GtkTimSortRun *out_change, /*<private> * gtk_tim_sort_get_runs: - * @self: a #GtkTimSort + * @self: a GtkTimSort * @runs: (out) (caller-allocates): Place to store the 0-terminated list of * runs * @@ -212,7 +212,7 @@ gtk_tim_sort_get_runs (GtkTimSort *self, /*<private> * gtk_tim_sort_set_runs: - * @self: a freshly initialized #GtkTimSort + * @self: a freshly initialized GtkTimSort * @runs: (array length=zero-terminated): a 0-terminated list of runs * * Sets the list of runs. A run is a range of items that are already @@ -236,7 +236,7 @@ gtk_tim_sort_set_runs (GtkTimSort *self, /* * gtk_tim_sort_set_max_merge_size: - * @self: a #GtkTimSort + * @self: a GtkTimSort * @max_merge_size: Maximum size of a merge step, 0 for unlimited * * Sets the maximum size of a merge step. Every time @@ -270,7 +270,7 @@ gtk_tim_sort_set_max_merge_size (GtkTimSort *self, /** * gtk_tim_sort_get_progress: - * @self: a #GtkTimSort + * @self: a GtkTimSort * * Does a progress estimate about sort progress, estimates relative * to the number of items to sort. @@ -330,7 +330,7 @@ gtk_tim_sort_get_progress (GtkTimSort *self) /* * gtk_tim_sort_step: - * @self: a #GtkTimSort + * @self: a GtkTimSort * @out_change: (optional): Return location for changed * area. If a change did not cause any changes (for example, * if an already sorted array gets sorted), out_change |