AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-25 13:11:13 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'fix-obvious-doc-issues' into 'main'

Browse Source 
Fix obvious docstring issues

See merge request GNOME/gtk!7320
This commit is contained in:
Matthias Clasen 2024-06-02 12:02:06 +00:00
commit bfe8adbee4
14 changed files with 40 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gdk/gdkcursor.h
View File

@ -52,7 +52,7 @@ GdkCursor* gdk_cursor_new_from_name (const char *name,
GdkCursor *fallback);
/**
* GdkCursorGetTestureCallback:
* GdkCursorGetTextureCallback:
* @cursor: the `GdkCursor`
* @cursor_size: the nominal cursor size, in application pixels
* @scale: the device scale

2
gsk/gskglshader.c
View File

@ -439,7 +439,7 @@ gsk_gl_shader_class_init (GskGLShaderClass *klass)
object_class->constructed = gsk_gl_shader_constructed;
/**
* GskGLShader:sourcecode: (attributes org.gtk.Property.get=gsk_gl_shader_get_source)
* GskGLShader:source: (attributes org.gtk.Property.get=gsk_gl_shader_get_source)
*
* The source code for the shader, as a `GBytes`.
*/

2
gsk/gsktransform.c
View File

@ -2023,7 +2023,7 @@ GskTransformCategory
return self->category;
}
/*
/**
* gsk_transform_new: (constructor):
*
* Creates a new identity transform.

3
gtk/deprecated/gtkcellrendererspinner.c
View File

@ -175,7 +175,8 @@ gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass)
cell_class->get_preferred_height = gtk_cell_renderer_spinner_get_preferred_height;
cell_class->snapshot = gtk_cell_renderer_spinner_snapshot;
/* GtkCellRendererSpinner:active:
/**
* GtkCellRendererSpinner:active:
*
* Whether the spinner is active (ie. shown) in the cell
*/

7
gtk/gtkbuilderscope.c
View File

@ -434,11 +434,10 @@ gtk_builder_cscope_new (void)
/**
* gtk_builder_cscope_add_callback:
* @self: a `GtkBuilderCScope`
* @callback_symbols: (scope async): The callback pointer
* @scope: a `GtkBuilderCScope`
* @callback: (scope async): The callback pointer
*
* Adds the @callback_symbol to the scope of @builder under its
* own name.
* Adds the @callback to the scope of @builder under its own name.
*
* This is a convenience wrapper of [method@Gtk.BuilderCScope.add_callback_symbol].
*

4
gtk/gtkentry.c
View File

@ -876,7 +876,7 @@ gtk_entry_class_init (GtkEntryClass *class)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkEntry::tabs: (attributes org.gtk.Property.get=gtk_entry_get_tabs org.gtk.Property.set=gtk_entry_set_tabs)
* GtkEntry:tabs: (attributes org.gtk.Property.get=gtk_entry_get_tabs org.gtk.Property.set=gtk_entry_set_tabs)
*
* A list of tabstops to apply to the text of the entry.
*/
@ -886,7 +886,7 @@ gtk_entry_class_init (GtkEntryClass *class)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkEntry::show-emoji-icon:
* GtkEntry:show-emoji-icon:
*
* Whether the entry will show an Emoji icon in the secondary icon position
* to open the Emoji chooser.

21
gtk/gtkenums.h
View File

@ -1821,16 +1821,17 @@ typedef enum { /*< prefix=GTK_ACCESSIBLE_SORT >*/
/**
* GtkAccessibleAnnouncementPriority:
* @GTK_ANNOUNCEMENT_PRIORITY_LOW: The announcement is low priority, and might be read only
* on the user's request.
* @GTK_ANNOUNCEMENT_PRIORITY_MEDIUM: The announcement is of medium priority, and is usually
* spoken at the next opportunity, such as at the end of speaking the current sentence
* or when the user pauses typing.
* @GTK_ANNOUNCEMENT_PRIORITY_HIGH: The announcement is of high priority, and is usually
* spoken immediately. Because an interruption might disorient users or cause them to
* not complete their current task, authors SHOULD NOT use high priority announcements
* unless the interruption is imperative. An example would be a notification about a
* critical battery power level.
* @GTK_ACCESSIBLE_ANNOUNCEMENT_PRIORITY_LOW: The announcement is low priority,
* and might be read only on the user's request.
* @GTK_ACCESSIBLE_ANNOUNCEMENT_PRIORITY_MEDIUM: The announcement is of medium
* priority, and is usually spoken at the next opportunity, such as at the
* end of speaking the current sentence or when the user pauses typing.
* @GTK_ACCESSIBLE_ANNOUNCEMENT_PRIORITY_HIGH: The announcement is of high
* priority, and is usually spoken immediately. Because an interruption
* might disorient users or cause them to not complete their current task,
* authors SHOULD NOT use high priority announcements unless the
* interruption is imperative. An example would be a notification about a
* critical battery power level.
*
* The priority of an accessibility announcement.
*

6
gtk/gtkflowbox.c
View File

@ -3675,7 +3675,7 @@ gtk_flow_box_class_init (GtkFlowBoxClass *class)
GTK_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkFlwoBox:accept-unpaired-release:
* GtkFlowBox:accept-unpaired-release:
*
* Whether to accept unpaired release events.
*/
@ -3835,9 +3835,9 @@ gtk_flow_box_class_init (GtkFlowBoxClass *class)
* move by individual children
* - <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the box
* - <kbd>PgUp</kbd>, <kbd>PgDn</kbd> move vertically by pages
*
* Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
* %FALSE to propagate the event further.
*/
signals[MOVE_CURSOR] = g_signal_new (I_("move-cursor"),
GTK_TYPE_FLOW_BOX,

2
gtk/gtkgraphicsoffload.c
View File

@ -271,7 +271,7 @@ gtk_graphics_offload_class_init (GtkGraphicsOffloadClass *class)
GTK_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
/**
* GtkGraphicsOffload:black_background: (attributes org.gtk.Property.get=gtk_graphics_offload_get_black_background org.gtk.Property.set=gtk_graphics_offload_set_black_background)
* GtkGraphicsOffload:black-background: (attributes org.gtk.Property.get=gtk_graphics_offload_get_black_background org.gtk.Property.set=gtk_graphics_offload_set_black_background)
*
* Whether to draw a black background.
*

2
gtk/gtkicontheme.c
View File

@ -1699,7 +1699,7 @@ gtk_icon_theme_set_theme_name (GtkIconTheme *self,
*
* Gets the current icon theme name.
*
* Returns (transfer full): the current icon theme name,
* Returns: (transfer full): the current icon theme name,
*/
char *
gtk_icon_theme_get_theme_name (GtkIconTheme *self)

4
gtk/gtkscrolledwindow.c
View File

@ -582,7 +582,7 @@ gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
class->move_focus_out = gtk_scrolled_window_move_focus_out;
/**
* GtkScrolleWindow:hadjustment: (attributes org.gtk.Property.get=gtk_scrolled_window_get_hadjustment org.gtk.Property.set=gtk_scrolled_window_set_hadjustment)
* GtkScrolledWindow:hadjustment: (attributes org.gtk.Property.get=gtk_scrolled_window_get_hadjustment org.gtk.Property.set=gtk_scrolled_window_set_hadjustment)
*
* The `GtkAdjustment` for the horizontal position.
*/
@ -592,7 +592,7 @@ gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT|G_PARAM_EXPLICIT_NOTIFY);
/**
* GtkScrolleWindow:vadjustment: (attributes org.gtk.Property.get=gtk_scrolled_window_get_vadjustment org.gtk.Property.set=gtk_scrolled_window_set_vadjustment)
* GtkScrolledWindow:vadjustment: (attributes org.gtk.Property.get=gtk_scrolled_window_get_vadjustment org.gtk.Property.set=gtk_scrolled_window_set_vadjustment)
*
* The `GtkAdjustment` for the vertical position.
*/

6
gtk/gtksectionmodel.c
View File

@ -188,12 +188,12 @@ gtk_list_model_get_section (GListModel *self,
}
/**
* gtk_section_model_section_changed:
* gtk_section_model_sections_changed:
* @self: a `GtkSectionModel`
* @position: the first changed item
* @n_items: the number of changed items
*
* This function emits the [signal@Gtk.SectionModel::section-changed]
* This function emits the [signal@Gtk.SectionModel::sections-changed]
* signal to notify about changes to sections.
*
* It must cover all positions that used to be a section start or that
@ -201,7 +201,7 @@ gtk_list_model_get_section (GListModel *self,
* which the section has changed.
*
* The [signal@Gio.ListModel::items-changed] implies the effect of the
* [signal@Gtk.SectionModel::section-changed] signal for all the items
* [signal@Gtk.SectionModel::sections-changed] signal for all the items
* it covers.
*
* It is recommended that when changes to the items cause section changes

16
gtk/gtktextview.c
View File

@ -68,7 +68,7 @@
*
* A widget that displays the contents of a [class@Gtk.TextBuffer].
*
* ![An example GtkTextview](multiline-text.png)
* ![An example GtkTextView](multiline-text.png)
*
* You may wish to begin by reading the [conceptual overview](section-text-widget.html),
* which gives an overview of all the objects and data types related to the
@ -883,7 +883,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
*/
/**
* GtkTextview:pixels-above-lines: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_above_lines org.gtk.Property.set=gtk_text_view_set_pixels_above_lines)
* GtkTextView:pixels-above-lines: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_above_lines org.gtk.Property.set=gtk_text_view_set_pixels_above_lines)
*
* Pixels of blank space above paragraphs.
*/
@ -894,7 +894,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:pixels-below-lines: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_below_lines org.gtk.Property.set=gtk_text_view_set_pixels_below_lines)
* GtkTextView:pixels-below-lines: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_below_lines org.gtk.Property.set=gtk_text_view_set_pixels_below_lines)
*
* Pixels of blank space below paragraphs.
*/
@ -905,7 +905,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:pixels-inside-wrap: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_inside_wrap org.gtk.Property.set=gtk_text_view_set_pixels_inside_wrap)
* GtkTextView:pixels-inside-wrap: (attributes org.gtk.Property.get=gtk_text_view_get_pixels_inside_wrap org.gtk.Property.set=gtk_text_view_set_pixels_inside_wrap)
*
* Pixels of blank space between wrapped lines in a paragraph.
*/
@ -916,7 +916,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:editable: (attributes org.gtk.Property.get=gtk_text_view_get_editable org.gtk.Property.set=gtk_text_view_set_editable)
* GtkTextView:editable: (attributes org.gtk.Property.get=gtk_text_view_get_editable org.gtk.Property.set=gtk_text_view_set_editable)
*
* Whether the text can be modified by the user.
*/
@ -927,7 +927,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:wrap-mode: (attributes org.gtk.Property.get=gtk_text_view_get_wrap_mode org.gtk.Property.set=gtk_text_view_set_wrap_mode)
* GtkTextView:wrap-mode: (attributes org.gtk.Property.get=gtk_text_view_get_wrap_mode org.gtk.Property.set=gtk_text_view_set_wrap_mode)
*
* Whether to wrap lines never, at word boundaries, or at character boundaries.
*/
@ -939,7 +939,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:justification: (attributes org.gtk.Property.get=gtk_text_view_get_justification org.gtk.Property.set=gtk_text_view_set_justification)
* GtkTextView:justification: (attributes org.gtk.Property.get=gtk_text_view_get_justification org.gtk.Property.set=gtk_text_view_set_justification)
*
* Left, right, or center justification.
*/
@ -1035,7 +1035,7 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
/**
* GtkTextview:tabs: (attributes org.gtk.Property.get=gtk_text_view_get_tabs org.gtk.Property.set=gtk_text_view_set_tabs)
* GtkTextView:tabs: (attributes org.gtk.Property.get=gtk_text_view_get_tabs org.gtk.Property.set=gtk_text_view_set_tabs)
*
* Custom tabs for this text.
*/

2
gtk/print/gtkprintsettings.c
View File

@ -779,7 +779,7 @@ gtk_print_settings_set_collate (GtkPrintSettings *settings,
*
* Gets the value of %GTK_PRINT_SETTINGS_REVERSE.
*
* Returns: whether to reverse the order of the printed pages
* Returns: whether to reverse the order of the printed pages
*/
gboolean
gtk_print_settings_get_reverse (GtkPrintSettings *settings)