monitor: Document connector names better
authorMatthias Clasen <mclasen@redhat.com>
Thu, 2 Feb 2023 11:14:49 +0000 (12:14 +0100)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 2 Feb 2023 11:32:28 +0000 (12:32 +0100)
gdk/gdkmonitor.c

index ccf1d4b8bcd013fc0a26aa93386ca65a1a304800..2d6cbb4fdeb55ce061e19aab55d8b92f4ba9cb72 100644 (file)
@@ -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 *