summaryrefslogtreecommitdiff
path: root/src/drivers/Android/Fl_Android_Graphics_Clipping.H
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2018-06-23 20:50:22 +0000
committerMatthias Melcher <fltk@matthiasm.com>2018-06-23 20:50:22 +0000
commitb8e97d7c28ad6f168e9314dab3c7651365b1c71c (patch)
treeaa722d1eb241aef345b6009fac807f060f82f7c6 /src/drivers/Android/Fl_Android_Graphics_Clipping.H
parentb1598dc70362f331da7a65f1e5ddece7c88299f3 (diff)
Doxygen only: fixed all block comments starting with an asterisk to space-only, fixed doxygen keywords prepended with @ to use a backward slash instead. No code was changed.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12970 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/drivers/Android/Fl_Android_Graphics_Clipping.H')
-rw-r--r--src/drivers/Android/Fl_Android_Graphics_Clipping.H68
1 files changed, 34 insertions, 34 deletions
diff --git a/src/drivers/Android/Fl_Android_Graphics_Clipping.H b/src/drivers/Android/Fl_Android_Graphics_Clipping.H
index 349be87e1..863c1d51b 100644
--- a/src/drivers/Android/Fl_Android_Graphics_Clipping.H
+++ b/src/drivers/Android/Fl_Android_Graphics_Clipping.H
@@ -32,11 +32,11 @@ class Fl_Android_Window_Driver;
/**
- * The Fl_Rect_Region describes a rectangular clipping region.
- *
- * Contrary to common FLTK convention, rectangles are stored with coordinates
- * instead of their width and height to accelerate calculations. The discreet
- * constructor however uses the old convention for convenience.
+ The Fl_Rect_Region describes a rectangular clipping region.
+
+ Contrary to common FLTK convention, rectangles are stored with coordinates
+ instead of their width and height to accelerate calculations. The discreet
+ constructor however uses the old convention for convenience.
*/
class Fl_Rect_Region
{
@@ -82,35 +82,35 @@ private:
/**
- * The Fl_Complex_Region represents a clipping region of any shape.
- *
- * This class is organized in a tree-like structure. If the region is
- * rectangular, is_simple() returns 1 and the rectangle can be used just
- * as in Fl_Rect_Region.
- *
- * If a more complex representation is needed, subregions are created which are
- * guaranteed to lie within the bounding box of the current region. Subregions
- * themselves can again contain sub-subregions to describe the entire clipping
- * region, effectively creating a tree where the leafs contain the rectangles
- * that together describe the clipping area.
- *
- * To make life easier, Fl_Complex_Region provides two types of iterator to
- * travers the entire tree.
- *
- * 1. Fl_Complex_Region itself is compatible to C++11 range-based loops and
- * can bewalked simply by writing ``for (auto &&it: rgn) { ... }``.
- *
- * 2. Fl_Complex_Region provides an alternative iterator that loop only through
- * leafs that intersects with a given rectangle. The returned object
- * provides access to the readily clipped rectangle.
- *
- * @code
- * Fl_Complex_Region rgn(something);
- * for (auto &&it: rgn.iterate(Fl_Rect_Region(0, 0, 100, 100)) {
- * draw_something(it->rect());
- * }
- * @endcode
- *
+ The Fl_Complex_Region represents a clipping region of any shape.
+
+ This class is organized in a tree-like structure. If the region is
+ rectangular, is_simple() returns 1 and the rectangle can be used just
+ as in Fl_Rect_Region.
+
+ If a more complex representation is needed, subregions are created which are
+ guaranteed to lie within the bounding box of the current region. Subregions
+ themselves can again contain sub-subregions to describe the entire clipping
+ region, effectively creating a tree where the leafs contain the rectangles
+ that together describe the clipping area.
+
+ To make life easier, Fl_Complex_Region provides two types of iterator to
+ travers the entire tree.
+
+ 1. Fl_Complex_Region itself is compatible to C++11 range-based loops and
+ can bewalked simply by writing ``for (auto &&it: rgn) { ... }``.
+
+ 2. Fl_Complex_Region provides an alternative iterator that loop only through
+ leafs that intersects with a given rectangle. The returned object
+ provides access to the readily clipped rectangle.
+
+ \code
+ Fl_Complex_Region rgn(something);
+ for (auto &&it: rgn.iterate(Fl_Rect_Region(0, 0, 100, 100)) {
+ draw_something(it->rect());
+ }
+ \endcode
+
*/
class Fl_Complex_Region : public Fl_Rect_Region
{