docs: Add/fix some links; avoid pluralisation
authorDaniel Boles <dboles.src@gmail.com>
Wed, 9 Aug 2023 14:34:50 +0000 (15:34 +0100)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 24 Aug 2023 14:18:28 +0000 (10:18 -0400)
Appending `s` breaks the [type@NS.Object] notation, so fix that in
ListHeader. Add links to ListItem and Overlay, and avoid appending `s`
after `backtick`s just for consistency with the [type@NS.Object] issue.

gtk/gtklistheader.c
gtk/gtklistitem.c
gtk/gtkoverlaylayout.c

index 62cfd5b4c9b63cd3835c14a8298ae72ce8ccc509..14f0c6ffcbfc05d260beeee4baa5253459ae96f2 100644 (file)
@@ -27,9 +27,9 @@
  * `GtkListHeader` is used by list widgets to represent the headers they
  * display.
  *
- * The `GtkListHeader`s are managed just like [class@gtk.ListItem]s via
- * their factory, but provide a different set of properties suitable for
- * managing the header instead of individual items.
+ * `GtkListHeader` objects are managed just like [class@Gtk.ListItem]
+ * objects via their factory, but provide a different set of properties suitable
+ * for managing the header instead of individual items.
  *
  * Since: 4.12
  */
index a06a43a28dbd0a883cfab98f2894983ff0b99229..bb07c1f83291e45d9d62cf194f924216be364641 100644 (file)
 /**
  * GtkListItem:
  *
- * `GtkListItem` is used by list widgets to represent items in a `GListModel`.
+ * `GtkListItem` is used by list widgets to represent items in a
+ * [iface@Gio.ListModel].
  *
- * The `GtkListItem`s are managed by the list widget (with its factory)
+ * `GtkListItem` objects are managed by the list widget (with its factory)
  * and cannot be created by applications, but they need to be populated
  * by application code. This is done by calling [method@Gtk.ListItem.set_child].
  *
- * `GtkListItem`s exist in 2 stages:
+ * `GtkListItem` objects exist in 2 stages:
  *
  * 1. The unbound stage where the listitem is not currently connected to
  *    an item in the list. In that case, the [property@Gtk.ListItem:item]
index 33f8de7a20eed37391414df1bdb2eb655c2190c9..176e9d5a7ab874342893e77f212972a543020475 100644 (file)
 /**
  * GtkOverlayLayout:
  *
- * `GtkOverlayLayout` is the layout manager used by `GtkOverlay`.
+ * `GtkOverlayLayout` is the layout manager used by [class@Gtk.Overlay].
  *
  * It places widgets as overlays on top of the main child.
  *
  * This is not a reusable layout manager, since it expects its widget
- * to be a `GtkOverlay`. It only listed here so that its layout
+ * to be a `GtkOverlay`. It is only listed here so that its layout
  * properties get documented.
  */