summaryrefslogtreecommitdiff
path: root/documentation/src/preface.dox
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2024-04-27 19:46:25 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2024-04-27 19:46:25 +0200
commit05d37f9e4e63458beb92c5be1877b480baf19e27 (patch)
tree5989fb3183c6c87ef1fd17973d33dea604cce4c5 /documentation/src/preface.dox
parent9cdd457382ea5da11c3dfa49320d920dc7ea7dfd (diff)
Improve documentation (preface + intro)
Update particularly Windows (but also other) build instructions.
Diffstat (limited to 'documentation/src/preface.dox')
-rw-r--r--documentation/src/preface.dox24
1 files changed, 11 insertions, 13 deletions
diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox
index 0bfc54c55..7c3c9241e 100644
--- a/documentation/src/preface.dox
+++ b/documentation/src/preface.dox
@@ -4,17 +4,15 @@
This manual describes the Fast Light Tool Kit ("FLTK")
version 1.4.0, a C++ Graphical User Interface
-("GUI") toolkit for UNIX, Microsoft Windows and Apple OS X.
+("GUI") toolkit for UNIX, Microsoft Windows and Apple macOS.
-Version 1.4.0 introduces support for a new windowing system
-under Linux/Unix: Wayland. FLTK applications under Linux/Unix
-run, unchanged, as Wayland or X11 clients depending on what's
-available at run-time.
+Version 1.4.0 introduces support for a new windowing system under
+Linux/Unix: Wayland. FLTK applications under Linux/Unix run unchanged
+as Wayland or X11 clients depending on availability at run-time.
Each of the chapters in this manual is designed as a tutorial for
using FLTK, while the appendices provide a convenient reference
-for all FLTK widgets, functions, and operating system
-interfaces.
+for all FLTK widgets, functions, and operating system interfaces.
<B>This manual may be printed, modified, and/or used under
the terms of the FLTK license provided in \ref license.</B>
@@ -46,7 +44,7 @@ This manual is organized into the following chapters and appendices:
\section preface_conventions Conventions
This manual was generated using Doxygen
-(see http://www.doxygen.org/)
+(see https://www.doxygen.org/)
to process the source code itself, special comments in the code,
and additional documentation files.
In general, Doxygen recognizes and denotes the following entities as shown:
@@ -54,7 +52,7 @@ In general, Doxygen recognizes and denotes the following entities as shown:
- methods, such as Fl_Widget::callback(Fl_Callback* cb, void* p),
- functions, such as fl_draw(const char *str, int x, int y),
- internal links, such as \ref preface_conventions,
-- external links, such as http://www.stack.nl/~dimitri/doxygen/
+- external links, such as https://www.fltk.org/.
Other code samples and commands are shown in <tt>regular courier type</tt>.
@@ -74,10 +72,10 @@ Windows XP, Windows Vista, Windows 7 and later Windows versions.
FLTK uses the preprocessor definition <tt>_WIN32</tt> for the 32 bit
and 64 bit Windows API.
-\par OS X, <tt>__APPLE__</tt>
-The Apple desktop operating sytem OS X 10.0 and later. MacOS 8 and 9 support
+\par macOS (aka Mac OS X), <tt>__APPLE__</tt>
+The Apple desktop operating sytem macOS 10.0 and later. MacOS 8 and 9 support
was dropped after FLTK 1.0.10. FLTK uses the preprocessor definition
-<tt>__APPLE__</tt> for OS X.
+<tt>__APPLE__</tt> for macOS.
\section preface_copyrights Copyrights and Trademarks
@@ -88,7 +86,7 @@ License with 4 exceptions, located in \ref license.
UNIX is a registered trademark of the X Open Group, Inc.
Microsoft and Windows are registered trademarks of Microsoft
Corporation. OpenGL is a registered trademark of Silicon
-Graphics, Inc. Apple, Macintosh, MacOS, and Mac OS X are
+Graphics, Inc. Apple, Macintosh, MacOS, macOS, and Mac OS X are
registered trademarks of Apple Computer, Inc.