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