Merge branch 'unix-mounts-docs' into 'main'

gunixmounts: Clarify GUnixMountMonitor documentation and convert to gi-docgen linking syntax

Closes #3569

See merge request GNOME/glib!4447

docs/reference/gio/gio.toml.in

@@ -73,3 +73,38 @@ content_images = [
   "menu-model-dark.svg",
   "menu-model-light.svg",
 ]
+
+# We have to hide the GioUnix and GioWin32 symbols from the documentation — they
+# have to be present in the GIR files (until we next break API), but their
+# documentation is split out to gio-{unix,win32}.toml.
+[[object]]
+pattern = "Unix[A-Z].+"
+hidden = true
+
+[[object]]
+pattern = "unix_.+"
+hidden = true
+
+[[struct]]
+pattern = "Unix[A-Z].+"
+hidden = true
+
+[[function]]
+pattern = "unix_.+"
+hidden = true
+
+[[object]]
+pattern = "Win32[A-Z].+"
+hidden = true
+
+[[object]]
+pattern = "win32_.+"
+hidden = true
+
+[[struct]]
+pattern = "Win32[A-Z].+"
+hidden = true
+
+[[function]]
+pattern = "win32_.+"
+hidden = true

docs/reference/glib/glib.toml.in

@@ -128,3 +128,38 @@ hidden = true
 [[object]]
 pattern = "macro__has_*"
 hidden = true
+
+# We have to hide the GioUnix and GioWin32 symbols from the documentation — they
+# have to be present in the GIR files (until we next break API), but their
+# documentation is split out to glib-{unix,win32}.toml.
+[[object]]
+pattern = "Unix[A-Z].+"
+hidden = true
+
+[[object]]
+pattern = "unix_.+"
+hidden = true
+
+[[struct]]
+pattern = "Unix[A-Z].+"
+hidden = true
+
+[[function]]
+pattern = "unix_.+"
+hidden = true
+
+[[object]]
+pattern = "Win32[A-Z].+"
+hidden = true
+
+[[object]]
+pattern = "win32_.+"
+hidden = true
+
+[[struct]]
+pattern = "Win32[A-Z].+"
+hidden = true
+
+[[function]]
+pattern = "win32_.+"
+hidden = true

gio/gunixmounts.h

@@ -55,7 +55,14 @@ GType g_unix_mount_point_get_type (void) G_GNUC_CONST;
 /**
  * GUnixMountMonitor:
  *
- * Watches #GUnixMounts for changes.
+ * Watches for changes to the set of mount entries and mount points in the
+ * system.
+ *
+ * Connect to the [signal@GioUnix.MountMonitor::mounts-changed] signal to be
+ * notified of changes to the [struct@GioUnix.MountEntry] list.
+ *
+ * Connect to the [signal@GioUnix.MountMonitor::mountpoints-changed] signal to
+ * be notified of changes to the [struct@GioUnix.MountPoint] list.
  **/
 typedef struct _GUnixMountMonitor      GUnixMountMonitor;
 typedef struct _GUnixMountMonitorClass GUnixMountMonitorClass;