summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2024-10-15 18:59:28 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2024-10-15 18:59:28 +0200
commitd589c05b1741bf699897feef73c35a58592dc876 (patch)
tree1558a7eebd6ad40768dbc6f8bd454d5d01096666 /FL
parent957fa1fe3751a10478d4ce4c5971d9d9dd17966d (diff)
Fix documentation typos and trailing whitespace
Diffstat (limited to 'FL')
-rw-r--r--FL/Fl_Preferences.H10
-rw-r--r--FL/Fl_Widget.H2
-rw-r--r--FL/fl_draw.H2
-rw-r--r--FL/names.h6
4 files changed, 10 insertions, 10 deletions
diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H
index dfdc7debe..591f1d230 100644
--- a/FL/Fl_Preferences.H
+++ b/FL/Fl_Preferences.H
@@ -43,7 +43,7 @@
in a key name are treated as subgroups, i.e. the key 'window/width' would
actually refer to the key 'width' inside the group 'window'.
- Keys have a unique name within their group. A value can be any string includin
+ Keys have a unique name within their group. A value can be any string including
control characters 0x00 to 0x1f, 0x7f, and UTF-8 octets.
Several methods allow setting and getting numerical values and binary data.
@@ -61,11 +61,11 @@
may change at any time. Preferences files are not meant to be created
or edited "by hand."
- FLTK preferences are not meant to replace a fully features database. No merging
+ FLTK preferences are not meant to replace a fully featured database. No merging
of data takes place. If several instances of an app access the same database at
the same time, only the most recent changes will persist.
- Preferences should no be used to store document data. The .prefs file should
+ Preferences should not be used to store document data. The .prefs file should
be kept small for performance reasons. One application can have multiple
preferences files. Extensive binary data however should be stored in separate
files: see \a Fl_Preferences::get_userdata_path() .
@@ -135,9 +135,9 @@ public:
MEMORY, ///< Returned if querying memory mapped preferences
ROOT_MASK = 0x00FF, ///< Mask for the values above
CORE = 0x0100, ///< OR'd by FLTK to read and write core library preferences and options
- C_LOCALE = 0x1000, ///< This flag should always be set, it makes sure that floating point
+ C_LOCALE = 0x1000, ///< This flag should always be set to ensure that floating point values
+ ///< are written and read correctly independently of the current locale
CLEAR = 0x2000, ///< Don't read a possibly existing database. Instead, start with an empty set of preferences.
- ///< values are written correctly independently of the current locale
SYSTEM_L = SYSTEM | C_LOCALE, ///< Preferences are used system-wide, locale independent
USER_L = USER | C_LOCALE, ///< Preferences apply only to the current user, locale independent
CORE_SYSTEM_L = CORE | SYSTEM_L, ///< Same as CORE | SYSTEM | C_LOCALE
diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H
index c9fe89bba..d10d42ef5 100644
--- a/FL/Fl_Widget.H
+++ b/FL/Fl_Widget.H
@@ -693,7 +693,7 @@ public:
/** Set the gap between the label and the image in pixels.
This value is limited to 0..255.
- \param[in] gap spacing in pixels
+ \param[in] gap spacing in pixels
*/
void label_image_spacing(int gap) { label_.spacing = (uchar)gap; }
diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index f5575e950..6535d031a 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -997,7 +997,7 @@ FL_EXPORT void fl_measure(const char *str, int &x, int &y, int draw_symbols = 1)
as graphical symbols
\param[in] spacing spacing between text and image
*/
-FL_EXPORT void fl_draw(const char *str, int x, int y, int w, int h,
+FL_EXPORT void fl_draw(const char *str, int x, int y, int w, int h,
Fl_Align align, Fl_Image *img = 0,
int draw_symbols = 1, int spacing = 0);
/**
diff --git a/FL/names.h b/FL/names.h
index 15a491f84..984afbfe0 100644
--- a/FL/names.h
+++ b/FL/names.h
@@ -1,7 +1,7 @@
//
-// Event names header file for the Fast Light Tool Kit (FLTK).
+// Event and other names header file for the Fast Light Tool Kit (FLTK).
//
-// Copyright 1998-2023 by Bill Spitzak and others.
+// Copyright 1998-2024 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file. If this
@@ -116,7 +116,7 @@ const char * const fl_fontnames[] =
};
/**
- This is an array of callback reason names you can use to convert font numbers into names.
+ This is an array of callback reason names you can use to convert callback reasons into names.
The array gets defined inline wherever your '\#include <FL/names.h>' appears.
*/