summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2023-02-21 15:13:46 +0100
committerManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2023-02-21 15:13:46 +0100
commit92818939267fc7fbb6a33d86fb78576f55ce6aca (patch)
tree41e0dc5b87c9c84012c47070f1f8ad8f3b6d7da7
parentce45bcae2f4802ab012aa08ba19e05825ef5b176 (diff)
Wayland: more detailed documentation of struct fl_wld_buffer
Also, remove Doxygen warning from file bundled-libs.dox
-rw-r--r--documentation/src/bundled-libs.dox2
-rw-r--r--documentation/src/wayland.dox8
2 files changed, 7 insertions, 3 deletions
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
<h3>struct fl_wld_buffer</h3>
-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().
+
<pre>
struct fl_wld_buffer {
struct wl_buffer *wl_buffer; // the Wayland buffer