branches/gmyth-0.1b/aminclude.am
author rosfran
Fri Feb 02 22:46:13 2007 +0000 (2007-02-02)
branchtrunk
changeset 325 b6b5f2dc831d
permissions -rw-r--r--
[svn r327] Changes due the API change on LiveTV.
renatofilho@320
     1
# Copyright (C) 2004 Oren Ben-Kiki
renatofilho@320
     2
# This file is distributed under the same terms as the Automake macro files.
renatofilho@320
     3
renatofilho@320
     4
# Generate automatic documentation using Doxygen. Goals and variables values
renatofilho@320
     5
# are controlled by the various DX_COND_??? conditionals set by autoconf.
renatofilho@320
     6
#
renatofilho@320
     7
# The provided goals are:
renatofilho@320
     8
# doxygen-doc: Generate all doxygen documentation.
renatofilho@320
     9
# doxygen-run: Run doxygen, which will generate some of the documentation
renatofilho@320
    10
#              (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post
renatofilho@320
    11
#              processing required for the rest of it (PS, PDF, and some MAN).
renatofilho@320
    12
# doxygen-man: Rename some doxygen generated man pages.
renatofilho@320
    13
# doxygen-ps: Generate doxygen PostScript documentation.
renatofilho@320
    14
# doxygen-pdf: Generate doxygen PDF documentation.
renatofilho@320
    15
#
renatofilho@320
    16
# Note that by default these are not integrated into the automake goals. If
renatofilho@320
    17
# doxygen is used to generate man pages, you can achieve this integration by
renatofilho@320
    18
# setting man3_MANS to the list of man pages generated and then adding the
renatofilho@320
    19
# dependency:
renatofilho@320
    20
#
renatofilho@320
    21
#   $(man3_MANS): doxygen-doc
renatofilho@320
    22
#
renatofilho@320
    23
# This will cause make to run doxygen and generate all the documentation.
renatofilho@320
    24
#
renatofilho@320
    25
# The following variable is intended for use in Makefile.am:
renatofilho@320
    26
#
renatofilho@320
    27
# DX_CLEANFILES = everything to clean.
renatofilho@320
    28
#
renatofilho@320
    29
# This is usually added to MOSTLYCLEANFILES.
renatofilho@320
    30
renatofilho@320
    31
## --------------------------------- ##
renatofilho@320
    32
## Format-independent Doxygen rules. ##
renatofilho@320
    33
## --------------------------------- ##
renatofilho@320
    34
renatofilho@320
    35
if DX_COND_doc
renatofilho@320
    36
renatofilho@320
    37
## ------------------------------- ##
renatofilho@320
    38
## Rules specific for HTML output. ##
renatofilho@320
    39
## ------------------------------- ##
renatofilho@320
    40
renatofilho@320
    41
if DX_COND_html
renatofilho@320
    42
renatofilho@320
    43
DX_CLEAN_HTML = @DX_DOCDIR@/html
renatofilho@320
    44
renatofilho@320
    45
endif DX_COND_html
renatofilho@320
    46
renatofilho@320
    47
## ------------------------------ ##
renatofilho@320
    48
## Rules specific for CHM output. ##
renatofilho@320
    49
## ------------------------------ ##
renatofilho@320
    50
renatofilho@320
    51
if DX_COND_chm
renatofilho@320
    52
renatofilho@320
    53
DX_CLEAN_CHM = @DX_DOCDIR@/chm
renatofilho@320
    54
renatofilho@320
    55
if DX_COND_chi
renatofilho@320
    56
renatofilho@320
    57
DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
renatofilho@320
    58
renatofilho@320
    59
endif DX_COND_chi
renatofilho@320
    60
renatofilho@320
    61
endif DX_COND_chm
renatofilho@320
    62
renatofilho@320
    63
## ------------------------------ ##
renatofilho@320
    64
## Rules specific for MAN output. ##
renatofilho@320
    65
## ------------------------------ ##
renatofilho@320
    66
renatofilho@320
    67
if DX_COND_man
renatofilho@320
    68
renatofilho@320
    69
DX_CLEAN_MAN = @DX_DOCDIR@/man
renatofilho@320
    70
renatofilho@320
    71
endif DX_COND_man
renatofilho@320
    72
renatofilho@320
    73
## ------------------------------ ##
renatofilho@320
    74
## Rules specific for RTF output. ##
renatofilho@320
    75
## ------------------------------ ##
renatofilho@320
    76
renatofilho@320
    77
if DX_COND_rtf
renatofilho@320
    78
renatofilho@320
    79
DX_CLEAN_RTF = @DX_DOCDIR@/rtf
renatofilho@320
    80
renatofilho@320
    81
endif DX_COND_rtf
renatofilho@320
    82
renatofilho@320
    83
## ------------------------------ ##
renatofilho@320
    84
## Rules specific for XML output. ##
renatofilho@320
    85
## ------------------------------ ##
renatofilho@320
    86
renatofilho@320
    87
if DX_COND_xml
renatofilho@320
    88
renatofilho@320
    89
DX_CLEAN_XML = @DX_DOCDIR@/xml
renatofilho@320
    90
renatofilho@320
    91
endif DX_COND_xml
renatofilho@320
    92
renatofilho@320
    93
## ----------------------------- ##
renatofilho@320
    94
## Rules specific for PS output. ##
renatofilho@320
    95
## ----------------------------- ##
renatofilho@320
    96
renatofilho@320
    97
if DX_COND_ps
renatofilho@320
    98
renatofilho@320
    99
DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
renatofilho@320
   100
renatofilho@320
   101
DX_PS_GOAL = doxygen-ps
renatofilho@320
   102
renatofilho@320
   103
doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
renatofilho@320
   104
renatofilho@320
   105
@DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
renatofilho@320
   106
	cd @DX_DOCDIR@/latex; \
renatofilho@320
   107
	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
renatofilho@320
   108
	$(DX_LATEX) refman.tex; \
renatofilho@320
   109
	$(MAKEINDEX_PATH) refman.idx; \
renatofilho@320
   110
	$(DX_LATEX) refman.tex; \
renatofilho@320
   111
	countdown=5; \
renatofilho@320
   112
	while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
renatofilho@320
   113
	                  refman.log > /dev/null 2>&1 \
renatofilho@320
   114
	   && test $$countdown -gt 0; do \
renatofilho@320
   115
	    $(DX_LATEX) refman.tex; \
renatofilho@320
   116
	    countdown=`expr $$countdown - 1`; \
renatofilho@320
   117
	done; \
renatofilho@320
   118
	$(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
renatofilho@320
   119
renatofilho@320
   120
endif DX_COND_ps
renatofilho@320
   121
renatofilho@320
   122
## ------------------------------ ##
renatofilho@320
   123
## Rules specific for PDF output. ##
renatofilho@320
   124
## ------------------------------ ##
renatofilho@320
   125
renatofilho@320
   126
if DX_COND_pdf
renatofilho@320
   127
renatofilho@320
   128
DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
renatofilho@320
   129
renatofilho@320
   130
DX_PDF_GOAL = doxygen-pdf
renatofilho@320
   131
renatofilho@320
   132
doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
renatofilho@320
   133
renatofilho@320
   134
@DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
renatofilho@320
   135
	cd @DX_DOCDIR@/latex; \
renatofilho@320
   136
	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
renatofilho@320
   137
	$(DX_PDFLATEX) refman.tex; \
renatofilho@320
   138
	$(DX_MAKEINDEX) refman.idx; \
renatofilho@320
   139
	$(DX_PDFLATEX) refman.tex; \
renatofilho@320
   140
	countdown=5; \
renatofilho@320
   141
	while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
renatofilho@320
   142
	                  refman.log > /dev/null 2>&1 \
renatofilho@320
   143
	   && test $$countdown -gt 0; do \
renatofilho@320
   144
	    $(DX_PDFLATEX) refman.tex; \
renatofilho@320
   145
	    countdown=`expr $$countdown - 1`; \
renatofilho@320
   146
	done; \
renatofilho@320
   147
	mv refman.pdf ../@PACKAGE@.pdf
renatofilho@320
   148
renatofilho@320
   149
endif DX_COND_pdf
renatofilho@320
   150
renatofilho@320
   151
## ------------------------------------------------- ##
renatofilho@320
   152
## Rules specific for LaTeX (shared for PS and PDF). ##
renatofilho@320
   153
## ------------------------------------------------- ##
renatofilho@320
   154
renatofilho@320
   155
if DX_COND_latex
renatofilho@320
   156
renatofilho@320
   157
DX_CLEAN_LATEX = @DX_DOCDIR@/latex
renatofilho@320
   158
renatofilho@320
   159
endif DX_COND_latex
renatofilho@320
   160
renatofilho@320
   161
.PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
renatofilho@320
   162
renatofilho@320
   163
.INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
renatofilho@320
   164
renatofilho@320
   165
doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
renatofilho@320
   166
renatofilho@320
   167
doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
renatofilho@320
   168
renatofilho@320
   169
@DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
renatofilho@320
   170
	rm -rf @DX_DOCDIR@
renatofilho@320
   171
	$(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
renatofilho@320
   172
renatofilho@320
   173
DX_CLEANFILES = \
renatofilho@320
   174
    @DX_DOCDIR@/@PACKAGE@.tag \
renatofilho@320
   175
    -r \
renatofilho@320
   176
    $(DX_CLEAN_HTML) \
renatofilho@320
   177
    $(DX_CLEAN_CHM) \
renatofilho@320
   178
    $(DX_CLEAN_CHI) \
renatofilho@320
   179
    $(DX_CLEAN_MAN) \
renatofilho@320
   180
    $(DX_CLEAN_RTF) \
renatofilho@320
   181
    $(DX_CLEAN_XML) \
renatofilho@320
   182
    $(DX_CLEAN_PS) \
renatofilho@320
   183
    $(DX_CLEAN_PDF) \
renatofilho@320
   184
    $(DX_CLEAN_LATEX)
renatofilho@320
   185
renatofilho@320
   186
endif DX_COND_doc