summaryrefslogtreecommitdiff
path: root/documentation/Doxyfile.in
AgeCommit message (Collapse)Author
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-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-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-06Move CMP to doxygen - WIP. (#1346)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).
2024-04-25Prevent "The GTK protocol" from being included in the FLTK documentationManoloFLTK
2024-04-17Separate FLUID user documentation, screen shot automation (#936)Matthias Melcher
* CMake integration, no autotiools * alignment panel is now correctly renamed to setting panel * source view is now correctly renamed to code view * Merge FLTK FLUID docs into FLUID user manual. * Add two simple entry tutorials * Remove FLUID chapter form FLTK docs. * GitHub action to generate HTML and PDF docs and make the available as artefacts
2023-11-14Fl_Terminal widget (#800)erco77
Pull Fl_Terminal widget from Greg's fork
2023-09-07Update Doxyfile.in again, now using all defined doxygen tagsAlbrecht Schlosser
The process to generate the docs now uses the full Doxyfile as given by `doxygen -u Doxyfile.in` with a specific doxygen version, in this commit version 1.8.14. There's only one addition: 'HTML_COLORSTYLE = TOGGLE' which has been added to doxygen in version 1.9.5. We're using it now to give the user the choice to select a "dark mode" or "light mode" theme if the docs are generated with doxygen 1.9.5 or later. Unknown doxygen tags are now filtered silently and logged in files documentation/Doxyfile_error.log and documentation/Doxybook_error.log, respectively.
2023-09-07Update Doxyfile.in from doxygen version 1.5.5 to 1.8.14Albrecht Schlosser
Most (if not all) doxygen tags introduced after 1.5.5 are commented out to avoid doxygen warnings about obsolete or unknown tags, except those tags that need a specific value. Add 'HTML_COLORSTYLE = TOGGLE' (since 1.9.5) for better user experience. With this tag users can switch between dark and light mode *if* the docs were generated with doxygen 1.9.5 or later. Enable search engine. Log doxygen conversion errors and warnings to Doxy*_error.log, i.e. silence the doxygen conversion process. documentation/src/index.dox: Remove background color from html index page for better contrast when using dark mode.
2023-05-09Fix doxygen doc generation and document platform specific filesAlbrecht Schlosser
Pure platform specific files like 'src/*_win32.cxx' are excluded from doxygen processing and don't need doxygen specific guard macros. Document this fact prominently at the beginning of each file. Fix exclude patterns and remove duplicates from Doxyfile.in.
2023-03-09CMake: build shared libs with OPTION_CAIROEXT (issue #250)Albrecht Schlosser
- remove separate libfltk_cairo to avoid cyclic dependencies, but - keep a dummy libfltk_cairo in 1.4.0 for backwards compatibility - move cairo/Fl_Cairo.cxx to src/Fl_Cairo.cxx - add preliminary Cairo support for Visual Studio (MSVC) Static linking is not affected by this change, but users building with hand-made Makefiles will have to remove libfltk_cairo starting with FLTK 1.4.0. The dummy library can be linked for backwards compatibility but it will be removed later (in 1.4.x or 1.5.0). The shared FLTK library libfltk.{so|dylib|dll|..} depends on libcairo if and only if FLTK is built with one of the Cairo options. This has always been the case for OPTION_CAIROEXT but is now also true if only OPTION_CAIRO is selected, i.e. FLTK programs linked with a Cairo enabled shared FLTK library will also be linked with libcairo. The same is true for configure options --enable-cairo and --enable-cairoext, respectively. Preliminary Cairo support for MSVC now detects a Cairo installation using the CMake variable FLTK_CAIRO_DIR which must be set by the user. Note that this feature is temporary and may be changed in the future for a better and more comfortable version.
2023-02-05Doxygen fix for FL_DEPRECATEDMatthias Melcher
2023-01-25Create new documentation chapter for FLTK developersManoloFLTK
Add Doxygen-formatted description of the Wayland backend Add bundled-libs.dox Delete README.bundled-libs.txt Move "Development" page to "Development of FLTK" chapter
2023-01-21Move global FLTK options into new app fltk-admin (#560)Matthias Melcher
2022-12-27Exclude generated, Wayland specific files from Doxygen docsAlbrecht Schlosser
Some Wayland specific files are generated by the build process with configure + make in the source tree. These files are now ignored by the Doxygen documentation process.
2022-10-12Update Doxyfile.in for current Doxygen version 1.9.5Albrecht Schlosser
This file is now compatible up to Doxygen 1.9.5, i.e. there are no warnings about obsolete parameters when generating the docs. Current git 'master' of Doxygen (1.9.6: not yet released) issues some warnings but these will hopefully be fixed in Doxygen. Oldest tested Doxygen: 1.8.17 - older versions may emit warnings.
2022-08-12Improve automatic documentation generationAlbrecht Schlosser
This removes the need to edit the copyright year before generating the documentation (every year, in several files) and adds some technical information (doxygen generation date, doxygen version, and FLTK Git revision) in both HTML and PDF docs. - auto-generate copyright year (current year) used in several places - include FLTK Git revision in HTML and PDF docs - include generation date and doxygen version - replace special html footer which didn't work well with default footer
2022-01-17Comment out deprecated Doxygen tag COLS_IN_ALPHA_INDEX.ManoloFLTK
2021-12-08Documentation on widget coordinates and layout, plus new test programs (#304)engelsman
Add coordinates and layout section to user manual add section to user manual to clarify the use of window-relative coordinates in both Fl_Group and Fl_Window containers, and include brief descriptions of current layout manager widgets in one place. add test/coordinates.cxx, test/wizard.cxx and related screenshots under documentation/src. update CMakeLists.txt, Makefile and .gitignore for new files. Co-authored-by: Albrecht Schlosser <albrechts.fltk@online.de>
2020-09-18Fix doxygen warnings for newer doxygen versionsAlbrecht Schlosser
Paper type "a4wide" is no longer accepted (by doxygen or latex) for PDF generation, the other settings have been obsoleted by doxygen 1.8.16. Commented out for now to keep backwards compatibility with doxygen versions 1.8.15 and earlier.
2020-07-15CMake: refactor and reformat CMake filesAlbrecht Schlosser
- raise minimum CMake version from 2.6.3 to 3.2.3 (Jun 01, 2015) - indent all CMake files according to the CMP (2 col.) - refactor FLTK version number definitions and usage - unify CMake and autoconf/configure variable names: - FL_VERSION -> FLTK_VERSION - FL_MAJOR_VERSION -> FLTK_VERSION_MAJOR - etc. for _MINOR_ and _PATCH_, respectively - note: this does not affect FL_VERSION etc. in source code - generate "export headers" for all libraries (experimental: OFF) - port some forgotten goodies from branch-1.3 to master - merge and improve macro 'create_example' (WIP) - remove "temporary" options and code for older CMake versions - include and use 'GenerateExportHeader' (experimental, WIP: OFF) - note: created header files are not yet used - build only *one* DLL with Visual Studio (tested, works) - similar to the bundled IDE projects in 1.3.x - add some dynamically linked test/demo programs ('*-shared') if shared libraries are built (WIP) - split 'macros.cmake': use one file per macro
2020-07-13add resize documentation as per STR3433Duncan Gibson
add resize chapter to documentation, plus images, based on Article #415: How does resizing work? https://www.fltk.org/articles.php?L415 see also https://www.fltk.org/str.php?L3433
2020-01-08Drop 1.0 compatibility; document 1.4 migrationAlbrecht Schlosser
The FLTK 1.0 compatibility support by defining macro 'FLTK_1_0_COMPAT' did no longer work since FLTK 1.3.x and nobody complained. Hence we can safely remove this "feature". Documentation changes: - Drop chapter 'Migrating Code from FLTK 1.0 to 1.1' - Drop chapter 'Migrating Code from FLTK 1.1 to 1.3' - Add chapter 'Migrating Code from FLTK 1.3 to 1.4' The removed chapters are still available in FLTK 1.3 docs.
2018-12-29Add a CMake option to generate driver (developer) documentation.Albrecht Schlosser
Generating driver documentation can now be configured with CMake. The new configuration OPTION_INCLUDE_DRIVER_DOCUMENTATION is "marked as advanced" since only advanced users and/or FLTK developers need this. Previously this could only be achieved by editing documentation/Doxyfile.in. Added missing documentation option descriptions as well.
2018-06-23Doxygen: created Group to document drivers, disabled by defaultMatthias Melcher
Uncomment `ENABLED_SECTIONS += DriverDev` in documentation/Doxyfile.in to enable driver documentation. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12968 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-10CMake: enable building FLTK in a subdirectory of another project.Albrecht Schlosser
Basically replace CMAKE_XXX_DIR with CMAKE_CURRENT_XXX_DIR where XXX = SOURCE or BINARY. Patch proposal by cleanrock, FLTK PR #4: https://github.com/fltk/test-only/pull/4 Patch modified to fix target dirs for test programs and doxygen docs. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12630 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-12-03Remove Fl_Sys_Menu_Bar.mm from list of input filesManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12577 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-11-05Fix doxygen docs: missing excludes and CMake paths.Albrecht Schlosser
This commit fixes two issues: Doxygen build with CMake needs paths relative to CMake source dir. Missing excluded files taken from STR #3320, file #42 (by Manolo): http://www.fltk.org/strfiles/3320/scaling_rect_r12544.patch git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12545 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-10-17Added Fl_Simple_Terminal widget, and mods to test+example programs (STR #3411).Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12506 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-07-22Update list of files excluded from documentation.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12346 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-05-25Generate Doxygen docs with the highest possible ABI version.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11755 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-05-08Doxygen: put all driver classes in EXCLUDE_SYMBOLSManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11724 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-04-23Remove the src/drivers/ subtree from Doxygen indexing.Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11684 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-06-15Silence doxygen warnings - commented out obsolete statements.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10752 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-04-25[CMake] Add doxygen documentation generation (STR #3195).Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10720 ea41ed52-d2ee-0310-a9c1-e6b18d33e121