summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2011-01-05 12:55:10 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2011-01-05 12:55:10 +0000
commit3d470e8c0df71d5e671573250f7ab4cbb64e77d9 (patch)
tree5c29a612d83157effc4a2c728f320e6f88434097
parent4beb3b88e88c3ea070d0437d28b732a6f9d41174 (diff)
Modified documentation/Makefile to correctly generate docs.
Generating HTML and PDF docs is now independent, order doesn't matter. New and modified make targets: - html: generate HTML docs only - pdf: generate PDF docs only - dist: generate HTML and PDF docs (use for distribution files) - html-online: HTML docs with "stripping" modification dates - alldocs: retained as synonym for 'dist' To do: README file must be updated... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8191 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--[-rwxr-xr-x]documentation/Doxybook15
-rw-r--r--documentation/Makefile35
-rwxr-xr-xmakesrcdist4
3 files changed, 31 insertions, 23 deletions
diff --git a/documentation/Doxybook b/documentation/Doxybook
index 6d884e128..158a230cf 100755..100644
--- a/documentation/Doxybook
+++ b/documentation/Doxybook
@@ -565,6 +565,8 @@ INPUT = src/index.dox \
src/fluid.dox \
src/advanced.dox \
src/unicode.dox \
+ ../FL \
+ ../src \
src/enumerations.dox \
src/glut.dox \
src/forms.dox \
@@ -573,9 +575,7 @@ INPUT = src/index.dox \
src/migration_1_3.dox \
src/development.dox \
src/license.dox \
- src/examples.dox \
- ../FL \
- ../src
+ src/examples.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -768,7 +768,7 @@ IGNORE_PREFIX = fl_ \
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
-GENERATE_HTML = YES
+GENERATE_HTML = NO
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -801,7 +801,7 @@ HTML_FOOTER = src/html_footer
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
-HTML_STYLESHEET =
+HTML_STYLESHEET = src/html_stylesheet.css
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
@@ -945,7 +945,7 @@ ENUM_VALUES_PER_LINE = 4
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
# respectively.
-GENERATE_TREEVIEW = NO
+GENERATE_TREEVIEW = YES
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
@@ -1240,7 +1240,8 @@ PREDEFINED = FL_DOXYGEN \
HAVE_CAIRO \
HAVE_GL \
HAVE_GL_OVERLAY \
- FL_EXPORT:=
+ FL_EXPORT:= \
+ __cplusplus
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
diff --git a/documentation/Makefile b/documentation/Makefile
index 9d17c626e..c5888bb4b 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -28,6 +28,9 @@
# Get configuration stuff...
include ../makeinclude
+# make sure that all docs are (re-)created independent of missing deps
+.PHONY: pdf html refman.pdf
+
SRC_DOCDIR = ./src
# These are the HTML "source" files...
@@ -61,10 +64,15 @@ MANPAGES = $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) \
all: $(MANPAGES)
-alldocs: pdf-dist html $(MANPAGES)
+# use make dist to create all docs for distribution files
+# you need an installed version of doxygen for this
+dist: all html pdf
+
+# synonym for dist
+alldocs: dist
clean:
- $(RM) refman.pdf
+ $(RM) fltk.pdf
$(RMDIR) html latex
$(RM) *~ *.bck *.bak *.log
$(RM) $(MANPAGES) $(SRC_DOCDIR)/*.0
@@ -126,10 +134,9 @@ uninstall-linux uninstall-osx:
# The HTML files are now 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 dist' to create the html docs
-html: html/index.html
-
-html/index.html: $(HTMLFILES) Doxyfile
+html: $(HTMLFILES) Doxyfile
echo "Generating HTML documentation..."
-$(RMDIR) html
-$(INSTALL_DIR) html
@@ -139,16 +146,18 @@ html/index.html: $(HTMLFILES) Doxyfile
fi
test -d html && cp src/tiny.png html/
-html-dist: html
- echo "Stripping HTML files ..."
+# this is only used to minimize subversion updates of the online docs
+html-online: html
+ echo "*** Warning: re-create HTML files if you want to build distribution files."
+ echo "*** Warning: Use 'make html' to re-create the correct HTML files."
+ echo "Stripping HTML files for online documentation upload..."
./strip_tags
-pdf-dist: latex/refman.pdf
+pdf: refman.pdf
cp -f latex/refman.pdf fltk.pdf
-pdf: latex/refman.pdf
-
-latex/refman.pdf: latex/refman.tex Doxybook
+refman.pdf: $(HTMLFILES) Doxybook
+ -$(RMDIR) latex
echo "Generating PDF documentation ..."
$(DOXYDOC) Doxybook ;\
(cd latex ;\
@@ -163,9 +172,7 @@ latex/refman.pdf: latex/refman.tex Doxybook
pdflatex --interaction=nonstopmode refman.tex ;\
latex_count=`expr $$latex_count - 1` ;\
done ; \
- cd ..) > pdfall.log
-
-latex/refman.tex: Doxybook
+ cd ..) > pdfall.log 2>&1
#
# End of "$Id$".
diff --git a/makesrcdist b/makesrcdist
index 9eb75de93..accce0ac7 100755
--- a/makesrcdist
+++ b/makesrcdist
@@ -18,14 +18,14 @@ else
echo "ERROR: Please generate the HTML documentation before distributing:"
echo " autoconf"
echo " ./configure"
- echo " cd documentation; make html"
+ echo " cd documentation; make dist"
exit
fi
if test ! -e "documentation/fltk.pdf"; then
echo "ERROR: Please generate the PDF documentation before distributing:"
echo " autoconf"
echo " ./configure"
- echo " cd documentation; make pdf-dist"
+ echo " cd documentation; make dist"
exit
fi
echo Creating tag for release...