summaryrefslogtreecommitdiff
path: root/documentation
AgeCommit message (Collapse)Author
3 dayswip: forkmaxim nikonov
2026-01-20Update bundled libpng to last upstream version 1.6.54ManoloFLTK
2026-01-11Update wayland documentation about function wayland_socket_callback().ManoloFLTK
2026-01-08Documentation: replace HTML table with Doxygen tableAlbrecht Schlosser
... for better readability in the source code. Note: the documentation output is identical.
2026-01-08Documentation: add "Cursor shape" to table of used Wayland interfacesManoloFLTK
2026-01-05Document new use of the "Cursor shape" protocol for the Wayland platform.ManoloFLTK
2026-01-03Speed up PDF generation and add timing debug outputAlbrecht Schlosser
... to the Doxygen generation log file `documentation/pdfall.log`. The additions to the log file are intended to find out which parts take how much time. Note: use `grep "make_pdf" documentation/pdfall.log` to see the log output with timestamps. - documentation/Doxyfile.in: exclude undocumented source files in src/xutf8/* which reduces parsing by a small amount of time, estimated about 5 percent of build time. YMMV.
2025-12-30Clean up .gitignore filesAlbrecht Schlosser
Since FLTK 1.5 building FLTK in the source tree is prohibited by our CMake setup. Therefore all build artifacts are stored in the build tree and don't need to be "ignored" in the source tree. This simplifies the .gitignore files significantly. There are some exceptions though, for instance .cxx and .h files generated by fluid which might be created by a user/developer executing fluid in the source tree.
2025-12-30Reorganize documentation source directoriesAlbrecht Schlosser
- move all images (screenshots) to new folder documentation/images/ - move documentation/src/fltk-title.tex.in to documentation/ - fix .gitignore files (remove obsolete entries etc.) - FL/Fl_Tooltip.H: fix '\image latex' reference - documentation/CMakeLists.txt: update ref. to fltk-title.tex.in - documentation/Doxyfile.in: adjust image path (IMAGE_PATH)
2025-12-29Improve code snapshot generation for PDF docs (#1353)Albrecht Schlosser
CMake: execute `code_snapshot` separately for each file we want to scan so we can create timestamps and generate PNG images only if the source file (e.g. unicode.dox) was modified. documentation/src/unicode.dox: remove output folder `generated`, use only the filename. CMake sets the current working directory as needed. util/code_snapshot.cxx: format and improve comments, reset code buffer so we can generate multiple images per input file.
2025-12-28Update filename case and LaTeX detailsMatthias Melcher
2025-12-28Generate code block documentation using FLTK (#1353)Matthias Melcher
The Doxygen-to-pdf toolchain can not easily generate pdf's with Japanese and Chinese characters. This patch generates code blocks by rendering them in FLTK.
2025-12-22FLUID: Add support for lambda callbacks.Matthias Melcher
Starting the callback text with a '[' assumes that the rest of the callback is a lambda and generates inlined code for it.
2025-12-12Update CMP documentation (still work in progress)Albrecht Schlosser
Fix more PDF generation issues, shorten (wrap) lines, improve text, fix typos. To-do: remove old and/or FLTK 2 stuff, prepare for 1.4 and 1.5.
2025-12-12Update Unicode doc page.Matthias Melcher
Removed texts that don;t translate well from Doxygen to pdf. Improvement based on RokerHRO's comments. Trying to better distinguish characters, codepoints, glyphs, and octets.
2025-12-11Document new use of Wayland protocol "XDG dialog windows"ManoloFLTK
2025-12-10Improve CMP documentation and README.CMake.txt (#1346)Albrecht Schlosser
- fix PDF generation - update some tables, particularly Visual Studio and macOS macros To-do: more details, updates for 1.4 and 1.5, respectively
2025-12-09Update Unicode doc page (#1338).Matthias Melcher
2025-12-08Improve documentation generation for older Doxygen versionsAlbrecht Schlosser
Currently supported Doxygen versions: 1.9.1 and higher. Tested up to Doxygen 1.13.2 as of today. Older doxygen versions may generate bogus warnings or even fail to interpret correct C++ syntax.
2025-12-07Small cmp formatting, section moves, etcGreg Ercolano
2025-12-07More CMP conversion.. complete but not yet checked. (#1346)Greg Ercolano
2025-12-06Move CMP to doxygen - WIP. (#1346)Greg Ercolano
2025-12-06Fix doxygen warningsAlbrecht Schlosser
2025-11-14Fl_Terminal doc fix for 8-bit RGB color ANSI/XTERM codesGreg Ercolano
2025-10-20Doxgen documentation: improve section "Buffer factory"ManoloFLTK
2025-09-13Update bundled libdecor to last upstream version (August 15, 2025)ManoloFLTK
2025-09-09Various improvements and clarifications to "The Wayland backend for its ↵ManoloFLTK
developer"
2025-09-08Remove from Doxygen files information about removed configure-based build ↵ManoloFLTK
system.
2025-09-07Update bundled libpng to version 1.6.50 dated 2025-07-01ManoloFLTK
2025-09-05Remove use of deprecated member function Fl_Menu_Item::setonly()ManoloFLTK
2025-08-05Fix issue under Wayland when erasing overlay rectangle (#1285)ManoloFLTK
2025-08-03Document that the Wayland platform doesn't send FL_HIDE to minimized windows.ManoloFLTK
2025-07-08Fix trailing whitespace and convert a few tabs to spacesAlbrecht Schlosser
... according to CMP
2025-07-03Remove private class Fl_Int_VectorAlbrecht Schlosser
This class was used in pre-C++11 versions (up to 1.4.x) and is no longer needed.
2025-07-02Remove deprecated methods and functionsAlbrecht Schlosser
In FLTK 1.5 we remove most (but not all) methods and functions that were deprecated in FLTK 1.3 or earlier.
2025-06-19Update Fl::await() and friends API and documentationMatthias Melcher
This creates the base for #1263, but does not fix it yet.
2025-05-21Update bundled libdecor to last upstream version (May 14, 2025)ManoloFLTK
2025-05-11Add more documentation about ABI checking and a script to do itAlbrecht Schlosser
misc/abi-check: This new script can be used (on Linux) to check ABI compatibility between patch releases. It does everything required in one execution (after installing the prerequisites once). Documentation is included in the script. It may be modified for other platforms, or ABI checking can be done manually. README.abi-version.txt: add a chapter regarding ABI checks misc/abi-compliance-checker.txt: update documentation on how to run misc/abi-check. In previous versions (1.4) building was done using configure/make. Thus this file was almost completely rewritten. documentation/src/migration_1_4.dox: an unrelated but tiny correction.
2025-05-09Fl_Terminal doc fixes, private->protected for utf8_char_at_*()Greg Ercolano
2025-05-07Remove hardcoded version numbers (part 2) and more documentationAlbrecht Schlosser
The goal is to change the version number for a new release only in CMakeLists.txt. This is the second step. This commit also adds a chapter "Migrating Code from FLTK 1.4 to 1.5". Details: - documentation/CMakeLists.txt: configure 'version.dox' - fluid/documentation/CMakeLists.txt: same as above - documentation/Doxyfile.in: add "Migrating Code from FLTK 1.4 to 1.5" - documentation/src/index.dox: include 'version.dox' and 'migrating...' - fluid/documentation/src/index.dox: same as above - documentation/src/preface.dox: include 'version.dox' - documentation/version.dox.in: input to CMake configure 'version.dox' - fluid/documentation/version.dox.in: same as above - documentation/src/migration_1_4.dox: update links - documentation/src/migration_1_5.dox: new documentation chapter
2025-05-06Remove hardcoded version numbers: part 1Albrecht Schlosser
The goal is to change the version number for a new release only in CMakeLists.txt. This is the first step. Details: - CMake/gen_config.cmake: this new file is included to generate the header files config.h (private, root directory), and FL/fl_config.h (public, can be installed). This file implements also ABI version checks (removed from FL/Enumerations.H and with more checks). Warnings are issued if the chosen ABI version is invalid. - CMake/export.cmake: code to generate 'config.h' was moved to CMake/gen_config.cmake. - CMake/options.cmake: set default of FLTK_BUILD_FORMS=OFF + comments - CMakeLists.txt: move generation of FL/fl_config.h to gen_config.cmake, add API and ABI versions to CMake summary, - FL/Enumerations.H: remove most of the version number details which are now included in FL/fl_config.h. This needed also some doxygen related changes. - README.CMake.txt: improve docs of FL_ABI_VERSION and some more. Reflect the new default of CMake option FLTK_BUILD_FORMS (OFF). - documentation/Doxyfile.in: add FL/fl_config.h to file list. This file is created in the build tree (and may be "installed"). - fl_config.h.in: add version number details that have been moved here from Enumerations.H (used to generate FL/fl_config.h).
2025-05-01Documentation: clarify version numbers and fix minor issuesAlbrecht Schlosser
Remove references to "current" version numbers, use 1.2.3 as example for clarity and to simplify version number updates. Also: minor textual fixes (typos), unwrap lines, etc.. Todo: Documentation states: "This file is not actively maintained any more, but is left here as a reference, until the doxygen documentation is completed." Check if the documentation generated by doxygen from source files contains everything needed so this file can be removed.
2025-04-23Fix forgotten `run_pdflatex` call (1.5)Matthias Melcher
2025-04-07Revised version of the glpuzzle man page.Matthias Melcher
2025-04-04Update man pages of games (demo programs), add glpuzzle.manAlbrecht Schlosser
Prepare for installation of `games` demo programs. Fix inconsistencies and typos in man pages. In the future the man pages can be installed together with the executables. This will be done in a later commit. documentation/src/glpuzzle.man: new file.
2025-04-04Update bundled libdecor to last upstream version (Apr 4, 2025)ManoloFLTK
2025-04-03Merge remote-tracking branch 'refs/remotes/origin/master'ManoloFLTK
2025-04-02Use CMake's built-in timestamp formatting.Aaron M. Ucko
It notably honors SOURCE_DATE_EPOCH if set, making for reproducible output. For even better reproducibility, use UTC. (Unlike the date command's output, the result is already always in English.) Extend this approach to the book, introducing appropriately formatted PDF_DATE and TODAY variables for its PDF metadata and title page respectively and making make_pdf configurable.
2025-03-20Update documentation of the Wayland platform implementationManoloFLTK
2025-03-19Update bundled libdecor to last upstream version (9 mar 2025)ManoloFLTK