1 # Renamed doxygen.am from aminclude.am for inclusion in CVC4
3 # Copyright (C) 2004 Oren Ben-Kiki
4 # This file is distributed under the same terms as the Automake macro files.
6 # Generate automatic documentation using Doxygen. Goals and variables values
7 # are controlled by the various DX_COND_??? conditionals set by autoconf.
9 # The provided goals are:
10 # doxygen-doc: Generate all doxygen documentation.
11 # doxygen-run: Run doxygen, which will generate some of the documentation
12 # (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post
13 # processing required for the rest of it (PS, PDF, and some MAN).
14 # doxygen-man: Rename some doxygen generated man pages.
15 # doxygen-ps: Generate doxygen PostScript documentation.
16 # doxygen-pdf: Generate doxygen PDF documentation.
18 # Note that by default these are not integrated into the automake goals. If
19 # doxygen is used to generate man pages, you can achieve this integration by
20 # setting man3_MANS to the list of man pages generated and then adding the
23 # $(man3_MANS): doxygen-doc
25 # This will cause make to run doxygen and generate all the documentation.
27 # The following variable is intended for use in Makefile.am:
29 # DX_CLEANFILES = everything to clean.
31 # This is usually added to MOSTLYCLEANFILES.
33 ## --------------------------------- ##
34 ## Format-independent Doxygen rules. ##
35 ## --------------------------------- ##
39 ## ------------------------------- ##
40 ## Rules specific for HTML output. ##
41 ## ------------------------------- ##
45 DX_CLEAN_HTML = @DX_DOCDIR@/html
49 ## ------------------------------ ##
50 ## Rules specific for CHM output. ##
51 ## ------------------------------ ##
55 DX_CLEAN_CHM = @DX_DOCDIR@/chm
59 DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
65 ## ------------------------------ ##
66 ## Rules specific for MAN output. ##
67 ## ------------------------------ ##
71 DX_CLEAN_MAN = @DX_DOCDIR@/man
75 ## ------------------------------ ##
76 ## Rules specific for RTF output. ##
77 ## ------------------------------ ##
81 DX_CLEAN_RTF = @DX_DOCDIR@/rtf
85 ## ------------------------------ ##
86 ## Rules specific for XML output. ##
87 ## ------------------------------ ##
91 DX_CLEAN_XML = @DX_DOCDIR@/xml
95 ## ----------------------------- ##
96 ## Rules specific for PS output. ##
97 ## ----------------------------- ##
101 DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
103 DX_PS_GOAL = doxygen-ps
105 doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
107 @DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
108 cd @DX_DOCDIR@/latex; \
109 rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
110 $(DX_LATEX) refman.tex; \
111 $(MAKEINDEX_PATH) refman.idx; \
112 $(DX_LATEX) refman.tex; \
114 while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
115 refman.log > /dev/null 2>&1 \
116 && test $$countdown -gt 0; do \
117 $(DX_LATEX) refman.tex; \
118 countdown=`expr $$countdown - 1`; \
120 $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
124 ## ------------------------------ ##
125 ## Rules specific for PDF output. ##
126 ## ------------------------------ ##
130 DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
132 DX_PDF_GOAL = doxygen-pdf
134 doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
136 @DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
137 cd @DX_DOCDIR@/latex; \
138 rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
139 $(DX_PDFLATEX) refman.tex; \
140 $(DX_MAKEINDEX) refman.idx; \
141 $(DX_PDFLATEX) refman.tex; \
143 while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
144 refman.log > /dev/null 2>&1 \
145 && test $$countdown -gt 0; do \
146 $(DX_PDFLATEX) refman.tex; \
147 countdown=`expr $$countdown - 1`; \
149 mv refman.pdf ../@PACKAGE@.pdf
153 ## ------------------------------------------------- ##
154 ## Rules specific for LaTeX (shared for PS and PDF). ##
155 ## ------------------------------------------------- ##
159 DX_CLEAN_LATEX = @DX_DOCDIR@/latex
163 .PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
165 .INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
167 doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
169 doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
171 @DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
173 $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
176 @DX_DOCDIR@/@PACKAGE@.tag \