gre-ilya/fltk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation/PDF: always use the configured doxygen executable

Browse Source 
... to create the LaTeX header file used by doxygen.

This fix applies to both configure/make and CMake.

The existing version used `doxygen` which erroneously ran the doxygen
version from the current 'PATH' which might issue doxygen warnings and
potentially create a wrong LaTeX header file if the configured doxygen
program was not the one in the user's path.
This commit is contained in:
Albrecht Schlosser 2023-08-29 17:25:10 +02:00
parent ad5e49464b
commit be657471e7
3 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
documentation/CMakeLists.txt
View File

@ -188,6 +188,7 @@ if (OPTION_BUILD_PDF_DOCUMENTATION)
add_custom_command (
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/fltk.pdf
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/make_header
${DOXYGEN_EXECUTABLE}
${CMAKE_CURRENT_BINARY_DIR}/fltk-title.tex
${CMAKE_CURRENT_BINARY_DIR}/fltk-book.tex
COMMAND ${DOXYGEN_EXECUTABLE} Doxybook

2
documentation/Makefile
View File

@ -196,7 +196,7 @@ src/fltk-title.tex: src/fltk-title.tex.in
src/fltk-book.tex.in: src/fltk-title.tex
echo "Generating $@ ..."
./make_header $< $@
./make_header $(DOXYDOC) $< $@
src/fltk-book.tex: src/fltk-book.tex.in
echo "Generating $@ ..."

21
documentation/make_header
View File

@ -8,12 +8,16 @@
#
# Usage:
#
# $ sh make_header input-file output-file
# $ sh make_header doxygen_path input-file output-file
#
# where 'input-file' is the pure (LaTeX) title page (template)
# and 'output-file' is the generated (LaTeX) title page (template)
# to be used by `make' or `cmake` to generate the final LaTeX page
# header (combined doxygen template + FLTK title page).
# where
# - 'doxygen_path' is the full path to the doxygen executable
# or just 'doxygen'. If the full path is used an arbitrary
# doxygen executable and thus doxygen version can be used.
# - 'input-file' is the pure (LaTeX) title page (template)
# - 'output-file' is the generated (LaTeX) title page (template)
# that is used by `make' or `cmake` to generate the final LaTeX
# page header (combined doxygen template + FLTK title page).
#
#=======================================================================
# This script requires a posix shell and uses the following commands:
@ -21,8 +25,9 @@
#=======================================================================
# input and output file names
FLTK_HEAD="$1"
DOXY_HEAD="$2"
DOXY_CMD="$1"
FLTK_HEAD="$2"
DOXY_HEAD="$3"
# temp file
DOXY_TEMP="doxy-header.tex.$$"
@ -43,7 +48,7 @@ fi
# with our PDF document title page (LaTeX code) and write the
# result to $DOXY_HEAD.
doxygen -w latex $DOXY_TEMP /dev/null /dev/null
$DOXY_CMD -w latex $DOXY_TEMP /dev/null /dev/null
# combine three parts of these files to the output file
# using '( ... ) > $DOXY_HEAD' to write (concatenate)