summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2022-04-20 17:25:32 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2022-04-20 17:26:33 +0200
commit804c48515d63393d12f61f8a783dc9f0586fcdba (patch)
treef318fe212f580e753da969c3c68481ab83a7bc99 /FL
parentc1d0783df9b639e85ddb99477ca8b2a5dd962d93 (diff)
Improve docs of Fl_Image and related classes (#431)
Clarifications as discussed since April 15, 2022 07:00 UTC (see GitHub issue #431).
Diffstat (limited to 'FL')
-rw-r--r--FL/Fl_Image.H6
-rw-r--r--FL/Fl_Shared_Image.H2
2 files changed, 4 insertions, 4 deletions
diff --git a/FL/Fl_Image.H b/FL/Fl_Image.H
index 34c545ea9..038384991 100644
--- a/FL/Fl_Image.H
+++ b/FL/Fl_Image.H
@@ -54,8 +54,8 @@ enum Fl_RGB_Scaling {
returned by w() and h(). These values are equal to data_w() and data_h() when
the image is created and can be changed by the scale() member function.
- Since the Fl_Image class does not support image drawing by itself, calling
- the draw() method results in a box with an X in it being drawn instead.
+ Since the Fl_Image class does not support image drawing by itself, calling the
+ Fl_Image::draw() method results in a box with an X in it being drawn instead.
*/
class FL_EXPORT Fl_Image {
friend class Fl_Graphics_Driver;
@@ -239,7 +239,7 @@ public:
/**
Creates a copy of the image in the same size.
- The copied image should be released when you are done with it.
+ The new image should be released when you are done with it.
This does exactly the same as 'Fl_Image::copy(int W, int H) const' where
\p W and \p H are the width and height of the source image, respectively.
diff --git a/FL/Fl_Shared_Image.H b/FL/Fl_Shared_Image.H
index 88a3050be..07551b70e 100644
--- a/FL/Fl_Shared_Image.H
+++ b/FL/Fl_Shared_Image.H
@@ -176,7 +176,7 @@ public:
\note The internal image (pointer) is protected for good reasons, e.g.
to prevent access to the image so it can't be modified by user code.
- \b DO \b NOT cast away the 'const' to modify the image.
+ \b DO \b NOT cast away the 'const' attribute to modify the image.
User code should rarely need this method. Use with caution.