From bf16e4e8aaff642e47defcbb0f0aa992b20bb0b7 Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Tue, 8 Feb 2022 08:03:35 +0100
Subject: More detailed doc of Fl_Window::decorated_h() for X11 platform.

---
 FL/Fl_Window.H | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'FL/Fl_Window.H')

diff --git a/FL/Fl_Window.H b/FL/Fl_Window.H
index ddcea3fbe..27465c433 100644
--- a/FL/Fl_Window.H
+++ b/FL/Fl_Window.H
@@ -512,6 +512,7 @@ public:
   /** Returns the window width including any frame added by the window manager.
 
    Same as w() if applied to a subwindow, or if window is not yet mapped.
+   \see decorated_h().
    */
   int decorated_w() const;
 
@@ -519,9 +520,14 @@ public:
    added by the window manager.
 
    Same as h() if applied to a subwindow, or if window is not yet mapped.
-   \note Under X11, it's not possible to compute decorated_h() - h()
-   to obtain the height of the titlebar <b> during a resize operation</b>.
-   That computation is to best done when the window is first mapped.
+   \note Under X11, FLTK is able to compute the size of window titlebars and borders
+   only if these decoration elements are strictly X11-based. When that's not the case,
+   decorated_h() returns the same value as h() and decorated_w() as w(), and FLTK
+   cannot access window decorations.
+   
+   \note Under X11 again, the values returned by decorated_h() and decorated_w()
+   may not be reliable <b> during a resize operation</b>. The size of decoration elements
+   of a window is best computed when the window is first mapped.
    */
   int decorated_h() const;
 
-- 
cgit v1.2.3