Reorganize documentation source directories
- 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)
42
.gitignore
vendored
@ -4,54 +4,36 @@
|
|||||||
|
|
||||||
# Ignore everywhere, also in subdirectories
|
# Ignore everywhere, also in subdirectories
|
||||||
|
|
||||||
|
*.bak
|
||||||
*.bck
|
*.bck
|
||||||
*.exe
|
*.exe
|
||||||
|
*.log
|
||||||
*.o
|
*.o
|
||||||
**/.DS_Store
|
**/.DS_Store
|
||||||
|
|
||||||
# CMake build artifacts if built in source - strongly discouraged!
|
# CMake build artifacts if built in source - forbidden since FLTK 1.5.0.
|
||||||
# We may disallow this later...
|
# However, the following artifacts would be created by an attempt to
|
||||||
|
# execute `cmake` in-source:
|
||||||
|
|
||||||
bin/
|
|
||||||
**/cmake_install.cmake
|
|
||||||
**/CMakeCache.txt
|
**/CMakeCache.txt
|
||||||
**/CMakeFiles/
|
**/CMakeFiles/
|
||||||
cmake_uninstall.cmake
|
|
||||||
FLTK.sln
|
|
||||||
FLTK-Targets.cmake
|
|
||||||
FLTKConfig.cmake
|
|
||||||
etc/FLTKConfig.cmake
|
|
||||||
/CMakeSettings.json
|
|
||||||
/CppProperties.json
|
|
||||||
|
|
||||||
# Visual Studio (MSVC) build artifacts
|
# VS Code (Visual Studio Code) Editor is a user generated folder
|
||||||
|
# that must not be committed
|
||||||
*.tlog
|
|
||||||
.vs/
|
|
||||||
/out
|
|
||||||
|
|
||||||
# VS Code (Visual Studio Code) Editor
|
|
||||||
|
|
||||||
.vscode/
|
.vscode/
|
||||||
|
|
||||||
# /
|
# default build folder `build` and more ...
|
||||||
|
|
||||||
/build
|
/build
|
||||||
/fltk-config
|
|
||||||
/fltk.list
|
|
||||||
/fltk.spec
|
|
||||||
/TAGS
|
/TAGS
|
||||||
|
|
||||||
# /FL
|
# /FL - this should not happen, but anyway ...
|
||||||
|
|
||||||
/FL/fl_config.h
|
/FL/fl_config.h
|
||||||
|
|
||||||
# /lib/
|
# executables manually built in /misc/
|
||||||
|
# todo: maybe move the source files to folder /util/ ?
|
||||||
/lib/lib*
|
|
||||||
/lib/*.lib
|
|
||||||
/lib/*.a
|
|
||||||
|
|
||||||
# /misc/
|
|
||||||
|
|
||||||
/misc/doxystar
|
/misc/doxystar
|
||||||
|
/misc/fromdos
|
||||||
|
|||||||
@ -28,7 +28,7 @@
|
|||||||
all FLTK widgets. It contains only static methods.
|
all FLTK widgets. It contains only static methods.
|
||||||
|
|
||||||
\image html tooltip-options.png "Fl_Tooltip Options"
|
\image html tooltip-options.png "Fl_Tooltip Options"
|
||||||
\image latex src/tooltip-options.png "Fl_Tooltip Options" width=6cm
|
\image latex tooltip-options.png "Fl_Tooltip Options" width=10cm
|
||||||
|
|
||||||
*/
|
*/
|
||||||
class FL_EXPORT Fl_Tooltip {
|
class FL_EXPORT Fl_Tooltip {
|
||||||
|
|||||||
40
documentation/.gitignore
vendored
@ -1,45 +1,11 @@
|
|||||||
#
|
#
|
||||||
# Files to be ignored by Git (do not commit)
|
# Files to be ignored by Git (do not commit)
|
||||||
#
|
#
|
||||||
|
# Note: since FLTK 1.5 building FLTK in-source is no longer allowed.
|
||||||
|
# Therefore we don't need to "ignore" generated files anymore
|
||||||
|
# because generated files are stored in the build tree.
|
||||||
|
|
||||||
# /documentation/
|
# /documentation/
|
||||||
.xvpics
|
|
||||||
blocks.0
|
|
||||||
blocks.6
|
|
||||||
blocks.z
|
|
||||||
checkers.0
|
|
||||||
checkers.6
|
|
||||||
checkers.z
|
|
||||||
copyright.dox
|
|
||||||
Doxybook
|
|
||||||
Doxyfile
|
|
||||||
fltk.0
|
|
||||||
fltk.3
|
|
||||||
fltk-config.0
|
|
||||||
fltk-config.1
|
|
||||||
fltk-config.z
|
|
||||||
fltk.d
|
|
||||||
fltk.pdf
|
|
||||||
fltk.z
|
|
||||||
fluid.0
|
|
||||||
fluid.1
|
|
||||||
fluid.z
|
|
||||||
generated.dox
|
|
||||||
html
|
|
||||||
latex
|
|
||||||
sudoku.0
|
|
||||||
sudoku.6
|
|
||||||
sudoku.z
|
|
||||||
*.bck
|
*.bck
|
||||||
*.bak
|
*.bak
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
# /documentation/src/
|
|
||||||
src/*.0
|
|
||||||
src/*.1
|
|
||||||
src/*.3
|
|
||||||
src/*.6
|
|
||||||
src/*.z
|
|
||||||
src/fltk-book.tex
|
|
||||||
src/fltk-book.tex.in
|
|
||||||
src/fltk-title.tex
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
#
|
#
|
||||||
# CMakeLists.txt to build docs for the FLTK project using CMake (www.cmake.org)
|
# CMakeLists.txt to build docs for the FLTK project using CMake (www.cmake.org)
|
||||||
#
|
#
|
||||||
# Copyright 1998-2024 by Bill Spitzak and others.
|
# Copyright 1998-2025 by Bill Spitzak and others.
|
||||||
#
|
#
|
||||||
# This library is free software. Distribution and use rights are outlined in
|
# This library is free software. Distribution and use rights are outlined in
|
||||||
# the file "COPYING" which should have been included with this file. If this
|
# the file "COPYING" which should have been included with this file. If this
|
||||||
@ -191,7 +191,7 @@ if(FLTK_BUILD_PDF_DOCS)
|
|||||||
# generate LaTeX title fltk-title.tex and make_pdf script
|
# generate LaTeX title fltk-title.tex and make_pdf script
|
||||||
|
|
||||||
configure_file(
|
configure_file(
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/src/fltk-title.tex.in
|
${CMAKE_CURRENT_SOURCE_DIR}/fltk-title.tex.in
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/fltk-title.tex
|
${CMAKE_CURRENT_BINARY_DIR}/fltk-title.tex
|
||||||
@ONLY
|
@ONLY
|
||||||
)
|
)
|
||||||
@ -209,7 +209,7 @@ if(FLTK_BUILD_PDF_DOCS)
|
|||||||
set(_deps)
|
set(_deps)
|
||||||
set(image_input_sources
|
set(image_input_sources
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/src/unicode.dox
|
${CMAKE_CURRENT_SOURCE_DIR}/src/unicode.dox
|
||||||
# ${CMAKE_CURRENT_SOURCE_DIR}/src/cmp.dox
|
# ${CMAKE_CURRENT_SOURCE_DIR}/src/cmp.dox # more documentation files
|
||||||
# ${FLTK_SOURCE_DIR}/src/Fl.cxx # example source file
|
# ${FLTK_SOURCE_DIR}/src/Fl.cxx # example source file
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@ -921,7 +921,7 @@ EXAMPLE_RECURSIVE = NO
|
|||||||
# that contain images that are to be included in the documentation (see the
|
# that contain images that are to be included in the documentation (see the
|
||||||
# \image command).
|
# \image command).
|
||||||
|
|
||||||
IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/src \
|
IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images \
|
||||||
@CMAKE_CURRENT_BINARY_DIR@/generated
|
@CMAKE_CURRENT_BINARY_DIR@/generated
|
||||||
|
|
||||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 5.5 KiB |
|
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
|
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 457 B After Width: | Height: | Size: 457 B |
|
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
|
Before Width: | Height: | Size: 401 KiB After Width: | Height: | Size: 401 KiB |
|
Before Width: | Height: | Size: 517 B After Width: | Height: | Size: 517 B |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 526 B After Width: | Height: | Size: 526 B |
|
Before Width: | Height: | Size: 5.6 KiB After Width: | Height: | Size: 5.6 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 8.3 KiB After Width: | Height: | Size: 8.3 KiB |
|
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 63 KiB |
|
Before Width: | Height: | Size: 540 B After Width: | Height: | Size: 540 B |
|
Before Width: | Height: | Size: 573 B After Width: | Height: | Size: 573 B |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 6.5 KiB |
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 2.1 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 9.2 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
|
Before Width: | Height: | Size: 908 B After Width: | Height: | Size: 908 B |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 877 B After Width: | Height: | Size: 877 B |
|
Before Width: | Height: | Size: 8.6 KiB After Width: | Height: | Size: 8.6 KiB |
|
Before Width: | Height: | Size: 193 KiB After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 5.2 KiB |
|
Before Width: | Height: | Size: 860 B After Width: | Height: | Size: 860 B |
|
Before Width: | Height: | Size: 879 B After Width: | Height: | Size: 879 B |
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
|
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
|
Before Width: | Height: | Size: 7.5 KiB After Width: | Height: | Size: 7.5 KiB |
|
Before Width: | Height: | Size: 661 B After Width: | Height: | Size: 661 B |
|
Before Width: | Height: | Size: 6.6 KiB After Width: | Height: | Size: 6.6 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 1011 B After Width: | Height: | Size: 1011 B |
|
Before Width: | Height: | Size: 683 B After Width: | Height: | Size: 683 B |
|
Before Width: | Height: | Size: 901 B After Width: | Height: | Size: 901 B |
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 156 KiB After Width: | Height: | Size: 156 KiB |
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 4.1 KiB After Width: | Height: | Size: 4.1 KiB |
|
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 920 B After Width: | Height: | Size: 920 B |
|
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 1005 B After Width: | Height: | Size: 1005 B |
|
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 9.2 KiB |
|
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 9.1 KiB |
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 6.3 KiB After Width: | Height: | Size: 6.3 KiB |
|
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 2.9 KiB After Width: | Height: | Size: 2.9 KiB |
|
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 2.6 KiB |
|
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
|
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 2.6 KiB |
|
Before Width: | Height: | Size: 647 B After Width: | Height: | Size: 647 B |
|
Before Width: | Height: | Size: 809 B After Width: | Height: | Size: 809 B |
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 4.7 KiB After Width: | Height: | Size: 4.7 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
|
Before Width: | Height: | Size: 9.4 KiB After Width: | Height: | Size: 9.4 KiB |
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
|
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |