diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2023-08-30 17:24:39 +0200 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2023-08-30 17:24:39 +0200 |
| commit | 3ff53dc2012feafd745bf230ad3ac7c28f5b91f9 (patch) | |
| tree | ef72676f58ef149f5e09d5ed4b2a89aa007044d8 /documentation/Makefile | |
| parent | 854b671cdc88259bcdd4210456d64a049b775eff (diff) | |
Improve doxygen documentation generation
Under configure+make it is not possible to enable driver documentation.
Therefore the '@DRIVER_DOCS@' variable must always be cleared.
Add a comment on how to build the driver docs using the Makefile.
Simplify CMake whitespace (trailing LF) handling.
Make sure we find the correct source dir even if FLTK is included
in a sub build (s/CMAKE_SOURCE_DIR/FLTK_SOURCE_DIR/).
Diffstat (limited to 'documentation/Makefile')
| -rw-r--r-- | documentation/Makefile | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 245dc2ee1..20f171c80 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -138,6 +138,15 @@ uninstall-linux uninstall-osx: # Both files are generated from the common source file Doxyfile.in. # Note that Doxyfile.in is shared with CMake to configure these files. +# Note: There's no way to enable the "Driver Documentation" via configure+make, +# please use CMake 'OPTION_INCLUDE_DRIVER_DOCUMENTATION' instead. +# Alternatively (if you really need it) edit this Makefile and +# replace the two lines below containing "@DRIVER_DOCS@" to read: +# -e's, @DRIVER_DOCS@, DriverDev,' \ +# (w/o leading '#') to enable the "Driver Documentation" section. +# Please take care of copying tabs and spaces literally. +# Note: There's no intention to enable this via configure option (use CMake). + Doxyfile: Doxyfile.in generated.dox copyright.dox echo "Generating Doxyfile ..." $(DOXYDOC) -u -s - < $< | \ @@ -145,6 +154,7 @@ Doxyfile: Doxyfile.in generated.dox copyright.dox -e's,@GENERATE_HTML@,YES,' \ -e's,@GENERATE_LATEX@,NO,' \ -e's, @LATEX_HEADER@,,' \ + -e's, @DRIVER_DOCS@,,' \ -e's,@CMAKE_CURRENT_SOURCE_DIR@,.,' \ -e's,@CMAKE_CURRENT_BINARY_DIR@,,' \ -e's,@FLTK_SOURCE_DIR@,..,' \ @@ -157,6 +167,7 @@ Doxybook: Doxyfile.in generated.dox copyright.dox -e's,@GENERATE_HTML@,NO,' \ -e's,@GENERATE_LATEX@,YES,' \ -e's,@LATEX_HEADER@,src/fltk-book.tex,' \ + -e's, @DRIVER_DOCS@,,' \ -e's,@CMAKE_CURRENT_SOURCE_DIR@,.,' \ -e's,@CMAKE_CURRENT_BINARY_DIR@,,' \ -e's,@FLTK_SOURCE_DIR@,..,' \ |