[libadwaita/wip/exalm/urlmap: 5/5] doc: Link to glib types where possible
- From: Alexander Mikhaylenko <alexm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libadwaita/wip/exalm/urlmap: 5/5] doc: Link to glib types where possible
- Date: Mon, 20 Sep 2021 15:26:05 +0000 (UTC)
commit 9d18aab44f40827a3540c442489bfea35a83ac8e
Author: Alexander Mikhaylenko <alexm gnome org>
Date: Mon Sep 20 20:18:36 2021 +0500
doc: Link to glib types where possible
doc/migrating-libhandy-1-4-to-libadwaita.md | 9 +++++----
src/adw-application.c | 12 ++++++------
src/adw-combo-row.c | 2 +-
src/adw-enum-list-model.c | 2 +-
src/adw-leaflet.c | 2 +-
src/adw-main.c | 5 +++--
src/adw-preferences-group.c | 4 ++--
src/adw-preferences-page.c | 4 ++--
src/adw-squeezer.c | 2 +-
src/adw-tab-view.c | 2 +-
src/adw-view-stack.c | 2 +-
11 files changed, 24 insertions(+), 22 deletions(-)
---
diff --git a/doc/migrating-libhandy-1-4-to-libadwaita.md b/doc/migrating-libhandy-1-4-to-libadwaita.md
index fd0973c7..fa3ecb1d 100644
--- a/doc/migrating-libhandy-1-4-to-libadwaita.md
+++ b/doc/migrating-libhandy-1-4-to-libadwaita.md
@@ -65,7 +65,7 @@ Applications should not use them.
### Bundle the Icons You're Using
The preferred way to use icons in applications is to copy them into the
-application and to bundle them via `GResource`.
+application and to bundle them via [struct@Gio.Resource].
Referencing system icons won't work in Libadwaita other than for icons GTK
itself ships, so make sure to bundle the icons.
@@ -81,8 +81,8 @@ children.
`HdyValueObject` has been removed. While it's not practical to replace the cases
where it's storing strings in GTK3, as the preferred replacement only exists in
-4, it can also be used with any other `GValue`. That use has no replacement and
-you can instead create your own objects to store those values.
+4, it can also be used with any other [struct@GObject.Value]. That use has no
+replacement and you can instead create your own objects to store those values.
## Changes that Need to Be Done at the Time of the Switch
@@ -180,7 +180,8 @@ longer be manually created. It's only intended to be used with
### Stop Using `HdyValueObject`
`HdyValueObject` has been removed. The typical use for storing strings in
-combination with `GListStore` can be replaced by using [class@Gtk.StringList].
+combination with [class@Gio.ListStore] can be replaced by using
+[class@Gtk.StringList].
### Adapt to [class@Adw.HeaderBar] API Changes
diff --git a/src/adw-application.c b/src/adw-application.c
index 4a1ae76f..4459dda3 100644
--- a/src/adw-application.c
+++ b/src/adw-application.c
@@ -14,16 +14,16 @@
* A base class for Adwaita applications.
*
* `AdwApplication` handles library initialization by calling [func Adw init] in
- * the default `GApplication::startup` signal handler, in turn chaining up as
- * required by [class@Gtk.Application]. Therefore, any subclass of
- * `AdwApplication` should always chain up its `GApplication::startup` handler
- * before using any Adwaita or GTK API.
+ * the default [signal@Gio.Application::startup] signal handler, in turn
+ * chaining up as required by [class@Gtk.Application]. Therefore, any subclass
+ * of `AdwApplication` should always chain up its `startup` handler before using
+ * any Adwaita or GTK API.
*
* ## Automatic Resources
*
* `AdwApplication` will automatically load stylesheets located in the
* application's resource base path (see
- * `g_application_set_resource_base_path()`), if they're present.
+ * [method@Gio.Application.set_resource_base_path], if they're present.
*
* They can be used to add custom styles to the application, as follows:
*
@@ -210,7 +210,7 @@ adw_application_init (AdwApplication *self)
* Creates a new `AdwApplication`.
*
* If `application_id` is not `NULL`, then it must be valid. See
- * `g_application_id_is_valid()`.
+ * [func@Gio.Application.id_is_valid].
*
* If no application ID is given then some features (most notably application
* uniqueness) will be disabled.
diff --git a/src/adw-combo-row.c b/src/adw-combo-row.c
index f7d18562..623f4146 100644
--- a/src/adw-combo-row.c
+++ b/src/adw-combo-row.c
@@ -656,7 +656,7 @@ adw_combo_row_get_model (AdwComboRow *self)
* @self: a `AdwComboRow`
* @model: (nullable) (transfer none): the model to use
*
- * Sets the `GListModel` to use.
+ * Sets the [iface@Gio.ListModel] to use.
*
* Since: 1.0
*/
diff --git a/src/adw-enum-list-model.c b/src/adw-enum-list-model.c
index f309cfd5..d8be9a1e 100644
--- a/src/adw-enum-list-model.c
+++ b/src/adw-enum-list-model.c
@@ -13,7 +13,7 @@
/**
* AdwEnumListModel:
*
- * A `GListModel` representing values of a given enum.
+ * A [iface@Gio.ListModel] representing values of a given enum.
*
* `AdwEnumListModel` contains objects of type [class@AdwEnumListItem].
*
diff --git a/src/adw-leaflet.c b/src/adw-leaflet.c
index 07e09a07..87c705b0 100644
--- a/src/adw-leaflet.c
+++ b/src/adw-leaflet.c
@@ -3793,7 +3793,7 @@ adw_leaflet_get_can_unfold (AdwLeaflet *self)
* adw_leaflet_get_pages: (attributes org.gtk.Method.get_property=pages)
* @self: a `AdwLeaflet`
*
- * Returns a `GListModel` that contains the pages of the leaflet.
+ * Returns a [iface@Gio.ListModel] that contains the pages of the leaflet.
*
* This can be used to keep an up-to-date view. The model also implements
* [iface@Gtk.SelectionModel] and can be used to track and change the visible
diff --git a/src/adw-main.c b/src/adw-main.c
index afad88e0..3086d55c 100644
--- a/src/adw-main.c
+++ b/src/adw-main.c
@@ -114,8 +114,9 @@ adw_icons_init (void)
*
* Call this function just after initializing GTK, if you are using
* [class@Gtk.Application] it means it must be called when the
- * `GApplication::startup` signal is emitted. There's no need to call this
- * function if you're using [class@Adw.Application].
+ * [signal@Gio.Application::startup] signal is emitted.
+ *
+ * There's no need to call this function if you're using [class@Adw.Application].
*
* If Libadwaita has already been initialized, the function will simply return.
*
diff --git a/src/adw-preferences-group.c b/src/adw-preferences-group.c
index af456687..a9986e8a 100644
--- a/src/adw-preferences-group.c
+++ b/src/adw-preferences-group.c
@@ -391,11 +391,11 @@ row_has_title (AdwPreferencesRow *row,
* adw_preferences_group_get_rows:
* @self: a `AdwPreferencesGroup`
*
- * Gets a `GListModel` that contains the rows of the group.
+ * Gets a [iface@Gio.ListModel] that contains the rows of the group.
*
* This can be used to keep an up-to-date view.
*
- * Returns: (transfer full): a `GListModel` for the group's rows
+ * Returns: (transfer full): a list model for the group's rows
*
* Since: 1.0
*/
diff --git a/src/adw-preferences-page.c b/src/adw-preferences-page.c
index d8550deb..ce06350b 100644
--- a/src/adw-preferences-page.c
+++ b/src/adw-preferences-page.c
@@ -416,11 +416,11 @@ adw_preferences_page_set_name (AdwPreferencesPage *self,
* adw_preferences_page_get_rows:
* @self: a `AdwPreferencesPage`
*
- * Gets a `GListModel` that contains the rows of the page.
+ * Gets a [iface@Gio.ListModel] that contains the rows of the page.
*
* This can be used to keep an up-to-date view.
*
- * Returns: (transfer full): a `GListModel` for the page's rows
+ * Returns: (transfer full): a list model for the page's rows
*
* Since: 1.0
*/
diff --git a/src/adw-squeezer.c b/src/adw-squeezer.c
index f5cff56a..eedb5ef3 100644
--- a/src/adw-squeezer.c
+++ b/src/adw-squeezer.c
@@ -1875,7 +1875,7 @@ adw_squeezer_set_yalign (AdwSqueezer *self,
* adw_squeezer_get_pages: (attributes org.gtk.Method.get_property=pages)
* @self: a `AdwSqueezer`
*
- * Returns a `GListModel` that contains the pages of the squeezer,
+ * Returns a [iface@Gio.ListModel] that contains the pages of @self.
*
* This can be used to keep an up-to-date view. The model also implements
* [iface@Gtk.SelectionModel] and can be used to track the visible page.
diff --git a/src/adw-tab-view.c b/src/adw-tab-view.c
index f436d9ae..7df25ed5 100644
--- a/src/adw-tab-view.c
+++ b/src/adw-tab-view.c
@@ -3318,7 +3318,7 @@ adw_tab_view_transfer_page (AdwTabView *self,
* adw_tab_view_get_pages: (attributes org.gtk.Method.get_property=pages)
* @self: a `AdwTabView`
*
- * Returns a `GListModel` that contains the pages of @self.
+ * Returns a [iface@Gio.ListModel] that contains the pages of @self.
*
* This can be used to keep an up-to-date view. The model also implements
* [iface@Gtk.SelectionModel] and can be used to track and change the selected
diff --git a/src/adw-view-stack.c b/src/adw-view-stack.c
index 9c651733..4f2e90a7 100644
--- a/src/adw-view-stack.c
+++ b/src/adw-view-stack.c
@@ -2060,7 +2060,7 @@ adw_view_stack_get_interpolate_size (AdwViewStack *self)
* adw_view_stack_get_pages: (attributes org.gtk.Method.get_property=pages)
* @self: a `AdwViewStack`
*
- * Returns a `GListModel` that contains the pages of the stack.
+ * Returns a [iface@Gio.ListModel] that contains the pages of the stack.
*
* This can be used to keep an up-to-date view. The model also implements
* [iface@Gtk.SelectionModel] and can be used to track and change the visible
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]