summaryrefslogtreecommitdiff
path: root/documentation/src/index.dox
AgeCommit message (Collapse)Author
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-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-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-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-02-16Update copyright year of documentationAlbrecht Schlosser
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>
2021-12-07Improve documentation index and chapter "Migrating Code ..."Albrecht Schlosser
- remove redundant "Revision 11" from documentation index page. - update index (missing refs and one wrong ref) - update page break - document header requirements and potential FLTK 1.3 code issues
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-07-06Remove $Id$ tags, update URL's, and moreAlbrecht Schlosser
- remove obsolete svn '$Id$' tags from all source files - update .fl files and generated files accordingly - replace 'http://www.fltk.org' URL's with 'https://...' - replace bug report URL 'str.php' with 'bugs.php' - remove trailing whitespace - fix other whitespace errors flagged by Git - add and/or fix missing or wrong standard headers - convert tabs to spaces in all source files The only relevant code changes are in the fluid/ folder where some .fl files and other source files were used to generate the '$Id' headers and footers.
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-08-07Update doxygen files to fix broken PDF generation.Albrecht Schlosser
Note: PDF generation "worked" with the previous configuration up to doxygen 1.8.6 on my "old" Ubuntu 14.04 system but did no longer work with doxygen 1.8.7 - 1.8.13 (the latter on Ubuntu 18.04). Tests showed that 1.8.14 is seriously broken and git:master (aka 1.8.15, but not yet released as of today) is not usable as well. Hopefully there will be some doxygen fixes in the future. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13010 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-18Fix a doxygen warning, update copyright.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12773 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-06-22Change copyright yearManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11792 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-01-30Bump version numbers for next minor release: FLTK 1.4.0.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11088 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-03-10[Version 1.3.4] Update version numbers - hopefully complete.Albrecht Schlosser
Note to devs: if I missed something, please mark follow-up commits with [Version 1.3.4] so we can find the necessary commits for version updates. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10612 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-10-05Bump version numbers to 1.3.3.Albrecht Schlosser
All fluid .fl files have been rewritten with fluid 1.3.3 and may differ somehow, but there are no significant changes. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10353 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-06-26Minor reformatting so documentation is correct also with Doxygen v 1.8Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9949 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-12-09Set to version 1.3.2Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9742 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-11-22Extended copyright date range to 2012.Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9730 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-11-06Upgrade version number to 1.3.1Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9707 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-10-25Introducing a FAQ to the FLTK docs.Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9146 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-05-11Fixed "Index" link on documentation pages.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8651 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-11Updated documentation copyright dates to 2011.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8261 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-08As per thread on fltk.development: "RFC: Docs - getting rid of .eps files"Greg Ercolano
Summary: Get rid of eps files, change all doxygen '\image latex' references to eps files to png/jpeg instead, convert doxygen images from gif -> png (to support html+latex). Actual operations: 1) svn remove *.eps 2) convert all gifs -> png 3) svn remove *.gif 4) svn add *.png 5) For jpeg/png images, change all \image latex foo.eps .. -> \image latex foo.[jpg,png] .. 6) For gif images, change all \image html foo.gif .. -> \image html foo.png and (harder to do): change \image latex foo.eps .. -> \image latex foo.png .. 7) Remove EPSFILES macro from documentation/Makefile and remove eps related dependencies that were added recently git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7981 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-27reworked color documentation as suggested in STR #2373engelsman
part of the confusion was the main page link to Common Widgets and Attributes/Colors actually went to Drawing Things in FLTK/Colors therefore making it harder to find information. Common Widgets and Attribute/Colors now simplified Drawing Things in FLTK/Colors now expanded FLTK Enumerations/Colors now simplified git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7762 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-03-23Copyright updates in docs.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7324 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-28updated document conventions for doxygen recognised entities,engelsman
removed links to class/function reference from index/preface git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6728 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-26converted page footer navigation bars to three-cell tables in all *.doxengelsman
also relaxed table widths in intro.dox to use 100% instead of 700 pixels to fit with doxygen header rule and new footer navigation bars git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6724 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25removed numbering from doxygen chapters and navigation bars,engelsman
moved class/function reference pages to end of index table, swapped editor/drawing chapters in Doxybook for PDF version git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21Reworked navigation links.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6704 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-16doxygen comments for fl_box(), fl_down(), fl_frame() and converted html tagsengelsman
FL/Enumerations.H: doxygen comments for fl_box(), fl_down(), fl_frame() documentation/src/common.dox: converted html tags to doxyge commands documentation/src/preface.dox: corrected footer link documentation/src/index.dox: corrected footer link git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6694 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-03Doxygen Documentation:Fabien Costantini
updated more copyright date info to 2009 in html and tex headers/footers git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6620 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Correct previous mod. of index.dox (function ref. was okay).Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6556 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Fixed broken (html) links on documentation index page.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6554 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-03Doxygen documentation:Fabien Costantini
- Fixed recent documentation update problems in fl_draw.cxx : \ and @ char must be doubled otherwise interpreted as doxygen keywords - Fixed some doxygenized parameters problems in Fl_Preferences.cxx - Added the treeview mode, now featuring a vertical left tree browser in html doc - Splitted html configuration file from pdf configuration file, now a new Doxybook config file permits to customize independtly both html and pdf modes without risking side effects and also without assuming an fltk user will have the Tex tools installed to generate the html doc. Now only pdf generation will need LaTex tools. - Updated the doxygen based documentation to revison 9 and added new significant contributors to index.dox in alphabetical order. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6539 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17now renaming restoring dir src_doc src.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6452 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17Removing current broken history documentation/src dir.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6451 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15Doxygen pdf documentation: Fixed missing dox files images in latex. Fixed ↵Fabien Costantini
license info would not show completely in pdf. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6438 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14Doxygen pdf man: First version added in documentation/fltk.pdf, old doc ↵Fabien Costantini
removed, images, dox files moved to a new src directory. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-10 10:53:23 +0000