Commit a0a92761 authored by Maximiliano's avatar Maximiliano 🥑 Committed by Alexander Mikhaylenko
Browse files

docs: Replace @self docstrings

parent 4454eb6b
......@@ -315,7 +315,7 @@ adw_action_row_class_init (AdwActionRowClass *klass)
/**
* AdwActionRow::activated:
* @self: the `AdwActionRow` instance
* @self: an action row
*
* This signal is emitted after the row has been activated.
*
......@@ -396,7 +396,7 @@ adw_action_row_new (void)
/**
* adw_action_row_get_subtitle: (attributes org.gtk.Method.get_property=subtitle)
* @self: a `AdwActionRow`
* @self: an action row
*
* Gets the subtitle for @self.
*
......@@ -418,7 +418,7 @@ adw_action_row_get_subtitle (AdwActionRow *self)
/**
* adw_action_row_set_subtitle: (attributes org.gtk.Method.set_property=subtitle)
* @self: a `AdwActionRow`
* @self: an action row
* @subtitle: the subtitle
*
* Sets the subtitle for @self.
......@@ -445,7 +445,7 @@ adw_action_row_set_subtitle (AdwActionRow *self,
/**
* adw_action_row_get_icon_name: (attributes org.gtk.Method.get_property=icon-name)
* @self: a `AdwActionRow`
* @self: an action row
*
* Gets the icon name for @self.
*
......@@ -467,7 +467,7 @@ adw_action_row_get_icon_name (AdwActionRow *self)
/**
* adw_action_row_set_icon_name: (attributes org.gtk.Method.set_property=icon-name)
* @self: a `AdwActionRow`
* @self: an action row
* @icon_name: (nullable): the icon name
*
* Sets the icon name for @self.
......@@ -496,7 +496,7 @@ adw_action_row_set_icon_name (AdwActionRow *self,
/**
* adw_action_row_get_activatable_widget: (attributes org.gtk.Method.get_property=activatable-widget)
* @self: a `AdwActionRow`
* @self: an action row
*
* Gets the widget activated when @self is activated.
*
......@@ -530,7 +530,7 @@ activatable_widget_weak_notify (gpointer data,
/**
* adw_action_row_set_activatable_widget: (attributes org.gtk.Method.set_property=activatable-widget)
* @self: a `AdwActionRow`
* @self: an action row
* @widget: (nullable): the target widget
*
* Sets the widget to activate when @self is activated.
......@@ -570,7 +570,7 @@ adw_action_row_set_activatable_widget (AdwActionRow *self,
/**
* adw_action_row_get_title_lines: (attributes org.gtk.Method.get_property=title-lines)
* @self: a `AdwActionRow`
* @self: an action row
*
* Gets the number of lines at the end of which the title label will be
* ellipsized.
......@@ -596,7 +596,7 @@ adw_action_row_get_title_lines (AdwActionRow *self)
/**
* adw_action_row_set_title_lines: (attributes org.gtk.Method.set_property=title-lines)
* @self: a `AdwActionRow`
* @self: an action row
* @title_lines: the number of lines at the end of which the title label will be ellipsized
*
* Sets the number of lines at the end of which the title label will be
......@@ -630,7 +630,7 @@ adw_action_row_set_title_lines (AdwActionRow *self,
/**
* adw_action_row_get_subtitle_lines: (attributes org.gtk.Method.get_property=subtitle-lines)
* @self: a `AdwActionRow`
* @self: an action row
*
* Gets the number of lines at the end of which the subtitle label will be
* ellipsized.
......@@ -656,7 +656,7 @@ adw_action_row_get_subtitle_lines (AdwActionRow *self)
/**
* adw_action_row_set_subtitle_lines: (attributes org.gtk.Method.set_property=subtitle-lines)
* @self: a `AdwActionRow`
* @self: an action row
* @subtitle_lines: the number of lines at the end of which the subtitle label will be ellipsized
*
* Sets the number of lines at the end of which the subtitle label will be
......@@ -690,7 +690,7 @@ adw_action_row_set_subtitle_lines (AdwActionRow *self,
/**
* adw_action_row_add_prefix:
* @self: a `AdwActionRow`
* @self: an action row
* @widget: a widget
*
* Adds a prefix widget to @self.
......@@ -714,7 +714,7 @@ adw_action_row_add_prefix (AdwActionRow *self,
/**
* adw_action_row_add_suffix:
* @self: a `AdwActionRow`
* @self: an action row
* @widget: a widget
*
* Adds a suffix widget to @self.
......@@ -738,7 +738,7 @@ adw_action_row_add_suffix (AdwActionRow *self,
/**
* adw_action_row_remove:
* @self: a `AdwActionRow`
* @self: an action row
* @widget: the child to be removed
*
* Removes a child from @self.
......@@ -769,7 +769,7 @@ adw_action_row_remove (AdwActionRow *self,
/**
* adw_action_row_activate:
* @self: a `AdwActionRow`
* @self: an action row
*
* Activates @self.
*
......
......@@ -440,7 +440,7 @@ adw_animation_init (AdwAnimation *self)
/**
* adw_animation_get_widget: (attributes org.gtk.Method.get_property=widget)
* @self: a `AdwAnimation`
* @self: an animation
*
* Gets the widget @self was created for.
*
......@@ -462,7 +462,7 @@ adw_animation_get_widget (AdwAnimation *self)
/**
* adw_animation_get_target: (attributes org.gtk.Method.get_property=target)
* @self: a `AdwAnimation`
* @self: an animation
*
* Gets the target @self animates.
*
......@@ -484,7 +484,7 @@ adw_animation_get_target (AdwAnimation *self)
/**
* adw_animation_get_value: (attributes org.gtk.Method.get_property=value)
* @self: a `AdwAnimation`
* @self: an animation
*
* Gets the current value of @self.
*
......@@ -506,7 +506,7 @@ adw_animation_get_value (AdwAnimation *self)
/**
* adw_animation_get_state: (attributes org.gtk.Method.get_property=state)
* @self: a `AdwAnimation`
* @self: an animation
*
* Gets the current value of @self.
*
......@@ -531,7 +531,7 @@ adw_animation_get_state (AdwAnimation *self)
/**
* adw_animation_play:
* @self: a `AdwAnimation`
* @self: an animation
*
* Starts the animation for @self.
*
......@@ -571,7 +571,7 @@ adw_animation_play (AdwAnimation *self)
/**
* adw_animation_pause:
* @self: a `AdwAnimation`
* @self: an animation
*
* Pauses a playing animation for @self.
*
......@@ -609,7 +609,7 @@ adw_animation_pause (AdwAnimation *self)
/**
* adw_animation_resume:
* @self: a `AdwAnimation`
* @self: an animation
*
* Resumes a paused animation for @self.
*
......@@ -640,7 +640,7 @@ adw_animation_resume (AdwAnimation *self)
/**
* adw_animation_skip:
* @self: a `AdwAnimation`
* @self: an animation
*
* Skips the animation for @self.
*
......@@ -689,7 +689,7 @@ adw_animation_skip (AdwAnimation *self)
/**
* adw_animation_reset:
* @self: a `AdwAnimation`
* @self: an animation
*
* Resets the animation for @self.
*
......
......@@ -190,7 +190,7 @@ adw_application_window_new (GtkApplication *app)
/**
* adw_application_window_set_content: (attributes org.gtk.Method.set_property=content)
* @self: a `AdwApplicationWindow`
* @self: an application window
* @content: (nullable): the content widget
*
* Sets the content widget of @self.
......@@ -213,7 +213,7 @@ adw_application_window_set_content (AdwApplicationWindow *self,
/**
* adw_application_window_get_content: (attributes org.gtk.Method.get_property=content)
* @self: a `AdwApplicationWindow`
* @self: an application window
*
* Gets the content widget of @self.
*
......
......@@ -278,7 +278,7 @@ adw_application_new (const char *application_id,
/**
* adw_application_get_style_manager: (attributes org.gtk.Method.get_property=style-manager)
* @self: a `AdwApplication`
* @self: an application
*
* Gets the style manager for @self.
*
......
......@@ -458,7 +458,7 @@ adw_avatar_new (int size,
/**
* adw_avatar_get_icon_name: (attributes org.gtk.Method.get_property=icon-name)
* @self: a `AdwAvatar`
* @self: an avatar
*
* Gets the name of an icon to use as a fallback.
*
......@@ -476,7 +476,7 @@ adw_avatar_get_icon_name (AdwAvatar *self)
/**
* adw_avatar_set_icon_name: (attributes org.gtk.Method.set_property=icon-name)
* @self: a `AdwAvatar`
* @self: an avatar
* @icon_name: (nullable): the icon name
*
* Sets the name of an icon to use as a fallback.
......@@ -504,7 +504,7 @@ adw_avatar_set_icon_name (AdwAvatar *self,
/**
* adw_avatar_get_text: (attributes org.gtk.Method.get_property=text)
* @self: a `AdwAvatar`
* @self: an avatar
*
* Gets the text used to generate the fallback initials and color.
*
......@@ -523,7 +523,7 @@ adw_avatar_get_text (AdwAvatar *self)
/**
* adw_avatar_set_text: (attributes org.gtk.Method.set_property=text)
* @self: a `AdwAvatar`
* @self: an avatar
* @text: (nullable): the text used to get the initials and color
*
* Sets the text used to generate the fallback initials and color.
......@@ -553,7 +553,7 @@ adw_avatar_set_text (AdwAvatar *self,
/**
* adw_avatar_get_show_initials: (attributes org.gtk.Method.get_property=show-initials)
* @self: a `AdwAvatar`
* @self: an avatar
*
* Gets whether initials are used instead of an icon on the fallback avatar.
*
......@@ -571,7 +571,7 @@ adw_avatar_get_show_initials (AdwAvatar *self)
/**
* adw_avatar_set_show_initials: (attributes org.gtk.Method.set_property=show-initials)
* @self: a `AdwAvatar`
* @self: an avatar
* @show_initials: whether to use initials instead of an icon as fallback
*
* Sets whether to use initials instead of an icon on the fallback avatar.
......@@ -598,7 +598,7 @@ adw_avatar_set_show_initials (AdwAvatar *self,
/**
* adw_avatar_get_custom_image: (attributes org.gtk.Method.get_property=custom-image)
* @self: a `AdwAvatar`
* @self: an avatar
*
* Gets the custom image paintable.
*
......@@ -616,7 +616,7 @@ adw_avatar_get_custom_image (AdwAvatar *self)
/**
* adw_avatar_set_custom_image: (attributes org.gtk.Method.set_property=custom-image)
* @self: a `AdwAvatar`
* @self: an avatar
* @custom_image: (nullable) (transfer none): a custom image
*
* Sets the custom image paintable.
......@@ -668,7 +668,7 @@ adw_avatar_set_custom_image (AdwAvatar *self,
/**
* adw_avatar_get_size: (attributes org.gtk.Method.get_property=size)
* @self: a `AdwAvatar`
* @self: an avatar
*
* Gets the size of the avatar.
*
......@@ -686,7 +686,7 @@ adw_avatar_get_size (AdwAvatar *self)
/**
* adw_avatar_set_size: (attributes org.gtk.Method.set_property=size)
* @self: a `AdwAvatar`
* @self: an avatar
* @size: The size of the avatar
*
* Sets the size of the avatar.
......@@ -721,7 +721,7 @@ adw_avatar_set_size (AdwAvatar *self,
/**
* adw_avatar_draw_to_texture:
* @self: a `AdwAvatar`
* @self: an avatar
* @scale_factor: The scale factor
*
* Renders @self into a [class@Gdk.Texture] at @scale_factor.
......
......@@ -169,7 +169,7 @@ adw_bin_new (void)
/**
* adw_bin_get_child: (attributes org.gtk.Method.get_property=child)
* @self: a `AdwBin`
* @self: a bin
*
* Gets the child widget of @self.
*
......@@ -191,7 +191,7 @@ adw_bin_get_child (AdwBin *self)
/**
* adw_bin_set_child: (attributes org.gtk.Method.set_property=child)
* @self: a `AdwBin`
* @self: a bin
* @child: (nullable): the child widget
*
* Sets the child widget of @self.
......
......@@ -305,7 +305,7 @@ adw_button_content_new (void)
/**
* adw_button_content_get_icon_name: (attributes org.gtk.Method.get_property=icon-name)
* @self: a `AdwButtonContent`
* @self: a button content
*
* Gets the name of the displayed icon.
*
......@@ -323,7 +323,7 @@ adw_button_content_get_icon_name (AdwButtonContent *self)
/**
* adw_button_content_set_icon_name: (attributes org.gtk.Method.set_property=icon-name)
* @self: a `AdwButtonContent`
* @self: a button content
* @icon_name: the new icon name
*
* Sets the name of the displayed icon.
......@@ -353,7 +353,7 @@ adw_button_content_set_icon_name (AdwButtonContent *self,
/**
* adw_button_content_get_label: (attributes org.gtk.Method.get_property=label)
* @self: a `AdwButtonContent`
* @self: a button content
*
* Gets the displayed label.
*
......@@ -371,7 +371,7 @@ adw_button_content_get_label (AdwButtonContent *self)
/**
* adw_button_content_set_label: (attributes org.gtk.Method.set_property=label)
* @self: a `AdwButtonContent`
* @self: a button content
* @label: the new label
*
* Sets the displayed label.
......@@ -398,7 +398,7 @@ adw_button_content_set_label (AdwButtonContent *self,
/**
* adw_button_content_get_use_underline: (attributes org.gtk.Method.get_property=use-underline)
* @self: a `AdwButtonContent`
* @self: a button content
*
* Gets whether an underline in the text indicates a mnemonic.
*
......@@ -416,7 +416,7 @@ adw_button_content_get_use_underline (AdwButtonContent *self)
/**
* adw_button_content_set_use_underline: (attributes org.gtk.Method.set_property=use-underline)
* @self: a `AdwButtonContent`
* @self: a button content
* @use_underline: whether an underline in the text indicates a mnemonic
*
* Sets whether an underline in the text indicates a mnemonic.
......
......@@ -379,7 +379,7 @@ adw_carousel_indicator_dots_new (void)
/**
* adw_carousel_indicator_dots_get_carousel: (attributes org.gtk.Method.get_property=carousel)
* @self: a `AdwCarouselIndicatorDots`
* @self: an indicator
*
* Gets the displayed carousel.
*
......@@ -397,7 +397,7 @@ adw_carousel_indicator_dots_get_carousel (AdwCarouselIndicatorDots *self)
/**
* adw_carousel_indicator_dots_set_carousel: (attributes org.gtk.Method.set_property=carousel)
* @self: a `AdwCarouselIndicatorDots`
* @self: an indicator
* @carousel: (nullable): a carousel
*
* Sets the displayed carousel.
......
......@@ -364,7 +364,7 @@ adw_carousel_indicator_lines_new (void)
/**
* adw_carousel_indicator_lines_get_carousel: (attributes org.gtk.Method.get_property=carousel)
* @self: a `AdwCarouselIndicatorLines`
* @self: an indicator
*
* Gets the displayed carousel.
*
......@@ -382,7 +382,7 @@ adw_carousel_indicator_lines_get_carousel (AdwCarouselIndicatorLines *self)
/**
* adw_carousel_indicator_lines_set_carousel: (attributes org.gtk.Method.set_property=carousel)
* @self: a `AdwCarouselIndicatorLines`
* @self: an indicator
* @carousel: (nullable): a carousel
*
* Sets the displayed carousel.
......
......@@ -1035,7 +1035,7 @@ adw_carousel_class_init (AdwCarouselClass *klass)
/**
* AdwCarousel::page-changed:
* @self: a `AdwCarousel`
* @self: a carousel
* @index: current page
*
* This signal is emitted after a page has been changed.
......@@ -1191,7 +1191,7 @@ adw_carousel_new (void)
/**
* adw_carousel_prepend:
* @self: a `AdwCarousel`
* @self: a carousel
* @child: a widget to add
*
* Prepends @child to @self.
......@@ -1210,7 +1210,7 @@ adw_carousel_prepend (AdwCarousel *self,
/**
* adw_carousel_append:
* @self: a `AdwCarousel`
* @self: a carousel
* @child: a widget to add
*
* Appends @child to @self.
......@@ -1229,7 +1229,7 @@ adw_carousel_append (AdwCarousel *self,
/**
* adw_carousel_insert:
* @self: a `AdwCarousel`
* @self: a carousel
* @child: a widget to add
* @position: the position to insert @child at
*
......@@ -1278,7 +1278,7 @@ adw_carousel_insert (AdwCarousel *self,
}
/**
* adw_carousel_reorder:
* @self: a `AdwCarousel`
* @self: a carousel
* @child: a widget to add
* @position: the position to move @child to
*
......@@ -1370,7 +1370,7 @@ adw_carousel_reorder (AdwCarousel *self,
/**
* adw_carousel_remove:
* @self: a `AdwCarousel`
* @self: a carousel
* @child: a widget to remove
*
* Removes @child from @self.
......@@ -1405,7 +1405,7 @@ adw_carousel_remove (AdwCarousel *self,
/**
* adw_carousel_scroll_to:
* @self: a `AdwCarousel`
* @self: a carousel
* @widget: a child of @self
* @animate: whether to animate the transition
*
......@@ -1432,7 +1432,7 @@ adw_carousel_scroll_to (AdwCarousel *self,
/**
* adw_carousel_get_nth_page:
* @self: a `AdwCarousel`
* @self: a carousel
* @n: index of the page
*
* Gets the page at position @n.
......@@ -1457,7 +1457,7 @@ adw_carousel_get_nth_page (AdwCarousel *self,
/**
* adw_carousel_get_n_pages: (attributes org.gtk.Method.get_property=n-pages)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets the number of pages in @self.
*
......@@ -1486,7 +1486,7 @@ adw_carousel_get_n_pages (AdwCarousel *self)
/**
* adw_carousel_get_position: (attributes org.gtk.Method.get_property=position)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets current scroll position in @self.
*
......@@ -1506,7 +1506,7 @@ adw_carousel_get_position (AdwCarousel *self)
/**
* adw_carousel_get_interactive: (attributes org.gtk.Method.get_property=interactive)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets whether @self can be navigated.
*
......@@ -1524,7 +1524,7 @@ adw_carousel_get_interactive (AdwCarousel *self)
/**
* adw_carousel_set_interactive: (attributes org.gtk.Method.set_property=interactive)
* @self: a `AdwCarousel`
* @self: a carousel
* @interactive: whether @self can be navigated
*
* Sets whether @self can be navigated.
......@@ -1549,7 +1549,7 @@ adw_carousel_set_interactive (AdwCarousel *self,
/**
* adw_carousel_get_spacing: (attributes org.gtk.Method.get_property=spacing)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets spacing between pages in pixels.
*
......@@ -1567,7 +1567,7 @@ adw_carousel_get_spacing (AdwCarousel *self)
/**
* adw_carousel_set_spacing: (attributes org.gtk.Method.set_property=spacing)
* @self: a `AdwCarousel`
* @self: a carousel
* @spacing: the new spacing value
*
* Sets spacing between pages in pixels.
......@@ -1591,7 +1591,7 @@ adw_carousel_set_spacing (AdwCarousel *self,
/**
* adw_carousel_get_scroll_params: (attributes org.gtk.Method.get_property=scroll-params)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets the scroll animation spring parameters for @self.
*
......@@ -1609,7 +1609,7 @@ adw_carousel_get_scroll_params (AdwCarousel *self)
/**
* adw_carousel_set_scroll_params: (attributes org.gtk.Method.set_property=scroll-params)
* @self: a `AdwCarousel`
* @self: a carousel
* @params: the new parameters
*
* Sets the scroll animation spring parameters for @self.
......@@ -1633,7 +1633,7 @@ adw_carousel_set_scroll_params (AdwCarousel *self,
/**
* adw_carousel_get_allow_mouse_drag: (attributes org.gtk.Method.get_property=allow-mouse-drag)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Sets whether @self can be dragged with mouse pointer.
*
......@@ -1651,7 +1651,7 @@ adw_carousel_get_allow_mouse_drag (AdwCarousel *self)
/**
* adw_carousel_set_allow_mouse_drag: (attributes org.gtk.Method.set_property=allow-mouse-drag)
* @self: a `AdwCarousel`
* @self: a carousel
* @allow_mouse_drag: whether @self can be dragged with mouse pointer
*
* Sets whether @self can be dragged with mouse pointer.
......@@ -1676,7 +1676,7 @@ adw_carousel_set_allow_mouse_drag (AdwCarousel *self,
/**
* adw_carousel_get_allow_scroll_wheel: (attributes org.gtk.Method.get_property=allow-scroll-wheel)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets whether @self will respond to scroll wheel events.
*
......@@ -1694,7 +1694,7 @@ adw_carousel_get_allow_scroll_wheel (AdwCarousel *self)
/**
* adw_carousel_set_allow_scroll_wheel: (attributes org.gtk.Method.set_property=allow-scroll-wheel)
* @self: a `AdwCarousel`
* @self: a carousel
* @allow_scroll_wheel: whether @self will respond to scroll wheel events
*
* Sets whether @self will respond to scroll wheel events.
......@@ -1719,7 +1719,7 @@ adw_carousel_set_allow_scroll_wheel (AdwCarousel *self,
/**
* adw_carousel_get_allow_long_swipes: (attributes org.gtk.Method.get_property=allow-long-swipes)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets whether to allow swiping for more than one page at a time.
*
......@@ -1737,7 +1737,7 @@ adw_carousel_get_allow_long_swipes (AdwCarousel *self)
/**
* adw_carousel_set_allow_long_swipes: (attributes org.gtk.Method.set_property=allow-long-swipes)
* @self: a `AdwCarousel`
* @self: a carousel
* @allow_long_swipes: whether to allow long swipes
*
* Sets whether to allow swiping for more than one page at a time.
......@@ -1762,7 +1762,7 @@ adw_carousel_set_allow_long_swipes (AdwCarousel *self,
/**
* adw_carousel_get_reveal_duration: (attributes org.gtk.Method.get_property=reveal-duration)
* @self: a `AdwCarousel`
* @self: a carousel
*
* Gets duration of the animation used when adding or removing pages.
*
......@@ -1780,7 +1780,7 @@ adw_carousel_get_reveal_duration (AdwCarousel *self)
/**
* adw_carousel_set_reveal_duration: (attributes org.gtk.Method.set_property=reveal-duration)
* @self: a `AdwCarousel`
* @self: a carousel
* @reveal_duration: the new reveal duration value
*
* Sets duration of the animation used when adding or removing pages.
......
......@@ -411,7 +411,7 @@ adw_clamp_layout_new (void)
/**
* adw_clamp_layout_get_maximum_size: (attributes org.gtk.Method.get_property=maximum-size)
* @self: a `AdwClampLayout`
* @self: a clamp layout
*
* Gets the maximum size allocated to the children.
*
......@@ -429,7 +429,7 @@ adw_clamp_layout_get_maximum_size (AdwClampLayout *self)
/**
* adw_clamp_layout_set_maximum_size: (attributes org.gtk.Method.set_property=maximum-size)
* @self: a `AdwClampLayout`
* @self: a clamp layout
* @maximum_size: the maximum size
*
* Sets the maximum size allocated to the children.
......@@ -454,7 +454,7 @@ adw_clamp_layout_set_maximum_size (AdwClampLayout *self,
/**
* adw_clamp_layout_get_tightening_threshold: (attributes org.gtk.Method.get_property=tightening-threshold)
* @self: a `AdwClampLayout`