From 92818939267fc7fbb6a33d86fb78576f55ce6aca Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Tue, 21 Feb 2023 15:13:46 +0100
Subject: Wayland: more detailed documentation of struct fl_wld_buffer
Also, remove Doxygen warning from file bundled-libs.dox
---
documentation/src/bundled-libs.dox | 2 +-
documentation/src/wayland.dox | 8 ++++++--
2 files changed, 7 insertions(+), 3 deletions(-)
(limited to 'documentation/src')
diff --git a/documentation/src/bundled-libs.dox b/documentation/src/bundled-libs.dox
index 6cd6fb494..ba1389922 100644
--- a/documentation/src/bundled-libs.dox
+++ b/documentation/src/bundled-libs.dox
@@ -195,7 +195,7 @@ Run `make depend' in the zlib folder on a Linux system after
- pnglibconf.h: Generate on a Linux system and merge (see above).
- pngprefix.h: Generate on a Linux system and merge (see above).
- makedepend: Keep this file.
- - png.c: keep a change labelled with /* FLTK
+ - png.c: Keep a change labelled with "FLTK"
Run `make depend' in the png folder on a Linux system after
the upgrade to update this file.
diff --git a/documentation/src/wayland.dox b/documentation/src/wayland.dox
index 6100fc485..f9dbb65f1 100644
--- a/documentation/src/wayland.dox
+++ b/documentation/src/wayland.dox
@@ -816,8 +816,12 @@ struct wld_window {
\anchor fl_wld_buffer
struct fl_wld_buffer
-Defined in \c Fl_Wayland_Graphics_Driver.H. One such record is
-created for each shown()'n or resized Fl_Window by \c Fl_Wayland_Graphics_Driver::create_shm_buffer().
+Defined in \c Fl_Wayland_Graphics_Driver.H. One such record is created when and by:
+- an Fl_Window is show()'n or resized, by \c Fl_Wayland_Graphics_Driver::create_shm_buffer();
+- an Fl_Image_Surface object is created, by the \c Fl_Wayland_Image_Surface_Driver c'tor;
+- a custom cursor shape is created or text is dragged, by
+\c Fl_Wayland_Graphics_Driver::create_shm_buffer().
+
struct fl_wld_buffer {
struct wl_buffer *wl_buffer; // the Wayland buffer
--
cgit v1.2.3