Commit Graph

885 Commits

Author SHA1 Message Date
Albrecht Schlosser
16c9641797 Improve documentation index and chapter "Migrating Code ..."
- 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
2021-12-07 00:42:05 +01:00
Albrecht Schlosser
b2979b6425 Reformat to FLTK style, improve documentation
No code changes.

Replace '#define fl_clip ..' with an inline method.
2021-11-16 00:02:16 +01:00
Albrecht Schlosser
75240c9a32 Add new resize examples to demo menu, remove figure numbers
Adding only 2 of 3 new examples is intentional (9 per menu level).

Figure numbers have been removed in all the HTML docs recently for
better maintainability.
2021-11-08 16:19:48 +01:00
Duncan Gibson
7407d9c8d0 Add new resize example to test and dox (PR #165)
add example(s) showing Albrecht's innovative overlap resizable
technique to the "How does resizing work?" documentation and tests

See "resizable question" original discussion thread under:
https://www.fltk.org/newsgroups.php?gfltk.general+v:39635
2021-11-08 16:18:58 +01:00
Albrecht Schlosser
10da46a5a6 Improve documentation about library build folders and more
lib/README.txt: clarify where built libraries are located

documentation/src/basics.dox: clarify (C++) compiler command usage
  and improve documentation of the fltk-config script
2021-10-04 14:42:32 +02:00
Albrecht Schlosser
c3857517b0 Improve documentation chapter "Basics"
Add '-ldl' to example command line and other minor changes
2021-09-21 20:29:02 +02:00
Albrecht Schlosser
54213b95fe Doxygen docs: convert doxygen input file to current version
CMake only: "current" version means the doxygen version available
on the system where docs are generated.

Todo: do the same for autoconf/make builds.
2021-09-21 20:28:02 +02:00
Albrecht Schlosser
da4d16b59a Update fluid tutorial on CubeView and demo code
Format code according to the CMP, add instructions on how to copy
the code to the fluid tutorial, and update the tutorial with the
current code of test/CubeView.h and test/CubeView.cxx.
2021-05-21 20:08:12 +02:00
Albrecht Schlosser
6e70afc811 Update copyright year in documentation footer 2021-04-26 22:33:01 +02:00
Albrecht Schlosser
41b1f1f911 Improve documentation (test/editor) (#219)
Add missing declaration, update more declarations.
2021-04-14 21:42:04 +02:00
Albrecht Schlosser
bbaec9bd88 Update CMake and make files, minor edits only
There are no functional changes to be expected, mostly formatting
and comments.
2021-02-15 19:45:20 +01:00
Albrecht Schlosser
d7af409f42 Remove "Figure x.y: " from html image captions
... as discussed in fltk.coredev for easier maintenance.

Also edit some minor issues.
2021-01-13 22:52:33 +01:00
Albrecht Schlosser
3d53548cfb Documentation: enhance chapter "FLTK Basics"
basics.dox: Some minor edits, clarifications and reordering for
  better readability.

drawing.dox: minor edits, remove "Figure x.y:" etc. (to be continued)

enumerations.dox: change chapter title
2021-01-13 21:15:10 +01:00
Albrecht Schlosser
7ef23153df Update test/hello.cxx and related image
Improve CMP compatibility and use a better (anti-aliased) image for
the docs.
2021-01-13 15:12:26 +01:00
ManoloFLTK
018134161d Documentation: clarify how keypad keys are named. 2020-11-23 11:44:42 +01:00
Albrecht Schlosser
a03ab3b498 Clarify offscreen drawing documentation
... and rename drawing chapters (sections + subsections) according
to our documentation conventions (prefix "drawing_").

documentation/make_pdf: fix copyright year.
2020-11-08 15:43:34 +01:00
Albrecht Schlosser
b713b91975 PDF docs: generate LaTeX header file from source
The LaTeX header file used when creating PDF documentation depends on
the doxygen and latex versions, respectively.

The old header file 'documentation/src/fltk-book.tex.in' had been
generated manually and needed to be updated for new doxygen versions
which made the PDF documentation generation dependent on the
doxygen/latex versions on the build system.

The new LaTeX header file 'fltk-book.tex' is generated by doxygen,
i.e. taking into account the doxygen and latex versions on the build
system and "edited" to include the page title defined in the new
file 'documentation/src/fltk-title.tex.in'.

This makes the PDF documentation independent of the doxygen and
latex versions of the build system.
2020-09-21 14:32:46 +02:00
Albrecht Schlosser
f072cec13f Improve and clarify documentation 2020-09-21 13:45:46 +02:00
Albrecht Schlosser
1d21dc7a38 Fix doxygen warnings for newer doxygen versions
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-09-18 17:07:27 +02:00
Albrecht Schlosser
864a86b40f Fix doxygen warning
warning: Invalid section id `development_non'; ignoring section
2020-09-18 13:44:25 +02:00
Albrecht Schlosser
0c539b784d Fine tune GitLab-CI script
Also: update documentation copyright year.
2020-09-07 15:00:38 +02:00
Albrecht Schlosser
b65d3a249d Customize corner radius for rounded box/frame (#130)
Make maximum box corner radius and shadow width configurable.
See Fl::box_border_radius_max() and Fl::box_shadow_width().

Documentation: update image of box types.

Fixes #130
2020-09-01 12:35:48 +02:00
Albrecht Schlosser
a0638273c8 Documentation: update clock demo images
One of the images was cut off at the top or bottom.
Added window decoration with title, used a bright blue background.
2020-07-16 14:27:44 +02:00
Albrecht Schlosser
720b84ef9d CMake: refactor and reformat CMake files
- 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-15 00:34:53 +02:00
Albrecht Schlosser
58296c373a Fix old URL's and forum/newsgroup names
- fltk.development has been renamed to fltk.coredev
- all FLTK URL's are now of the form https://www.fltk.org/
2020-07-14 15:16:05 +02:00
Duncan Gibson
7038559338 add resize documentation as per STR3433
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-13 23:12:54 +02:00
Albrecht Schlosser
f09e17c3c5 Remove $Id$ tags, update URL's, and more
- 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-07-06 20:28:20 +02:00
Albrecht Schlosser
70ce08e0cb Improve fluid documentation
- remove trailing whitespace
- reformat for better readability
- fix typos
2020-05-08 12:31:26 +02:00
ManoloFLTK
d503f5d392 Fix small typo. 2020-04-05 10:04:24 +02:00
Albrecht Schlosser
09352ddab0 Update documentation, fix typos 2020-03-26 14:21:33 +01:00
ManoloFLTK
89449280dc Doc: more details about initialisation of display scale factors. 2020-03-26 06:29:25 +01:00
ManoloFLTK
812052e458 FLTK doc: Use Unicode character ⌘ (U+2318) in a macOS-specific context. 2020-03-09 13:21:52 +01:00
Albrecht Schlosser
c0b4fed619 Documentation: update cairo_test screenshot 2020-02-05 19:12:58 +01:00
Albrecht Schlosser
d2cb11369c Improve migration docs on Fl_Preferences 2020-01-26 15:11:40 +01:00
Albrecht Schlosser
30a868dc0f Improve Unicode / UTF-8 documentation 2020-01-26 15:10:53 +01:00
Albrecht Schlosser
f3724f7488 [CMake] Remove unnecessary dependency
Building the documentation need not depend on building the library.
This change can speed up changing, building, and viewing modified
docs.
2020-01-26 15:07:15 +01:00
Albrecht Schlosser
3f1f871585 Drop 1.0 compatibility; document 1.4 migration
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.
2020-01-08 18:41:50 +01:00
ManoloFLTK
ffcf8bd0b7 Documentation: make clear that "Using OpenGL in Normal FLTK Windows" isn't useful with macOS. 2019-10-27 08:37:33 +01:00
Albrecht Schlosser
bce85d9511 CMake: copy 'tiny.png' to doc folder
The image 'tiny.png' was not copied to the documentation/html
directory when docs were built with CMake.
2019-09-16 17:17:54 +02:00
Greg Ercolano
9e4c207e27 Added example images for Fl_[Hold/Multi]_Browser 2019-07-26 13:32:18 -07:00
Greg Ercolano
bca3ae0b17 Added example for mac Application -> Preferences 2019-06-06 11:09:29 -07:00
Albrecht Schlosser
31093d0a14 Replace fl_ask() with fl_choice() in FAQ
fl_ask() is deprecated and should be replaced with fl_choice().
2019-05-15 18:02:01 +02:00
Albrecht Schlosser
c4a755bdf8 Fix some links in documentation
Particularly to Doxygen docs and NEdit which appears to have moved
to sourceforge (according to Wikipedia), see
https://en.wikipedia.org/wiki/NEdit

Note: nedit.org exists but shows some non-English text.
2019-05-15 17:16:11 +02:00
ManoloFLTK
0f6cbd1cda Doxygen: rewording for more clarity. 2019-04-14 09:27:41 +02:00
ManoloFLTK
f55729ed32 Doxygen: describe better support for OpenGL on HighDPI displays. 2019-04-12 18:47:42 +02:00
ManoloFLTK
63b86bd8f7 Revert back to previous state 2019-04-04 18:51:16 +02:00
ManoloFLTK
9b7f020ed3 Update procedure for OpenGL3 support. 2019-04-04 18:42:45 +02:00
ManoloFLTK
099b16d69d Document new and modified configure options. 2019-02-11 16:18:14 +01:00
Albrecht Schlosser
79af685c28 Fix typos 2019-02-09 21:21:48 +01:00
Matthias Melcher
b663ce85e0 Improved decumentation for '@' symbols in labels (STR #2940). 2019-02-04 23:32:37 +01:00