docs: Clarify gdk_display_get_default_seat() docs
authorMatthias Clasen <mclasen@redhat.com>
Fri, 15 May 2020 03:14:04 +0000 (23:14 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 15 May 2020 18:11:53 +0000 (14:11 -0400)
This function can return %NULL if the display
does not have a seat. Document that.

gdk/gdkdisplay.c

index 9274ca13188dc1b07d35820acd0fff7de8dc5887..f99128459eba31b88799a4440ab31b893bda64ce 100644 (file)
@@ -1497,7 +1497,10 @@ gdk_display_remove_seat (GdkDisplay *display,
  *
  * Returns the default #GdkSeat for this display.
  *
- * Returns: (transfer none): the default seat.
+ * Note that a display may not have a seat. In this case,
+ * this function will return %NULL.
+ *
+ * Returns: (transfer none) (nullable): the default seat.
  **/
 GdkSeat *
 gdk_display_get_default_seat (GdkDisplay *display)