From 3a8daf70c05692d73ded3a64d004a685c5ea2df6 Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Tue, 19 Mar 2024 08:52:49 +0100
Subject: Document fl_close_display()

---
 src/Fl.cxx | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/Fl.cxx b/src/Fl.cxx
index 0501483a6..16672cfcc 100644
--- a/src/Fl.cxx
+++ b/src/Fl.cxx
@@ -2198,12 +2198,19 @@ void Fl::disable_im()
  Opens the display.
  Automatically called by the library when the first window is show()'n.
  Does nothing if the display is already open.
+ \note Requires ##include <FL/platform.H>
  */
 void fl_open_display()
 {
   Fl::screen_driver()->open_display();
 }
 
+/** Closes the connection to the windowing system when that's possible.
+You do \e not need to call this to exit, and in fact it is faster to not do so. It may be
+useful to call this if you want your program to continue without
+a GUI. You cannot open the display again, and cannot call any FLTK functions.
+ \note Requires ##include <FL/platform.H>
+*/
 void fl_close_display()
 {
   Fl::screen_driver()->close_display();
-- 
cgit v1.2.3