From c47cbf4402113cf09aeb57b4446983a4ec1a7928 Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Mon, 10 Jul 2023 09:18:26 +0200
Subject: More detailed documentation of Fl::screen_xywh()

---
 src/screen_xywh.cxx | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src')

diff --git a/src/screen_xywh.cxx b/src/screen_xywh.cxx
index 87fa2d6ae..0634a686e 100644
--- a/src/screen_xywh.cxx
+++ b/src/screen_xywh.cxx
@@ -94,6 +94,8 @@ void Fl::screen_work_area(int &X, int &Y, int &W, int &H, int mx, int my)
  \param[out]  X,Y,W,H the work area bounding box
  \param[in] n the screen number (0 to Fl::screen_count() - 1)
  \see void screen_xywh(int &x, int &y, int &w, int &h, int mx, int my)
+ \note Like all quantities accessible via public APIs of FLTK, values of \p X,Y,W,H
+ are given in FLTK units, that is, in drawing units divided by the scaling factor of screen \p n.
 */
 void Fl::screen_work_area(int &X, int &Y, int &W, int &H, int n)
 {
@@ -106,6 +108,8 @@ void Fl::screen_work_area(int &X, int &Y, int &W, int &H, int n)
   Under Windows, Mac OS X, and the Gnome desktop, screen #0 contains the menubar/taskbar
   \param[out]  X,Y,W,H the corresponding screen bounding box
   \param[in] n the screen number (0 to Fl::screen_count() - 1)
+  \note Like all quantities accessible via public APIs of FLTK, values of \p X,Y,W,H
+  are given in FLTK units, that is, in drawing units divided by the scaling factor of screen \p n.
   \see void screen_xywh(int &x, int &y, int &w, int &h, int mx, int my)
 */
 void Fl::screen_xywh(int &X, int &Y, int &W, int &H, int n)
-- 
cgit v1.2.3