1 # Copyright (C) 2004 Oren Ben-Kiki
2 # This file is distributed under the same terms as the Automake macro files.
4 # Generate automatic documentation using Doxygen. Goals and variables values
5 # are controlled by the various DX_COND_??? conditionals set by autoconf.
7 # The provided goals are:
8 # doc: Generate all doxygen documentation.
9 # doxygen-run: Run doxygen, which will generate some of the documentation
10 # (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post
11 # processing required for the rest of it (PS, PDF, and some MAN).
12 # doxygen-man: Rename some doxygen generated man pages.
13 # doxygen-ps: Generate doxygen PostScript documentation.
14 # doxygen-pdf: Generate doxygen PDF documentation.
16 # Note that by default these are not integrated into the automake goals. If
17 # doxygen is used to generate man pages, you can achieve this integration by
18 # setting man3_MANS to the list of man pages generated and then adding the
23 # This will cause make to run doxygen and generate all the documentation.
25 # The following variable is intended for use in Makefile.am:
27 # DX_CLEANFILES = everything to clean.
29 # This is usually added to MOSTLYCLEANFILES.
31 ## --------------------------------- ##
32 ## Format-independent Doxygen rules. ##
33 ## --------------------------------- ##
37 ## ------------------------------- ##
38 ## Rules specific for HTML output. ##
39 ## ------------------------------- ##
43 DX_CLEAN_HTML = @DX_DOCDIR@/html
47 ## ------------------------------ ##
48 ## Rules specific for CHM output. ##
49 ## ------------------------------ ##
53 DX_CLEAN_CHM = @DX_DOCDIR@/chm
57 DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
63 ## ------------------------------ ##
64 ## Rules specific for MAN output. ##
65 ## ------------------------------ ##
69 DX_CLEAN_MAN = @DX_DOCDIR@/man
70 DX_MANS = $(DX_CLEAN_MAN)/man3
71 man3_MANS = $(DX_MANS)/control.h.3 $(DX_MANS)/conversions.h.3 \
72 $(DX_MANS)/register.h.3 $(DX_MANS)/utils.h.3
77 ## ------------------------------ ##
78 ## Rules specific for RTF output. ##
79 ## ------------------------------ ##
83 DX_CLEAN_RTF = @DX_DOCDIR@/rtf
87 ## ------------------------------ ##
88 ## Rules specific for XML output. ##
89 ## ------------------------------ ##
93 DX_CLEAN_XML = @DX_DOCDIR@/xml
97 ## ----------------------------- ##
98 ## Rules specific for PS output. ##
99 ## ----------------------------- ##
103 DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
105 DX_PS_GOAL = doxygen-ps
107 doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
109 @DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
110 cd @DX_DOCDIR@/latex; \
111 rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
112 $(DX_LATEX) refman.tex; \
113 $(MAKEINDEX_PATH) refman.idx; \
114 $(DX_LATEX) refman.tex; \
116 while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
117 refman.log > /dev/null 2>&1 \
118 && test $$countdown -gt 0; do \
119 $(DX_LATEX) refman.tex; \
120 countdown=`expr $$countdown - 1`; \
122 $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
126 ## ------------------------------ ##
127 ## Rules specific for PDF output. ##
128 ## ------------------------------ ##
132 DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
134 DX_PDF_GOAL = doxygen-pdf
136 doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
138 @DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
139 cd @DX_DOCDIR@/latex; \
140 rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
141 $(DX_PDFLATEX) refman.tex; \
142 $(DX_MAKEINDEX) refman.idx; \
143 $(DX_PDFLATEX) refman.tex; \
145 while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
146 refman.log > /dev/null 2>&1 \
147 && test $$countdown -gt 0; do \
148 $(DX_PDFLATEX) refman.tex; \
149 countdown=`expr $$countdown - 1`; \
151 mv refman.pdf ../@PACKAGE@.pdf
155 ## ------------------------------------------------- ##
156 ## Rules specific for LaTeX (shared for PS and PDF). ##
157 ## ------------------------------------------------- ##
161 DX_CLEAN_LATEX = @DX_DOCDIR@/latex
165 .PHONY: doxygen-run doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
167 .INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
169 doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
171 doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
173 @DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
175 $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
178 @DX_DOCDIR@/@PACKAGE@.tag \
179 -r $(DX_CLEAN_HTML) $(DX_CLEAN_CHM) $(DX_CLEAN_CHI) $(DX_CLEAN_MAN) \
180 $(DX_CLEAN_RTF) $(DX_CLEAN_XML) $(DX_CLEAN_PS) $(DX_CLEAN_PDF) \
181 $(DX_CLEAN_LATEX) $(DX_DOCDIR)