From 1669be2e3899ef77a01b668d3848e9993a2575d3 Mon Sep 17 00:00:00 2001 From: Matthias Melcher Date: Tue, 17 Oct 2023 14:30:12 +0200 Subject: [PATCH] Making FLUID docs work with Makefiles on Linux and macOS --- Makefile | 2 +- documentation/Makefile | 6 +- fluid/core-docs/Doxyfile.in | 3 +- fluid/core-docs/Makefile | 133 +++++++----------------------------- fluid/user-docs/Doxyfile.in | 3 +- fluid/user-docs/Makefile | 132 +++++++---------------------------- 6 files changed, 56 insertions(+), 223 deletions(-) diff --git a/Makefile b/Makefile index c02de0972c..309743228f 100644 --- a/Makefile +++ b/Makefile @@ -17,7 +17,7 @@ include makeinclude DIRS = $(IMAGEDIRS) $(LIBDECORDIR) src $(CAIRODIR) $(FLUIDDIR) fltk-options test \ - documentation + documentation $(FLUIDDIR)/user-docs $(FLUIDDIR)/core-docs all: makeinclude fltk-config for dir in $(DIRS); do\ diff --git a/documentation/Makefile b/documentation/Makefile index c75dd567c7..6406aef012 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -1,7 +1,7 @@ # # Makefile for the Fast Light Tool Kit (FLTK) documentation. # -# Copyright 1998-2022 by Bill Spitzak and others. +# Copyright 1998-2023 by Bill Spitzak and others. # # 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 @@ -158,7 +158,7 @@ Doxyfile: Doxyfile.in generated.dox copyright.dox -e's,@CMAKE_CURRENT_SOURCE_DIR@,.,' \ -e's,@CMAKE_CURRENT_BINARY_DIR@,,' \ -e's,@FLTK_SOURCE_DIR@,..,' \ - -i $@ + -i.bak $@ Doxybook: Doxyfile.in generated.dox copyright.dox echo "Generating Doxybook ..." @@ -172,7 +172,7 @@ Doxybook: Doxyfile.in generated.dox copyright.dox -e's,@CMAKE_CURRENT_SOURCE_DIR@,.,' \ -e's,@CMAKE_CURRENT_BINARY_DIR@,,' \ -e's,@FLTK_SOURCE_DIR@,..,' \ - -i $@ + -i.bak $@ # The HTML files are generated using doxygen, and this needs # an installed doxygen version and may take some time, so this target diff --git a/fluid/core-docs/Doxyfile.in b/fluid/core-docs/Doxyfile.in index ec660146a4..18c4759f7b 100644 --- a/fluid/core-docs/Doxyfile.in +++ b/fluid/core-docs/Doxyfile.in @@ -860,7 +860,8 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = @CMAKE_CURRENT_BINARY_DIR@ +EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@ \ + @CMAKE_CURRENT_BINARY_DIR@ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/fluid/core-docs/Makefile b/fluid/core-docs/Makefile index c75dd567c7..322e147d70 100644 --- a/fluid/core-docs/Makefile +++ b/fluid/core-docs/Makefile @@ -1,7 +1,7 @@ # -# Makefile for the Fast Light Tool Kit (FLTK) documentation. +# Makefile for the Fast Light Tool Kit (FLTK) FLUID core documentation. # -# Copyright 1998-2022 by Bill Spitzak and others. +# Copyright 1998-2023 by Bill Spitzak and others. # # 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 @@ -15,69 +15,40 @@ # # Get configuration stuff... -include ../makeinclude +include ../../makeinclude # make sure that all docs are (re-)created independent of missing deps -.PHONY: pdf html refman.pdf +.PHONY: fluid-core-pdf fluid-core-html refman.pdf SRC_DOCDIR = ./src # These are the HTML "source" files... HTMLFILES = \ - $(SRC_DOCDIR)/index.dox \ - $(SRC_DOCDIR)/preface.dox \ - $(SRC_DOCDIR)/intro.dox \ - $(SRC_DOCDIR)/basics.dox \ - $(SRC_DOCDIR)/common.dox \ - $(SRC_DOCDIR)/coordinates.dox \ - $(SRC_DOCDIR)/resize.dox \ - $(SRC_DOCDIR)/editor.dox \ - $(SRC_DOCDIR)/drawing.dox \ - $(SRC_DOCDIR)/events.dox \ - $(SRC_DOCDIR)/subclassing.dox \ - $(SRC_DOCDIR)/opengl.dox \ - $(SRC_DOCDIR)/fluid.dox \ - $(SRC_DOCDIR)/fltk-options.dox \ - $(SRC_DOCDIR)/advanced.dox \ - $(SRC_DOCDIR)/unicode.dox \ - $(SRC_DOCDIR)/enumerations.dox \ - $(SRC_DOCDIR)/glut.dox \ - $(SRC_DOCDIR)/forms.dox \ - $(SRC_DOCDIR)/osissues.dox \ - $(SRC_DOCDIR)/migration_1_4.dox \ - $(SRC_DOCDIR)/development.dox \ - $(SRC_DOCDIR)/license.dox \ - $(SRC_DOCDIR)/examples.dox \ - $(SRC_DOCDIR)/faq.dox - -MANPAGES = $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) \ - $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(SRC_DOCDIR)/blocks.$(CAT6EXT) \ - $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) \ - $(SRC_DOCDIR)/fltk-options.$(CAT1EXT) - -all: $(MANPAGES) + $(SRC_DOCDIR)/index.dox + +all: # Use `make docs' to create all docs for distribution files. # You need installed versions of Doxygen and LaTeX for this. -docs: all html pdf +docs: all fluid-core-html fluid-core-pdf # Synonyms for docs: -alldocs: docs -dist: docs +alldocs: fluid-core-docs +dist: fluid-core-docs clean: $(RM) Doxyfile Doxybook $(RM) copyright.dox generated.dox - $(RM) fltk.pdf refman.pdf src/fltk-title.tex src/fltk-book.tex.in src/fltk-book.tex + $(RM) fluid-core.pdf refman.pdf src/fluid-core-title.tex src/fluid-core-book.tex.in src/fluid-core-book.tex $(RMDIR) html latex $(RM) *~ *.bck *.bak *.log $(RM) $(MANPAGES) $(SRC_DOCDIR)/*.0 depend: -install: $(MANPAGES) +install: echo "Installing documentation files in $(DESTDIR)$(docdir) ..." -$(INSTALL_DIR) $(DESTDIR)$(docdir) if test -f html/index.html ; then \ @@ -87,65 +58,11 @@ install: $(MANPAGES) fi if test -f fltk.pdf ; then \ echo "Installing fltk.pdf in $(DESTDIR)$(docdir) ..."; \ - $(INSTALL_DATA) fltk.pdf $(DESTDIR)$(docdir); \ + $(INSTALL_DATA) fluid-core.pdf $(DESTDIR)$(docdir); \ fi - echo "Installing man pages in $(DESTDIR)$(mandir) ..." - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-options.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat3 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(DESTDIR)$(mandir)/cat3 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fluid.man $(DESTDIR)$(mandir)/man1/fluid.1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-config.man $(DESTDIR)$(mandir)/man1/fltk-config.1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-options.man $(DESTDIR)$(mandir)/man1/fltk-options.1 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man3 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk.man $(DESTDIR)$(mandir)/man3/fltk.3 - -install-linux install-osx: - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat6 - $(INSTALL_MAN) $(SRC_DOCDIR)/blocks.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6 - $(INSTALL_MAN) $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6 - $(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man6 - $(INSTALL_MAN) $(SRC_DOCDIR)/blocks.man $(DESTDIR)$(mandir)/man6/blocks.6 - $(INSTALL_MAN) $(SRC_DOCDIR)/checkers.man $(DESTDIR)$(mandir)/man6/checkers.6 - $(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.man $(DESTDIR)$(mandir)/man6/sudoku.6 - uninstall: $(RMDIR) $(DESTDIR)$(docdir) - $(RM) $(DESTDIR)$(mandir)/cat1/fluid.$(CAT1EXT) - $(RM) $(DESTDIR)$(mandir)/man1/fluid.1 - $(RM) $(DESTDIR)$(mandir)/cat1/fltk-config.$(CAT1EXT) - $(RM) $(DESTDIR)$(mandir)/man1/fltk-config.1 - $(RM) $(DESTDIR)$(mandir)/cat1/fltk-options.$(CAT1EXT) - $(RM) $(DESTDIR)$(mandir)/man1/fltk-options.1 - $(RM) $(DESTDIR)$(mandir)/cat3/fltk.$(CAT3EXT) - $(RM) $(DESTDIR)$(mandir)/man3/fltk.3 - -uninstall-linux uninstall-osx: - $(RM) $(DESTDIR)$(mandir)/cat6/blocks.$(CAT6EXT) - $(RM) $(DESTDIR)$(mandir)/cat6/checkers.$(CAT6EXT) - $(RM) $(DESTDIR)$(mandir)/cat6/sudoku.$(CAT6EXT) - $(RM) $(DESTDIR)$(mandir)/man6/blocks.6 - $(RM) $(DESTDIR)$(mandir)/man6/checkers.6 - $(RM) $(DESTDIR)$(mandir)/man6/sudoku.6 - -# The documentation is generated using doxygen. There are two control files -# for doxygen: Doxyfile for html documentation and Doxybook for pdf docs. -# 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 ..." @@ -154,11 +71,10 @@ 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@,..,' \ - -i $@ + -i.bak $@ Doxybook: Doxyfile.in generated.dox copyright.dox echo "Generating Doxybook ..." @@ -168,19 +84,18 @@ 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@,..,' \ - -i $@ + -i.bak $@ # The HTML files are generated using doxygen, and this needs # an installed doxygen version and may take some time, so this target # is not made by default. # Use `make html' or `make docs' to create the html docs. -html: $(HTMLFILES) Doxyfile - echo "Generating HTML documentation..." +fluid-core-html: $(HTMLFILES) Doxyfile + echo "Generating HTML FLUID core documentation..." -$(RMDIR) html -$(INSTALL_DIR) html -$(DOXYDOC) @@ -188,31 +103,31 @@ html: $(HTMLFILES) Doxyfile echo "Sorry - doxygen not found. Please install doxygen and run configure."; \ fi -# The PDF documentation (fltk.pdf) is generated using doxygen and LaTeX, and +# The PDF documentation (fluid-core.pdf) is generated using doxygen and LaTeX, and # this needs installed Doxygen and LaTeX programs and may take some time, so # this target is not made by default. # Use `make pdf' or `make docs' to create the PDF docs. -pdf: refman.pdf - cp -f latex/refman.pdf fltk.pdf +fluid-core-pdf: refman.pdf + cp -f latex/refman.pdf fluid-core.pdf -refman.pdf: $(HTMLFILES) Doxybook src/fltk-book.tex +refman.pdf: $(HTMLFILES) Doxybook src/fluid-core-book.tex -$(RMDIR) latex echo "Generating PDF documentation ..." $(DOXYDOC) Doxybook ./make_pdf -src/fltk-title.tex: src/fltk-title.tex.in +src/fluid-core-title.tex: src/fluid-core-title.tex.in echo "Generating $@ ..." GIT_REVISION=`git rev-parse --short=10 HEAD`; \ sed -e"s/@GIT_REVISION@/$$GIT_REVISION/g" \ < $< > $@ -src/fltk-book.tex.in: src/fltk-title.tex +src/fluid-core-book.tex.in: src/fluid-core-title.tex echo "Generating $@ ..." ./make_header $(DOXYDOC) $< $@ -src/fltk-book.tex: src/fltk-book.tex.in +src/fluid-core-book.tex: src/fluid-core-book.tex.in echo "Generating $@ ..." DOXY_VERSION=`$(DOXYDOC) --version|cut -f1 -d' '`; \ YEAR=`date +%Y`; \ diff --git a/fluid/user-docs/Doxyfile.in b/fluid/user-docs/Doxyfile.in index baa8dcbff6..a23981be06 100644 --- a/fluid/user-docs/Doxyfile.in +++ b/fluid/user-docs/Doxyfile.in @@ -858,7 +858,8 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = @CMAKE_CURRENT_BINARY_DIR@ +EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@ \ + @CMAKE_CURRENT_BINARY_DIR@ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/fluid/user-docs/Makefile b/fluid/user-docs/Makefile index c75dd567c7..5462f38bfe 100644 --- a/fluid/user-docs/Makefile +++ b/fluid/user-docs/Makefile @@ -1,7 +1,7 @@ # -# Makefile for the Fast Light Tool Kit (FLTK) documentation. +# Makefile for the Fast Light Tool Kit (FLTK) FLUID user documentation. # -# Copyright 1998-2022 by Bill Spitzak and others. +# Copyright 1998-2023 by Bill Spitzak and others. # # 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 @@ -15,69 +15,41 @@ # # Get configuration stuff... -include ../makeinclude +include ../../makeinclude # make sure that all docs are (re-)created independent of missing deps -.PHONY: pdf html refman.pdf +.PHONY: fluid-user-pdf fluid-user-html refman.pdf SRC_DOCDIR = ./src # These are the HTML "source" files... HTMLFILES = \ $(SRC_DOCDIR)/index.dox \ - $(SRC_DOCDIR)/preface.dox \ - $(SRC_DOCDIR)/intro.dox \ - $(SRC_DOCDIR)/basics.dox \ - $(SRC_DOCDIR)/common.dox \ - $(SRC_DOCDIR)/coordinates.dox \ - $(SRC_DOCDIR)/resize.dox \ - $(SRC_DOCDIR)/editor.dox \ - $(SRC_DOCDIR)/drawing.dox \ - $(SRC_DOCDIR)/events.dox \ - $(SRC_DOCDIR)/subclassing.dox \ - $(SRC_DOCDIR)/opengl.dox \ - $(SRC_DOCDIR)/fluid.dox \ - $(SRC_DOCDIR)/fltk-options.dox \ - $(SRC_DOCDIR)/advanced.dox \ - $(SRC_DOCDIR)/unicode.dox \ - $(SRC_DOCDIR)/enumerations.dox \ - $(SRC_DOCDIR)/glut.dox \ - $(SRC_DOCDIR)/forms.dox \ - $(SRC_DOCDIR)/osissues.dox \ - $(SRC_DOCDIR)/migration_1_4.dox \ - $(SRC_DOCDIR)/development.dox \ - $(SRC_DOCDIR)/license.dox \ - $(SRC_DOCDIR)/examples.dox \ - $(SRC_DOCDIR)/faq.dox - -MANPAGES = $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) \ - $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(SRC_DOCDIR)/blocks.$(CAT6EXT) \ - $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) \ - $(SRC_DOCDIR)/fltk-options.$(CAT1EXT) - -all: $(MANPAGES) + $(SRC_DOCDIR)/fluid.dox + +all: # Use `make docs' to create all docs for distribution files. # You need installed versions of Doxygen and LaTeX for this. -docs: all html pdf +docs: all fluid-user-html fluid-user-pdf # Synonyms for docs: -alldocs: docs -dist: docs +alldocs: fluid-user-docs +dist: fluid-user-docs clean: $(RM) Doxyfile Doxybook $(RM) copyright.dox generated.dox - $(RM) fltk.pdf refman.pdf src/fltk-title.tex src/fltk-book.tex.in src/fltk-book.tex + $(RM) fluid-user.pdf refman.pdf src/fluid-user-title.tex src/fluid-user-book.tex.in src/fluid-user-book.tex $(RMDIR) html latex $(RM) *~ *.bck *.bak *.log $(RM) $(MANPAGES) $(SRC_DOCDIR)/*.0 depend: -install: $(MANPAGES) +install: echo "Installing documentation files in $(DESTDIR)$(docdir) ..." -$(INSTALL_DIR) $(DESTDIR)$(docdir) if test -f html/index.html ; then \ @@ -87,65 +59,11 @@ install: $(MANPAGES) fi if test -f fltk.pdf ; then \ echo "Installing fltk.pdf in $(DESTDIR)$(docdir) ..."; \ - $(INSTALL_DATA) fltk.pdf $(DESTDIR)$(docdir); \ + $(INSTALL_DATA) fluid-user.pdf $(DESTDIR)$(docdir); \ fi - echo "Installing man pages in $(DESTDIR)$(mandir) ..." - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-options.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat3 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(DESTDIR)$(mandir)/cat3 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fluid.man $(DESTDIR)$(mandir)/man1/fluid.1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-config.man $(DESTDIR)$(mandir)/man1/fltk-config.1 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk-options.man $(DESTDIR)$(mandir)/man1/fltk-options.1 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man3 - $(INSTALL_MAN) $(SRC_DOCDIR)/fltk.man $(DESTDIR)$(mandir)/man3/fltk.3 - -install-linux install-osx: - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat6 - $(INSTALL_MAN) $(SRC_DOCDIR)/blocks.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6 - $(INSTALL_MAN) $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6 - $(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6 - -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man6 - $(INSTALL_MAN) $(SRC_DOCDIR)/blocks.man $(DESTDIR)$(mandir)/man6/blocks.6 - $(INSTALL_MAN) $(SRC_DOCDIR)/checkers.man $(DESTDIR)$(mandir)/man6/checkers.6 - $(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.man $(DESTDIR)$(mandir)/man6/sudoku.6 - uninstall: $(RMDIR) $(DESTDIR)$(docdir) - $(RM) $(DESTDIR)$(mandir)/cat1/fluid.$(CAT1EXT) - $(RM) $(DESTDIR)$(mandir)/man1/fluid.1 - $(RM) $(DESTDIR)$(mandir)/cat1/fltk-config.$(CAT1EXT) - $(RM) $(DESTDIR)$(mandir)/man1/fltk-config.1 - $(RM) $(DESTDIR)$(mandir)/cat1/fltk-options.$(CAT1EXT) - $(RM) $(DESTDIR)$(mandir)/man1/fltk-options.1 - $(RM) $(DESTDIR)$(mandir)/cat3/fltk.$(CAT3EXT) - $(RM) $(DESTDIR)$(mandir)/man3/fltk.3 - -uninstall-linux uninstall-osx: - $(RM) $(DESTDIR)$(mandir)/cat6/blocks.$(CAT6EXT) - $(RM) $(DESTDIR)$(mandir)/cat6/checkers.$(CAT6EXT) - $(RM) $(DESTDIR)$(mandir)/cat6/sudoku.$(CAT6EXT) - $(RM) $(DESTDIR)$(mandir)/man6/blocks.6 - $(RM) $(DESTDIR)$(mandir)/man6/checkers.6 - $(RM) $(DESTDIR)$(mandir)/man6/sudoku.6 - -# The documentation is generated using doxygen. There are two control files -# for doxygen: Doxyfile for html documentation and Doxybook for pdf docs. -# 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 ..." @@ -154,11 +72,10 @@ 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@,..,' \ - -i $@ + -i.bak $@ Doxybook: Doxyfile.in generated.dox copyright.dox echo "Generating Doxybook ..." @@ -168,19 +85,18 @@ 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@,..,' \ - -i $@ + -i.bak $@ # The HTML files are generated using doxygen, and this needs # an installed doxygen version and may take some time, so this target # is not made by default. # Use `make html' or `make docs' to create the html docs. -html: $(HTMLFILES) Doxyfile - echo "Generating HTML documentation..." +fluid-user-html: $(HTMLFILES) Doxyfile + echo "Generating HTML FLUID user documentation..." -$(RMDIR) html -$(INSTALL_DIR) html -$(DOXYDOC) @@ -188,31 +104,31 @@ html: $(HTMLFILES) Doxyfile echo "Sorry - doxygen not found. Please install doxygen and run configure."; \ fi -# The PDF documentation (fltk.pdf) is generated using doxygen and LaTeX, and +# The PDF documentation (fluid-user.pdf) is generated using doxygen and LaTeX, and # this needs installed Doxygen and LaTeX programs and may take some time, so # this target is not made by default. # Use `make pdf' or `make docs' to create the PDF docs. -pdf: refman.pdf - cp -f latex/refman.pdf fltk.pdf +fluid-user-pdf: refman.pdf + cp -f latex/refman.pdf fluid-user.pdf -refman.pdf: $(HTMLFILES) Doxybook src/fltk-book.tex +refman.pdf: $(HTMLFILES) Doxybook src/fluid-user-book.tex -$(RMDIR) latex echo "Generating PDF documentation ..." $(DOXYDOC) Doxybook ./make_pdf -src/fltk-title.tex: src/fltk-title.tex.in +src/fluid-user-title.tex: src/fluid-user-title.tex.in echo "Generating $@ ..." GIT_REVISION=`git rev-parse --short=10 HEAD`; \ sed -e"s/@GIT_REVISION@/$$GIT_REVISION/g" \ < $< > $@ -src/fltk-book.tex.in: src/fltk-title.tex +src/fluid-user-book.tex.in: src/fluid-user-title.tex echo "Generating $@ ..." ./make_header $(DOXYDOC) $< $@ -src/fltk-book.tex: src/fltk-book.tex.in +src/fluid-user-book.tex: src/fluid-user-book.tex.in echo "Generating $@ ..." DOXY_VERSION=`$(DOXYDOC) --version|cut -f1 -d' '`; \ YEAR=`date +%Y`; \