doc/doxygen-include.am

   1 # ---------------------------------------------------------------------------
   2 # Licensed to the Apache Software Foundation (ASF) under one or more
   3 # contributor license agreements.  See the NOTICE file distributed with
   4 # this work for additional information regarding copyright ownership.
   5 # The ASF licenses this file to You under the Apache License, Version 2.0
   6 # (the "License"); you may not use this file except in compliance with
   7 # the License.  You may obtain a copy of the License at
   8 #
   9 # http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16 # ---------------------------------------------------------------------------
  17
  18 # Copyright (C) 2004 Oren Ben-Kiki
  19 # This file is distributed under the same terms as the Automake macro files.
  20
  21 # Generate automatic documentation using Doxygen. Goals and variables values
  22 # are controlled by the various DX_COND_??? conditionals set by autoconf.
  23 #
  24 # The provided goals are:
  25 # doxygen-doc: Generate all doxygen documentation.
  26 # doxygen-run: Run doxygen, which will generate some of the documentation
  27 #              (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post
  28 #              processing required for the rest of it (PS, PDF, and some MAN).
  29 # doxygen-man: Rename some doxygen generated man pages.
  30 # doxygen-ps: Generate doxygen PostScript documentation.
  31 # doxygen-pdf: Generate doxygen PDF documentation.
  32 #
  33 # Note that by default these are not integrated into the automake goals. If
  34 # doxygen is used to generate man pages, you can achieve this integration by
  35 # setting man3_MANS to the list of man pages generated and then adding the
  36 # dependency:
  37 #
  38 #   $(man3_MANS): doxygen-doc
  39 #
  40 # This will cause make to run doxygen and generate all the documentation.
  41 #
  42 # The following variable is intended for use in Makefile.am:
  43 #
  44 # DX_CLEANFILES = everything to clean.
  45 #
  46 # This is usually added to MOSTLYCLEANFILES.
  47
  48 ## --------------------------------- ##
  49 ## Format-independent Doxygen rules. ##
  50 ## --------------------------------- ##
  51
  52 if DX_COND_doc
  53
  54 ## ------------------------------- ##
  55 ## Rules specific for HTML output. ##
  56 ## ------------------------------- ##
  57
  58 if DX_COND_html
  59
  60 DX_CLEAN_HTML = @DX_DOCDIR@/html
  61
  62 endif DX_COND_html
  63
  64 ## ------------------------------ ##
  65 ## Rules specific for CHM output. ##
  66 ## ------------------------------ ##
  67
  68 if DX_COND_chm
  69
  70 DX_CLEAN_CHM = @DX_DOCDIR@/chm
  71
  72 if DX_COND_chi
  73
  74 DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
  75
  76 endif DX_COND_chi
  77
  78 endif DX_COND_chm
  79
  80 ## ------------------------------ ##
  81 ## Rules specific for MAN output. ##
  82 ## ------------------------------ ##
  83
  84 if DX_COND_man
  85
  86 DX_CLEAN_MAN = @DX_DOCDIR@/man
  87
  88 endif DX_COND_man
  89
  90 ## ------------------------------ ##
  91 ## Rules specific for RTF output. ##
  92 ## ------------------------------ ##
  93
  94 if DX_COND_rtf
  95
  96 DX_CLEAN_RTF = @DX_DOCDIR@/rtf
  97
  98 endif DX_COND_rtf
  99
 100 ## ------------------------------ ##
 101 ## Rules specific for XML output. ##
 102 ## ------------------------------ ##
 103
 104 if DX_COND_xml
 105
 106 DX_CLEAN_XML = @DX_DOCDIR@/xml
 107
 108 endif DX_COND_xml
 109
 110 ## ----------------------------- ##
 111 ## Rules specific for PS output. ##
 112 ## ----------------------------- ##
 113
 114 if DX_COND_ps
 115
 116 DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
 117
 118 DX_PS_GOAL = doxygen-ps
 119
 120 doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
 121
 122 @DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
 123         cd @DX_DOCDIR@/latex; \
 124         rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
 125         $(DX_LATEX) refman.tex; \
 126         $(MAKEINDEX_PATH) refman.idx; \
 127         $(DX_LATEX) refman.tex; \
 128         countdown=5; \
 129         while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
 130                           refman.log > /dev/null 2>&1 \
 131            && test $$countdown -gt 0; do \
 132             $(DX_LATEX) refman.tex; \
 133             countdown=`expr $$countdown - 1`; \
 134         done; \
 135         $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
 136
 137 endif DX_COND_ps
 138
 139 ## ------------------------------ ##
 140 ## Rules specific for PDF output. ##
 141 ## ------------------------------ ##
 142
 143 if DX_COND_pdf
 144
 145 DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
 146
 147 DX_PDF_GOAL = doxygen-pdf
 148
 149 doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
 150
 151 @DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
 152         cd @DX_DOCDIR@/latex; \
 153         rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
 154         $(DX_PDFLATEX) refman.tex; \
 155         $(DX_MAKEINDEX) refman.idx; \
 156         $(DX_PDFLATEX) refman.tex; \
 157         countdown=5; \
 158         while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
 159                           refman.log > /dev/null 2>&1 \
 160            && test $$countdown -gt 0; do \
 161             $(DX_PDFLATEX) refman.tex; \
 162             countdown=`expr $$countdown - 1`; \
 163         done; \
 164         mv refman.pdf ../@PACKAGE@.pdf
 165
 166 endif DX_COND_pdf
 167
 168 ## ------------------------------------------------- ##
 169 ## Rules specific for LaTeX (shared for PS and PDF). ##
 170 ## ------------------------------------------------- ##
 171
 172 if DX_COND_latex
 173
 174 DX_CLEAN_LATEX = @DX_DOCDIR@/latex
 175
 176 endif DX_COND_latex
 177
 178 .PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
 179
 180 .INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
 181
 182 doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
 183
 184 doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
 185
 186 @DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
 187         rm -rf @DX_DOCDIR@
 188         $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
 189
 190 DX_CLEANFILES = \
 191     @DX_DOCDIR@/@PACKAGE@.tag \
 192     -r \
 193     $(DX_CLEAN_HTML) \
 194     $(DX_CLEAN_CHM) \
 195     $(DX_CLEAN_CHI) \
 196     $(DX_CLEAN_MAN) \
 197     $(DX_CLEAN_RTF) \
 198     $(DX_CLEAN_XML) \
 199     $(DX_CLEAN_PS) \
 200     $(DX_CLEAN_PDF) \
 201     $(DX_CLEAN_LATEX)
 202
 203 endif DX_COND_doc