Blame doxygen.am

Packit e9ba0d
# Copyright (C) 2004 Oren Ben-Kiki
Packit e9ba0d
# This file is distributed under the same terms as the Automake macro files.
Packit e9ba0d
Packit e9ba0d
# Generate automatic documentation using Doxygen. Goals and variables values
Packit e9ba0d
# are controlled by the various DX_COND_??? conditionals set by autoconf.
Packit e9ba0d
#
Packit e9ba0d
# The provided goals are:
Packit e9ba0d
# doxygen-doc: Generate all doxygen documentation.
Packit e9ba0d
# doxygen-run: Run doxygen, which will generate some of the documentation
Packit e9ba0d
#              (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post
Packit e9ba0d
#              processing required for the rest of it (PS, PDF, and some MAN).
Packit e9ba0d
# doxygen-man: Rename some doxygen generated man pages.
Packit e9ba0d
# doxygen-ps: Generate doxygen PostScript documentation.
Packit e9ba0d
# doxygen-pdf: Generate doxygen PDF documentation.
Packit e9ba0d
#
Packit e9ba0d
# Note that by default these are not integrated into the automake goals. If
Packit e9ba0d
# doxygen is used to generate man pages, you can achieve this integration by
Packit e9ba0d
# setting man3_MANS to the list of man pages generated and then adding the
Packit e9ba0d
# dependency:
Packit e9ba0d
#
Packit e9ba0d
#   $(man3_MANS): doxygen-doc
Packit e9ba0d
#
Packit e9ba0d
# This will cause make to run doxygen and generate all the documentation.
Packit e9ba0d
#
Packit e9ba0d
# The following variable is intended for use in Makefile.am:
Packit e9ba0d
#
Packit e9ba0d
# DX_CLEANFILES = everything to clean.
Packit e9ba0d
#
Packit e9ba0d
# This is usually added to MOSTLYCLEANFILES.
Packit e9ba0d
Packit e9ba0d
## --------------------------------- ##
Packit e9ba0d
## Format-independent Doxygen rules. ##
Packit e9ba0d
## --------------------------------- ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_doc
Packit e9ba0d
Packit e9ba0d
## ------------------------------- ##
Packit e9ba0d
## Rules specific for HTML output. ##
Packit e9ba0d
## ------------------------------- ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_html
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_HTML = @DX_DOCDIR@/html
Packit e9ba0d
Packit e9ba0d
endif DX_COND_html
Packit e9ba0d
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
## Rules specific for CHM output. ##
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_chm
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_CHM = @DX_DOCDIR@/chm
Packit e9ba0d
Packit e9ba0d
if DX_COND_chi
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
Packit e9ba0d
Packit e9ba0d
endif DX_COND_chi
Packit e9ba0d
Packit e9ba0d
endif DX_COND_chm
Packit e9ba0d
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
## Rules specific for MAN output. ##
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_man
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_MAN = @DX_DOCDIR@/man
Packit e9ba0d
Packit e9ba0d
endif DX_COND_man
Packit e9ba0d
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
## Rules specific for RTF output. ##
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_rtf
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_RTF = @DX_DOCDIR@/rtf
Packit e9ba0d
Packit e9ba0d
endif DX_COND_rtf
Packit e9ba0d
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
## Rules specific for XML output. ##
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_xml
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_XML = @DX_DOCDIR@/xml
Packit e9ba0d
Packit e9ba0d
endif DX_COND_xml
Packit e9ba0d
Packit e9ba0d
## ----------------------------- ##
Packit e9ba0d
## Rules specific for PS output. ##
Packit e9ba0d
## ----------------------------- ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_ps
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
Packit e9ba0d
Packit e9ba0d
DX_PS_GOAL = doxygen-ps
Packit e9ba0d
Packit e9ba0d
doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
Packit e9ba0d
Packit e9ba0d
@DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
Packit e9ba0d
	cd @DX_DOCDIR@/latex; \
Packit e9ba0d
	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
Packit e9ba0d
	$(DX_LATEX) refman.tex; \
Packit e9ba0d
	$(MAKEINDEX_PATH) refman.idx; \
Packit e9ba0d
	$(DX_LATEX) refman.tex; \
Packit e9ba0d
	countdown=5; \
Packit e9ba0d
	while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
Packit e9ba0d
	                  refman.log > /dev/null 2>&1 \
Packit e9ba0d
	   && test $$countdown -gt 0; do \
Packit e9ba0d
	    $(DX_LATEX) refman.tex; \
Packit e9ba0d
	    countdown=`expr $$countdown - 1`; \
Packit e9ba0d
	done; \
Packit e9ba0d
	$(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
Packit e9ba0d
Packit e9ba0d
endif DX_COND_ps
Packit e9ba0d
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
## Rules specific for PDF output. ##
Packit e9ba0d
## ------------------------------ ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_pdf
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
Packit e9ba0d
Packit e9ba0d
DX_PDF_GOAL = doxygen-pdf
Packit e9ba0d
Packit e9ba0d
doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
Packit e9ba0d
Packit e9ba0d
@DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
Packit e9ba0d
	cd @DX_DOCDIR@/latex; \
Packit e9ba0d
	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
Packit e9ba0d
	$(DX_PDFLATEX) refman.tex; \
Packit e9ba0d
	$(DX_MAKEINDEX) refman.idx; \
Packit e9ba0d
	$(DX_PDFLATEX) refman.tex; \
Packit e9ba0d
	countdown=5; \
Packit e9ba0d
	while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
Packit e9ba0d
	                  refman.log > /dev/null 2>&1 \
Packit e9ba0d
	   && test $$countdown -gt 0; do \
Packit e9ba0d
	    $(DX_PDFLATEX) refman.tex; \
Packit e9ba0d
	    countdown=`expr $$countdown - 1`; \
Packit e9ba0d
	done; \
Packit e9ba0d
	mv refman.pdf ../@PACKAGE@.pdf
Packit e9ba0d
Packit e9ba0d
endif DX_COND_pdf
Packit e9ba0d
Packit e9ba0d
## ------------------------------------------------- ##
Packit e9ba0d
## Rules specific for LaTeX (shared for PS and PDF). ##
Packit e9ba0d
## ------------------------------------------------- ##
Packit e9ba0d
Packit e9ba0d
if DX_COND_latex
Packit e9ba0d
Packit e9ba0d
DX_CLEAN_LATEX = @DX_DOCDIR@/latex
Packit e9ba0d
Packit e9ba0d
endif DX_COND_latex
Packit e9ba0d
Packit e9ba0d
.PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL) @DX_DOCDIR@/@PACKAGE@.tag
Packit e9ba0d
Packit e9ba0d
.INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
Packit e9ba0d
Packit e9ba0d
doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
Packit e9ba0d
Packit e9ba0d
doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
Packit e9ba0d
Packit e9ba0d
@DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG)
Packit e9ba0d
	rm -rf @DX_DOCDIR@
Packit e9ba0d
	$(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
Packit e9ba0d
Packit e9ba0d
DX_CLEANFILES = \
Packit e9ba0d
    @DX_DOCDIR@/@PACKAGE@.tag \
Packit e9ba0d
    -r \
Packit e9ba0d
    $(DX_CLEAN_HTML) \
Packit e9ba0d
    $(DX_CLEAN_CHM) \
Packit e9ba0d
    $(DX_CLEAN_CHI) \
Packit e9ba0d
    $(DX_CLEAN_MAN) \
Packit e9ba0d
    $(DX_CLEAN_RTF) \
Packit e9ba0d
    $(DX_CLEAN_XML) \
Packit e9ba0d
    $(DX_CLEAN_PS) \
Packit e9ba0d
    $(DX_CLEAN_PDF) \
Packit e9ba0d
    $(DX_CLEAN_LATEX)
Packit e9ba0d
Packit e9ba0d
endif DX_COND_doc