From 32b6c04bcf4f9977b38a15e84739e8395f57e97b Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Thu, 2 Feb 2023 18:47:16 +0100 Subject: 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 --- documentation/src/basics.dox | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'documentation/src/basics.dox') 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 . 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 + as the first FLTK header file. + +Since FLTK 1.4.0 this requirement was relaxed and 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 -- cgit v1.2.3