[gtk/ebassi/gidocgen: 245/471] applicationwindow: Convert docs




commit f8be0d61a6aa2566e098b1b93b263a85bc6bda9f
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Feb 27 17:50:24 2021 -0500

    applicationwindow: Convert docs

 gtk/gtkapplicationwindow.c | 108 ++++++++++++++++++++++-----------------------
 1 file changed, 54 insertions(+), 54 deletions(-)
---
diff --git a/gtk/gtkapplicationwindow.c b/gtk/gtkapplicationwindow.c
index 3fa6b96003..341aec92b1 100644
--- a/gtk/gtkapplicationwindow.c
+++ b/gtk/gtkapplicationwindow.c
@@ -35,54 +35,49 @@
 #endif
 
 /**
- * SECTION:gtkapplicationwindow
- * @title: GtkApplicationWindow
- * @short_description: GtkWindow subclass with GtkApplication support
+ * GtkApplicationWindow:
  *
- * #GtkApplicationWindow is a #GtkWindow subclass that offers some
- * extra functionality for better integration with #GtkApplication
- * features. Notably, it can handle an application menubar.
+ * `GtkApplicationWindow` is a `GtkWindow` subclass that integrates with
+ * `GtkApplication`.
  *
- * This class implements the #GActionGroup and #GActionMap interfaces,
+ * Notably, `GtkApplicationWindow` can handle an application menubar.
+ *
+ * This class implements the `GActionGroup` and `GActionMap` interfaces,
  * to let you add window-specific actions that will be exported by the
- * associated #GtkApplication, together with its application-wide
- * actions.  Window-specific actions are prefixed with the “win.”
+ * associated [class@Gtk.Application], together with its application-wide
+ * actions. Window-specific actions are prefixed with the “win.”
  * prefix and application-wide actions are prefixed with the “app.”
- * prefix.  Actions must be addressed with the prefixed name when
- * referring to them from a #GMenuModel.
+ * prefix. Actions must be addressed with the prefixed name when
+ * referring to them from a `GMenuModel`.
  *
- * Note that widgets that are placed inside a #GtkApplicationWindow
+ * Note that widgets that are placed inside a `GtkApplicationWindow`
  * can also activate these actions, if they implement the
- * #GtkActionable interface.
- *
- * As with #GtkApplication, the GDK lock will be acquired when
- * processing actions arriving from other processes and should therefore
- * be held when activating actions locally (if GDK threads are enabled).
+ * [iface@Gtk.Actionable] interface.
  *
- * The settings #GtkSettings:gtk-shell-shows-app-menu and
- * #GtkSettings:gtk-shell-shows-menubar tell GTK whether the
+ * The settings [property@Gtk.Settings:gtk-shell-shows-app-menu] and
+ * [property@Gtk.Settings:gtk-shell-shows-menubar] tell GTK whether the
  * desktop environment is showing the application menu and menubar
  * models outside the application as part of the desktop shell.
  * For instance, on OS X, both menus will be displayed remotely;
- * on Windows neither will be. gnome-shell (starting with version 3.4)
- * will display the application menu, but not the menubar.
+ * on Windows neither will be.
  *
  * If the desktop environment does not display the menubar, then
- * #GtkApplicationWindow will automatically show a menubar for it.
- * This behaviour can be overridden with the #GtkApplicationWindow:show-menubar
- * property. If the desktop environment does not display the application
- * menu, then it will automatically be included in the menubar or in the
- * windows client-side decorations.
+ * `GtkApplicationWindow` will automatically show a menubar for it.
+ * This behaviour can be overridden with the
+ * [property@Gtk.ApplicationWindow:show-menubar] property. If the
+ * desktop environment does not display the application menu, then
+ * it will automatically be included in the menubar or in the windows
+ * client-side decorations.
  *
- * See #GtkPopoverMenu for information about the XML language
- * used by #GtkBuilder for menu models.
+ * See [class@Gtk.PopoverMenu] for information about the XML language
+ * used by `GtkBuilder` for menu models.
  *
  * See also: [method@Gtk.Application.set_menubar].
  *
  * ## A GtkApplicationWindow with a menubar
  *
- * The code sample below shows how to set up a `GtkApplicationWindow` with a
- * menu bar defined on the [class@Gtk.Application]:
+ * The code sample below shows how to set up a `GtkApplicationWindow`
+ * with a menu bar defined on the [class@Gtk.Application]:
  *
  * ```c
  * GtkApplication *app = gtk_application_new ("org.gtk.test", 0);
@@ -105,8 +100,7 @@
  *     "</interface>",
  *     -1);
  *
- * GMenuModel *menubar = G_MENU_MODEL (gtk_builder_get_object (builder,
- *                                                            "menubar"));
+ * GMenuModel *menubar = G_MENU_MODEL (gtk_builder_get_object (builder, "menubar"));
  * gtk_application_set_menubar (GTK_APPLICATION (app), menubar);
  * g_object_unref (builder);
  *
@@ -675,10 +669,12 @@ gtk_application_window_class_init (GtkApplicationWindowClass *class)
   object_class->dispose = gtk_application_window_dispose;
 
   /**
-   * GtkApplicationWindow:show-menubar:
+   * GtkApplicationWindow:show-menubar: (attributes 
org.gtk.Property.get=gtk_application_window_get_show_menubar 
org.gtk.Property.set=gtk_application_window_set_show_menubar)
    *
    * If this property is %TRUE, the window will display a menubar
-   * unless it is shown by the desktop shell. See gtk_application_set_menubar().
+   * unless it is shown by the desktop shell.
+   *
+   * See [method@Gtk.Application.set_menubar].
    *
    * If %FALSE, the window will not display a menubar, regardless
    * of whether the desktop shell is showing it or not.
@@ -694,11 +690,11 @@ gtk_application_window_class_init (GtkApplicationWindowClass *class)
 
 /**
  * gtk_application_window_new:
- * @application: a #GtkApplication
+ * @application: a `GtkApplication`
  *
- * Creates a new #GtkApplicationWindow.
+ * Creates a new `GtkApplicationWindow`.
  *
- * Returns: a newly created #GtkApplicationWindow
+ * Returns: a newly created `GtkApplicationWindow`
  */
 GtkWidget *
 gtk_application_window_new (GtkApplication *application)
@@ -711,8 +707,8 @@ gtk_application_window_new (GtkApplication *application)
 }
 
 /**
- * gtk_application_window_get_show_menubar:
- * @window: a #GtkApplicationWindow
+ * gtk_application_window_get_show_menubar: (attributes org.gtk.Method.get_property=show-menubar)
+ * @window: a `GtkApplicationWindow`
  *
  * Returns whether the window will display a menubar for the app menu
  * and menubar as needed.
@@ -727,8 +723,8 @@ gtk_application_window_get_show_menubar (GtkApplicationWindow *window)
 }
 
 /**
- * gtk_application_window_set_show_menubar:
- * @window: a #GtkApplicationWindow
+ * gtk_application_window_set_show_menubar: (attributes org.gtk.Method.set_property=show-menubar)
+ * @window: a `GtkApplicationWindow`
  * @show_menubar: whether to show a menubar when needed
  *
  * Sets whether the window will display a menubar for the app menu
@@ -755,13 +751,14 @@ gtk_application_window_set_show_menubar (GtkApplicationWindow *window,
 
 /**
  * gtk_application_window_get_id:
- * @window: a #GtkApplicationWindow
+ * @window: a `GtkApplicationWindow`
  *
- * Returns the unique ID of the window. If the window has not yet been added to
- * a #GtkApplication, returns `0`.
+ * Returns the unique ID of the window.
+ *
+ *  If the window has not yet been added to a `GtkApplication`, returns `0`.
  *
  * Returns: the unique ID for @window, or `0` if the window
- *   has not yet been added to a #GtkApplication
+ *   has not yet been added to a `GtkApplication`
  */
 guint
 gtk_application_window_get_id (GtkApplicationWindow *window)
@@ -795,12 +792,13 @@ show_help_overlay (GSimpleAction *action,
 
 /**
  * gtk_application_window_set_help_overlay:
- * @window: a #GtkApplicationWindow
- * @help_overlay: (nullable): a #GtkShortcutsWindow
+ * @window: a `GtkApplicationWindow`
+ * @help_overlay: (nullable): a `GtkShortcutsWindow`
+ *
+ * Associates a shortcuts window with the application window.
  *
- * Associates a shortcuts window with the application window, and
- * sets up an action with the name win.show-help-overlay to present
- * it.
+ * Additionally, sets up an action with the name
+ * `win.show-help-overlay` to present it.
  *
  * @window takes responsibility for destroying @help_overlay.
  */
@@ -838,12 +836,14 @@ gtk_application_window_set_help_overlay (GtkApplicationWindow *window,
 
 /**
  * gtk_application_window_get_help_overlay:
- * @window: a #GtkApplicationWindow
+ * @window: a `GtkApplicationWindow`
+ *
+ * Gets the `GtkShortcutsWindow` that is associated with @window.
  *
- * Gets the #GtkShortcutsWindow that has been set up with
- * a prior call to gtk_application_window_set_help_overlay().
+ * See [method@Gtk.ApplicationWindow.set_help_overlay].
  *
- * Returns: (transfer none) (nullable): the help overlay associated with @window, or %NULL
+ * Returns: (transfer none) (nullable): the help overlay associated
+ *   with @window, or %NULL
  */
 GtkShortcutsWindow *
 gtk_application_window_get_help_overlay (GtkApplicationWindow *window)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]