From 157d27606fc8881e637428f211aae8f3b0d27754 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Fri, 4 Aug 2023 21:30:11 +0200 Subject: Fix typos in documentation of fl_overlay_rect() etc. (#735) Thanks to Matt for the improved docs, I just fixed some typos and added '()'s for better doxygen comments of functions. --- src/fl_overlay.cxx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/fl_overlay.cxx b/src/fl_overlay.cxx index 350c92b3e..31b79b5e4 100644 --- a/src/fl_overlay.cxx +++ b/src/fl_overlay.cxx @@ -94,9 +94,9 @@ void fl_overlay_clear() { The typical (and only) use for this function is to draw a selection rectangle during a mouse drag event sequence without having to redraw the entire content - of the wideget. + of the widget. - Your event handle should look similar to this (also see `test/mandelbrot`): + Your event handle should look similar to this (also see `test/mandelbrot.cxx`): ``` int MyWidget::handle(int event) { static int ix, iy; @@ -110,7 +110,7 @@ void fl_overlay_clear() { return 1; case FL_RELEASE: this->make_current(); - fl_clear_overlay(); + fl_overlay_clear(); // select the element under the rectangle return 1; } @@ -121,11 +121,11 @@ void fl_overlay_clear() { \note Between drawing an overlay rect and clearing it, the content of the widget must not change. - \note fl_overlay_rect and fl_clear_overlay should be called when the actual + \note fl_overlay_rect() and fl_overlay_clear() should be called when the actual event occurs, and *not* within `MyWidget::draw()`. - \note fl_overlay_rect and fl_clear_overlay should not be mixed with - Fl_Overlay_Window. Fl_Overlay_Window provides and entirely different way of + \note fl_overlay_rect() and fl_overlay_clear() should not be mixed with + Fl_Overlay_Window. Fl_Overlay_Window provides an entirely different way of drawing selection outlines and is not limited to rectangles. \param x, y, w, h position and size of the overlay rectangle. -- cgit v1.2.3