monitor: Document connector names better

2023-02-02 12:14:49 +01:00
parent e6998dffe8
commit 3dfeb2fd37
1 changed files with 4 additions and 0 deletions
--- a/gdk/gdkmonitor.c
+++ b/gdk/gdkmonitor.c
@@ -377,6 +377,10 @@ gdk_monitor_get_height_mm (GdkMonitor *monitor)
 *
 * Gets the name of the monitor's connector, if available.
 *
+ * These are strings such as "eDP-1", or "HDMI-2". They depend
+ * on software and hardware configuration, and should not be
+ * relied on as stable identifiers of a specific monitor.
+ *
 * Returns: (transfer none) (nullable): the name of the connector
 */
 const char *