Mirrors_UI_SDK/fltk
1
0
Fork 0
mirror of https://github.com/fltk/fltk.git synced 2025-12-09 20:11:12 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Enhance info about documentation generation

Browse Source 
- update build requirements
- clarify CMake options
- make clear that a POSIX shell and some Unix tools are required
  to build the PDF documentation
This commit is contained in:
Albrecht Schlosser
2023-10-03 09:19:36 +02:00
parent 4132590d8c
commit cfa1a3bd40
2 changed files with 78 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.CMake.txt
View File

@@ -226,20 +226,25 @@ Documentation options: these options are only available if `doxygen' is
OPTION_BUILD_HTML_DOCUMENTATION - default ON
OPTION_BUILD_PDF_DOCUMENTATION - default ON
These options can be used to switch HTML documentation generation with
doxygen on. The build targets ('html', 'pdf', or 'docs') need still to
be executed explicitly.
doxygen on. If these are ON the build targets 'html', 'pdf', and 'docs'
are generated but must be built explicitly. Technically the build targets
are generated but excluded from 'ALL'. You can safely leave these two
options ON if you want to save build time because the docs are not
built automatically.
OPTION_INCLUDE_DRIVER_DOCUMENTATION - default OFF
This option adds driver documentation to HTML and PDF docs (if ON). This
option is marked as "advanced" since it is only useful for FLTK developers
or advanced users.
and advanced users. It is only used if at least one of the documentation
options above is ON as well.
OPTION_INSTALL_HTML_DOCUMENTATION - default OFF
OPTION_INSTALL_PDF_DOCUMENTATION - default OFF
If these options are ON then the HTML and/or PDF docs get installed
If these options are ON then the HTML and/or PDF docs are installed
when the 'install' target is executed, e.g. with `make install'. You
need to select above options OPTION_BUILD_*_DOCUMENTATION as well.
2.3 Building under Linux with Unix Makefiles
-----------------------------------------------