config/doxygen.am

   1 # Renamed doxygen.am from aminclude.am for inclusion in CVC4
   2
   3 # Copyright (C) 2004 Oren Ben-Kiki
   4 # This file is distributed under the same terms as the Automake macro files.
   5
   6 # Generate automatic documentation using Doxygen. Goals and variables values
   7 # are controlled by the various DX_COND_??? conditionals set by autoconf.
   8 #
   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.
  17 #
  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
  21 # dependency:
  22 #
  23 #   $(man3_MANS): doxygen-doc
  24 #
  25 # This will cause make to run doxygen and generate all the documentation.
  26 #
  27 # The following variable is intended for use in Makefile.am:
  28 #
  29 # DX_CLEANFILES = everything to clean.
  30 #
  31 # This is usually added to MOSTLYCLEANFILES.
  32
  33 ## --------------------------------- ##
  34 ## Format-independent Doxygen rules. ##
  35 ## --------------------------------- ##
  36
  37 if DX_COND_doc
  38
  39 ## ------------------------------- ##
  40 ## Rules specific for HTML output. ##
  41 ## ------------------------------- ##
  42
  43 if DX_COND_html
  44
  45 DX_CLEAN_HTML = @DX_DOCDIR@/html
  46
  47 endif DX_COND_html
  48
  49 ## ------------------------------ ##
  50 ## Rules specific for CHM output. ##
  51 ## ------------------------------ ##
  52
  53 if DX_COND_chm
  54
  55 DX_CLEAN_CHM = @DX_DOCDIR@/chm
  56
  57 if DX_COND_chi
  58
  59 DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
  60
  61 endif DX_COND_chi
  62
  63 endif DX_COND_chm
  64
  65 ## ------------------------------ ##
  66 ## Rules specific for MAN output. ##
  67 ## ------------------------------ ##
  68
  69 if DX_COND_man
  70
  71 DX_CLEAN_MAN = @DX_DOCDIR@/man
  72
  73 endif DX_COND_man
  74
  75 ## ------------------------------ ##
  76 ## Rules specific for RTF output. ##
  77 ## ------------------------------ ##
  78
  79 if DX_COND_rtf
  80
  81 DX_CLEAN_RTF = @DX_DOCDIR@/rtf
  82
  83 endif DX_COND_rtf
  84
  85 ## ------------------------------ ##
  86 ## Rules specific for XML output. ##
  87 ## ------------------------------ ##
  88
  89 if DX_COND_xml
  90
  91 DX_CLEAN_XML = @DX_DOCDIR@/xml
  92
  93 endif DX_COND_xml
  94
  95 ## ----------------------------- ##
  96 ## Rules specific for PS output. ##
  97 ## ----------------------------- ##
  98
  99 if DX_COND_ps
 100
 101 DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
 102
 103 DX_PS_GOAL = doxygen-ps
 104
 105 doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
 106
 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; \
 113         countdown=5; \
 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`; \
 119         done; \
 120         $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
 121
 122 endif DX_COND_ps
 123
 124 ## ------------------------------ ##
 125 ## Rules specific for PDF output. ##
 126 ## ------------------------------ ##
 127
 128 if DX_COND_pdf
 129
 130 DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
 131
 132 DX_PDF_GOAL = doxygen-pdf
 133
 134 doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
 135
 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; \
 142         countdown=5; \
 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`; \
 148         done; \
 149         mv refman.pdf ../@PACKAGE@.pdf
 150
 151 endif DX_COND_pdf
 152
 153 ## ------------------------------------------------- ##
 154 ## Rules specific for LaTeX (shared for PS and PDF). ##
 155 ## ------------------------------------------------- ##
 156
 157 if DX_COND_latex
 158
 159 DX_CLEAN_LATEX = @DX_DOCDIR@/latex
 160
 161 endif DX_COND_latex
 162
 163 .PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
 164
 165 .INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
 166
 167 doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
 168
 169 doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
 170
 171 @DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
 172         rm -rf @DX_DOCDIR@
 173         $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
 174
 175 DX_CLEANFILES = \
 176     @DX_DOCDIR@/@PACKAGE@.tag \
 177     -r \
 178     $(DX_CLEAN_HTML) \
 179     $(DX_CLEAN_CHM) \
 180     $(DX_CLEAN_CHI) \
 181     $(DX_CLEAN_MAN) \
 182     $(DX_CLEAN_RTF) \
 183     $(DX_CLEAN_XML) \
 184     $(DX_CLEAN_PS) \
 185     $(DX_CLEAN_PDF) \
 186     $(DX_CLEAN_LATEX)
 187
 188 endif DX_COND_doc