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
# doxygen-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
21
# $(man3_MANS): doxygen-doc
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
73
## ------------------------------ ##
74
## Rules specific for RTF output. ##
75
## ------------------------------ ##
79
DX_CLEAN_RTF = @DX_DOCDIR@/rtf
83
## ------------------------------ ##
84
## Rules specific for XML output. ##
85
## ------------------------------ ##
89
DX_CLEAN_XML = @DX_DOCDIR@/xml
93
## ----------------------------- ##
94
## Rules specific for PS output. ##
95
## ----------------------------- ##
99
DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
101
DX_PS_GOAL = doxygen-ps
103
doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
105
@DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
106
cd @DX_DOCDIR@/latex; \
107
rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
108
$(DX_LATEX) refman.tex; \
109
$(MAKEINDEX_PATH) refman.idx; \
110
$(DX_LATEX) refman.tex; \
112
while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
113
refman.log > /dev/null 2>&1 \
114
&& test $$countdown -gt 0; do \
115
$(DX_LATEX) refman.tex; \
116
countdown=`expr $$countdown - 1`; \
118
$(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
122
## ------------------------------ ##
123
## Rules specific for PDF output. ##
124
## ------------------------------ ##
128
DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
130
DX_PDF_GOAL = doxygen-pdf
132
doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
134
@DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
135
cd @DX_DOCDIR@/latex; \
136
rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
137
$(DX_PDFLATEX) refman.tex; \
138
$(DX_MAKEINDEX) refman.idx; \
139
$(DX_PDFLATEX) refman.tex; \
141
while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
142
refman.log > /dev/null 2>&1 \
143
&& test $$countdown -gt 0; do \
144
$(DX_PDFLATEX) refman.tex; \
145
countdown=`expr $$countdown - 1`; \
147
mv refman.pdf ../@PACKAGE@.pdf
151
## ------------------------------------------------- ##
152
## Rules specific for LaTeX (shared for PS and PDF). ##
153
## ------------------------------------------------- ##
157
DX_CLEAN_LATEX = @DX_DOCDIR@/latex
161
.PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
163
.INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
165
doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
167
doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
169
@DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
171
$(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
174
@DX_DOCDIR@/@PACKAGE@.tag \