diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2023-02-02 18:47:16 +0100 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2023-02-02 19:05:43 +0100 |
| commit | 32b6c04bcf4f9977b38a15e84739e8395f57e97b (patch) | |
| tree | ad65149541812bd7ba084e7e9eba552cd82b85f3 /documentation/src/basics.dox | |
| parent | 6276822e9e8f505756b386637df9e14dd5a8e2fb (diff) | |
Documentation: clarify header inclusion requirements
Since FLTK 1.4.0 inclusion of FL/Fl.H is no longer a requirement
unless class Fl is used (e.g. Fl::run()) or if it is used to include
other headers like FL/Enumerations.H
Diffstat (limited to 'documentation/src/basics.dox')
| -rw-r--r-- | documentation/src/basics.dox | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/documentation/src/basics.dox b/documentation/src/basics.dox index a29d710f4..e531c8752 100644 --- a/documentation/src/basics.dox +++ b/documentation/src/basics.dox @@ -7,11 +7,16 @@ that use FLTK. \section basics_writing Writing Your First FLTK Program -All programs must include the file <tt><FL/Fl.H></tt>. This file -should be included as the first FLTK header file. -In addition the program must include a header file for each -FLTK class it uses. Listing 1 shows a simple "Hello, -World!" program that uses FLTK to display the window. +Up to FLTK 1.3.x all FLTK programs were required to include the file +<tt><FL/Fl.H></tt> as the first FLTK header file. + +Since FLTK 1.4.0 this requirement was relaxed and <tt><FL/Fl.H></tt> needs +only be included if the class \c Fl is used or if some other stuff like +enumerations is used in the source code. Example code in this documentation +may still include it "everywhere" even if it is no longer strictly required. + +In addition the program must include a header file for each FLTK class it uses. +Listing 1 shows a simple "Hello, World!" program that uses FLTK to display the window. \par Listing 1 - "hello.cxx" \code |