Commit 34ed919c3fdad17140d04d753d547335a9933cb5

Authored by Jürgen Knödlseder
2 parents 6ccfe0e6 8dcf8daf

Merge branch 'doxygen' into integration

.gitignore
... ... @@ -21,6 +21,8 @@ Makefile
21 21 Makefile.in
22 22 aclocal.m4
23 23 autom4te.cache
  24 +m4/libtool.m4
  25 +m4/lt*m4
24 26 config.*
25 27 configure
26 28 ctools.pc
... ... @@ -28,13 +30,14 @@ ctools.pc
28 30 install-sh
29 31 libtool
30 32 ltmain.sh
31   -m4
32 33 missing
33 34 .libs
34 35 .deps
35 36 stamp-h1
36 37 depcomp
  38 +test-driver
37 39  
  40 +doc/html/doxygen
38 41 src/ctools-setup
39 42 pyext/build/
40 43 pyext/setup.py
... ... @@ -50,6 +53,7 @@ test/pfiles/
50 53 test/*.fits
51 54 test/*.dat
52 55 test/*.xml
  56 +test/*.trs
53 57 test/test_cscripts.sh
54 58 examples/*.fits
55 59 examples/*.xml
... ...
Makefile.am
... ... @@ -44,17 +44,141 @@ dist-hook:
44 44 ) \
45 45 )
46 46  
  47 +# Add Doxygen rules
  48 +if DX_COND_doc
  49 +
  50 +# HTML
  51 +if DX_COND_html
  52 +DX_CLEAN_HTML = @DX_DOCDIR@/html
  53 +endif #DX_COND_html
  54 +
  55 +# CHI & CHI
  56 +if DX_COND_chm
  57 +DX_CLEAN_CHM = @DX_DOCDIR@/chm
  58 +if DX_COND_chi
  59 +DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
  60 +endif #DX_COND_chi
  61 +endif #DX_COND_chm
  62 +
  63 +# MAN
  64 +if DX_COND_man
  65 +DX_CLEAN_MAN = @DX_DOCDIR@/man
  66 +endif #DX_COND_man
  67 +
  68 +# RTF
  69 +if DX_COND_rtf
  70 +DX_CLEAN_RTF = @DX_DOCDIR@/rtf
  71 +endif #DX_COND_rtf
  72 +
  73 +# XML
  74 +if DX_COND_xml
  75 +DX_CLEAN_XML = @DX_DOCDIR@/xml
  76 +endif #DX_COND_xml
  77 +
  78 +# PS
  79 +if DX_COND_ps
  80 +DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
  81 +DX_PS_GOAL = doxygen-ps
  82 +doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
  83 +@DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
  84 + cd @DX_DOCDIR@/latex; \
  85 + rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
  86 + $(DX_LATEX) refman.tex; \
  87 + $(MAKEINDEX_PATH) refman.idx; \
  88 + $(DX_LATEX) refman.tex; \
  89 + countdown=5; \
  90 + while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
  91 + refman.log > /dev/null 2>&1 \
  92 + && test $$countdown -gt 0; do \
  93 + $(DX_LATEX) refman.tex; \
  94 + countdown=`expr $$countdown - 1`; \
  95 + done; \
  96 + $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
  97 +endif #DX_COND_ps
  98 +
  99 +# PDF
  100 +if DX_COND_pdf
  101 +DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
  102 +DX_PDF_GOAL = doxygen-pdf
  103 +doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
  104 +@DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
  105 + cd @DX_DOCDIR@/latex; \
  106 + rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
  107 + $(DX_PDFLATEX) refman.tex; \
  108 + $(DX_MAKEINDEX) refman.idx; \
  109 + $(DX_PDFLATEX) refman.tex; \
  110 + countdown=5; \
  111 + while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
  112 + refman.log > /dev/null 2>&1 \
  113 + && test $$countdown -gt 0; do \
  114 + $(DX_PDFLATEX) refman.tex; \
  115 + countdown=`expr $$countdown - 1`; \
  116 + done; \
  117 + mv refman.pdf ../@PACKAGE@.pdf
  118 +endif #DX_COND_pdf
  119 +
  120 +# LaTeX
  121 +if DX_COND_latex
  122 +DX_CLEAN_LATEX = @DX_DOCDIR@/latex
  123 +endif #DX_COND_latex
  124 +
  125 +# Rules
  126 +#.PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
  127 +
  128 +.INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
  129 +
  130 +doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
  131 +
  132 +# Make Doxygen files
  133 +doxygen: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
  134 +
  135 +# Install Doxygen files
  136 +DOCDIRS = html/doxygen man/man3
  137 +doxygen-install:
  138 + $(mkinstalldirs) $(DESTDIR)$(docdir)
  139 + @for dir in $(DOCDIRS) ; do \
  140 + $(mkinstalldirs) $(DESTDIR)$(docdir)/$$dir && \
  141 + for file in $(srcdir)/doc/$$dir/*.* ; do \
  142 + echo "$(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$$dir" ; \
  143 + $(INSTALL_DATA) "$$file" $(DESTDIR)$(docdir)/$$dir ; \
  144 + done ; \
  145 + done
  146 +
  147 +# Uninstall Doxygen files
  148 +doxygen-uninstall:
  149 + for dir in $(DOCDIRS) ; do \
  150 + rm -f -r $(DESTDIR)$(docdir)/$$dir ; \
  151 + done
  152 +
  153 +@DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
  154 + rm -rf @DX_DOCDIR@
  155 + $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
  156 +
  157 +DX_CLEANFILES = \
  158 + @DX_DOCDIR@/@PACKAGE@.tag \
  159 + -r \
  160 + $(DX_CLEAN_HTML) \
  161 + $(DX_CLEAN_CHM) \
  162 + $(DX_CLEAN_CHI) \
  163 + $(DX_CLEAN_MAN) \
  164 + $(DX_CLEAN_RTF) \
  165 + $(DX_CLEAN_XML) \
  166 + $(DX_CLEAN_PS) \
  167 + $(DX_CLEAN_PDF) \
  168 + $(DX_CLEAN_LATEX)
  169 +
  170 +endif #DX_COND_doc
47 171  
48 172 #
49 173 # Additional install rules
50 174 #
51 175  
52 176 # Install HTML files
53   -DOCDIRS = html html/images
  177 +HTMLDIRS = html html/images
54 178 HTML_INSTALL_DATA_TARGETS = install-data-html
55 179 install-data-html:
56 180 $(mkinstalldirs) $(DESTDIR)$(docdir)
57   - @for dir in $(DOCDIRS) ; do \
  181 + @for dir in $(HTMLDIRS) ; do \
58 182 $(mkinstalldirs) $(DESTDIR)$(docdir)/$$dir && \
59 183 for file in $(srcdir)/doc/$$dir/*.* ; do \
60 184 echo "$(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$$dir" ; \
... ... @@ -65,7 +189,7 @@ install-data-html:
65 189 # Uninstall HTML files
66 190 HTML_UNINSTALL_DATA_TARGETS = uninstall-data-html
67 191 uninstall-data-html:
68   - for dir in $(DOCDIRS) ; do \
  192 + for dir in $(HTMLDIRS) ; do \
69 193 rm -f -r $(DESTDIR)$(docdir)/$$dir ; \
70 194 done
71 195  
... ...
configure.ac
... ... @@ -862,6 +862,16 @@ AC_SUBST(LIB_LINK_OPTION)
862 862  
863 863  
864 864 #############################################################################
  865 +# Checks for Doxygen #
  866 +#############################################################################
  867 +DX_HTML_FEATURE(ON)
  868 +DX_PS_FEATURE(OFF)
  869 +DX_PDF_FEATURE(OFF)
  870 +DX_MAN_FEATURE(ON)
  871 +DX_INIT_DOXYGEN([ctools], [doc/Doxyfile], [doc/doxygen])
  872 +
  873 +
  874 +#############################################################################
865 875 # Set list of output files to be created #
866 876 #############################################################################
867 877 AC_CONFIG_FILES([Makefile
... ... @@ -945,6 +955,13 @@ else
945 955 echo " - Make Python binding (no)"
946 956 fi
947 957  
  958 +# Dump Doxygen information
  959 +if test "$DX_DOXYGEN" != ""; then
  960 + echo " * Doxygen (yes) $DX_DOXYGEN"
  961 +else
  962 + echo " - Doxygen (no)"
  963 +fi
  964 +
948 965 # Dump compile options
949 966 if test "x$enable_openmp" = "xyes"; then
950 967 echo " * Enable OpenMP (yes) (default)"
... ...
doc/Doxyfile 0 → 100644
  1 +# Doxyfile 1.8.1.1
  2 +
  3 +# This file describes the settings to be used by the documentation system
  4 +# doxygen (www.doxygen.org) for a project.
  5 +#
  6 +# All text after a hash (#) is considered a comment and will be ignored.
  7 +# The format is:
  8 +# TAG = value [value, ...]
  9 +# For lists items can also be appended using:
  10 +# TAG += value [value, ...]
  11 +# Values that contain spaces should be placed between quotes (" ").
  12 +
  13 +#---------------------------------------------------------------------------
  14 +# Project related configuration options
  15 +#---------------------------------------------------------------------------
  16 +
  17 +# This tag specifies the encoding used for all characters in the config file
  18 +# that follow. The default is UTF-8 which is also the encoding used for all
  19 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the
  20 +# iconv built into libc) for the transcoding. See
  21 +# http://www.gnu.org/software/libiconv for the list of possible encodings.
  22 +
  23 +DOXYFILE_ENCODING = UTF-8
  24 +
  25 +# The PROJECT_NAME tag is a single word (or sequence of words) that should
  26 +# identify the project. Note that if you do not use Doxywizard you need
  27 +# to put quotes around the project name if it contains spaces.
  28 +
  29 +PROJECT_NAME = ctools
  30 +
  31 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
  32 +# This could be handy for archiving the generated documentation or
  33 +# if some version control system is used.
  34 +
  35 +PROJECT_NUMBER = 00-06-00
  36 +
  37 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
  38 +# for a project that appears at the top of each page and should give viewer
  39 +# a quick idea about the purpose of the project. Keep the description short.
  40 +
  41 +PROJECT_BRIEF =
  42 +
  43 +# With the PROJECT_LOGO tag one can specify an logo or icon that is
  44 +# included in the documentation. The maximum height of the logo should not
  45 +# exceed 55 pixels and the maximum width should not exceed 200 pixels.
  46 +# Doxygen will copy the logo to the output directory.
  47 +
  48 +PROJECT_LOGO =
  49 +
  50 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  51 +# base path where the generated documentation will be put.
  52 +# If a relative path is entered, it will be relative to the location
  53 +# where doxygen was started. If left blank the current directory will be used.
  54 +
  55 +OUTPUT_DIRECTORY = doc
  56 +
  57 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  58 +# 4096 sub-directories (in 2 levels) under the output directory of each output
  59 +# format and will distribute the generated files over these directories.
  60 +# Enabling this option can be useful when feeding doxygen a huge amount of
  61 +# source files, where putting all generated files in the same directory would
  62 +# otherwise cause performance problems for the file system.
  63 +
  64 +CREATE_SUBDIRS = NO
  65 +
  66 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
  67 +# documentation generated by doxygen is written. Doxygen will use this
  68 +# information to generate all constant output in the proper language.
  69 +# The default language is English, other supported languages are:
  70 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  71 +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  72 +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  73 +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  74 +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
  75 +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  76 +
  77 +OUTPUT_LANGUAGE = English
  78 +
  79 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  80 +# include brief member descriptions after the members that are listed in
  81 +# the file and class documentation (similar to JavaDoc).
  82 +# Set to NO to disable this.
  83 +
  84 +BRIEF_MEMBER_DESC = YES
  85 +
  86 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  87 +# the brief description of a member or function before the detailed description.
  88 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  89 +# brief descriptions will be completely suppressed.
  90 +
  91 +REPEAT_BRIEF = YES
  92 +
  93 +# This tag implements a quasi-intelligent brief description abbreviator
  94 +# that is used to form the text in various listings. Each string
  95 +# in this list, if found as the leading text of the brief description, will be
  96 +# stripped from the text and the result after processing the whole list, is
  97 +# used as the annotated text. Otherwise, the brief description is used as-is.
  98 +# If left blank, the following values are used ("$name" is automatically
  99 +# replaced with the name of the entity): "The $name class" "The $name widget"
  100 +# "The $name file" "is" "provides" "specifies" "contains"
  101 +# "represents" "a" "an" "the"
  102 +
  103 +ABBREVIATE_BRIEF =
  104 +
  105 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  106 +# Doxygen will generate a detailed section even if there is only a brief
  107 +# description.
  108 +
  109 +ALWAYS_DETAILED_SEC = NO
  110 +
  111 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  112 +# inherited members of a class in the documentation of that class as if those
  113 +# members were ordinary class members. Constructors, destructors and assignment
  114 +# operators of the base classes will not be shown.
  115 +
  116 +INLINE_INHERITED_MEMB = NO
  117 +
  118 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  119 +# path before files name in the file list and in the header files. If set
  120 +# to NO the shortest path that makes the file name unique will be used.
  121 +
  122 +FULL_PATH_NAMES = YES
  123 +
  124 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  125 +# can be used to strip a user-defined part of the path. Stripping is
  126 +# only done if one of the specified strings matches the left-hand part of
  127 +# the path. The tag can be used to show relative paths in the file list.
  128 +# If left blank the directory from which doxygen is run is used as the
  129 +# path to strip.
  130 +
  131 +STRIP_FROM_PATH =
  132 +
  133 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  134 +# the path mentioned in the documentation of a class, which tells
  135 +# the reader which header file to include in order to use a class.
  136 +# If left blank only the name of the header file containing the class
  137 +# definition is used. Otherwise one should specify the include paths that
  138 +# are normally passed to the compiler using the -I flag.
  139 +
  140 +STRIP_FROM_INC_PATH =
  141 +
  142 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  143 +# (but less readable) file names. This can be useful if your file system
  144 +# doesn't support long names like on DOS, Mac, or CD-ROM.
  145 +
  146 +SHORT_NAMES = NO
  147 +
  148 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  149 +# will interpret the first line (until the first dot) of a JavaDoc-style
  150 +# comment as the brief description. If set to NO, the JavaDoc
  151 +# comments will behave just like regular Qt-style comments
  152 +# (thus requiring an explicit @brief command for a brief description.)
  153 +
  154 +JAVADOC_AUTOBRIEF = NO
  155 +
  156 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
  157 +# interpret the first line (until the first dot) of a Qt-style
  158 +# comment as the brief description. If set to NO, the comments
  159 +# will behave just like regular Qt-style comments (thus requiring
  160 +# an explicit \brief command for a brief description.)
  161 +
  162 +QT_AUTOBRIEF = NO
  163 +
  164 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  165 +# treat a multi-line C++ special comment block (i.e. a block of //! or ///
  166 +# comments) as a brief description. This used to be the default behaviour.
  167 +# The new default is to treat a multi-line C++ comment block as a detailed
  168 +# description. Set this tag to YES if you prefer the old behaviour instead.
  169 +
  170 +MULTILINE_CPP_IS_BRIEF = NO
  171 +
  172 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  173 +# member inherits the documentation from any documented member that it
  174 +# re-implements.
  175 +
  176 +INHERIT_DOCS = YES
  177 +
  178 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  179 +# a new page for each member. If set to NO, the documentation of a member will
  180 +# be part of the file/class/namespace that contains it.
  181 +
  182 +SEPARATE_MEMBER_PAGES = NO
  183 +
  184 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
  185 +# Doxygen uses this value to replace tabs by spaces in code fragments.
  186 +
  187 +TAB_SIZE = 4
  188 +
  189 +# This tag can be used to specify a number of aliases that acts
  190 +# as commands in the documentation. An alias has the form "name=value".
  191 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
  192 +# put the command \sideeffect (or @sideeffect) in the documentation, which
  193 +# will result in a user-defined paragraph with heading "Side Effects:".
  194 +# You can put \n's in the value part of an alias to insert newlines.
  195 +
  196 +ALIASES =
  197 +
  198 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
  199 +# A mapping has the form "name=value". For example adding
  200 +# "class=itcl::class" will allow you to use the command class in the
  201 +# itcl::class meaning.
  202 +
  203 +TCL_SUBST =
  204 +
  205 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  206 +# sources only. Doxygen will then generate output that is more tailored for C.
  207 +# For instance, some of the names that are used will be different. The list
  208 +# of all members will be omitted, etc.
  209 +
  210 +OPTIMIZE_OUTPUT_FOR_C = NO
  211 +
  212 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  213 +# sources only. Doxygen will then generate output that is more tailored for
  214 +# Java. For instance, namespaces will be presented as packages, qualified
  215 +# scopes will look different, etc.
  216 +
  217 +OPTIMIZE_OUTPUT_JAVA = NO
  218 +
  219 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  220 +# sources only. Doxygen will then generate output that is more tailored for
  221 +# Fortran.
  222 +
  223 +OPTIMIZE_FOR_FORTRAN = NO
  224 +
  225 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  226 +# sources. Doxygen will then generate output that is tailored for
  227 +# VHDL.
  228 +
  229 +OPTIMIZE_OUTPUT_VHDL = NO
  230 +
  231 +# Doxygen selects the parser to use depending on the extension of the files it
  232 +# parses. With this tag you can assign which parser to use for a given extension.
  233 +# Doxygen has a built-in mapping, but you can override or extend it using this
  234 +# tag. The format is ext=language, where ext is a file extension, and language
  235 +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
  236 +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
  237 +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
  238 +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
  239 +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
  240 +
  241 +EXTENSION_MAPPING =
  242 +
  243 +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
  244 +# comments according to the Markdown format, which allows for more readable
  245 +# documentation. See http://daringfireball.net/projects/markdown/ for details.
  246 +# The output of markdown processing is further processed by doxygen, so you
  247 +# can mix doxygen, HTML, and XML commands with Markdown formatting.
  248 +# Disable only in case of backward compatibilities issues.
  249 +
  250 +MARKDOWN_SUPPORT = YES
  251 +
  252 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  253 +# to include (a tag file for) the STL sources as input, then you should
  254 +# set this tag to YES in order to let doxygen match functions declarations and
  255 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  256 +# func(std::string) {}). This also makes the inheritance and collaboration
  257 +# diagrams that involve STL classes more complete and accurate.
  258 +
  259 +BUILTIN_STL_SUPPORT = NO
  260 +
  261 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
  262 +# enable parsing support.
  263 +
  264 +CPP_CLI_SUPPORT = NO
  265 +
  266 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
  267 +# Doxygen will parse them like normal C++ but will assume all classes use public
  268 +# instead of private inheritance when no explicit protection keyword is present.
  269 +
  270 +SIP_SUPPORT = NO
  271 +
  272 +# For Microsoft's IDL there are propget and propput attributes to indicate getter
  273 +# and setter methods for a property. Setting this option to YES (the default)
  274 +# will make doxygen replace the get and set methods by a property in the
  275 +# documentation. This will only work if the methods are indeed getting or
  276 +# setting a simple type. If this is not the case, or you want to show the
  277 +# methods anyway, you should set this option to NO.
  278 +
  279 +IDL_PROPERTY_SUPPORT = YES
  280 +
  281 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  282 +# tag is set to YES, then doxygen will reuse the documentation of the first
  283 +# member in the group (if any) for the other members of the group. By default
  284 +# all members of a group must be documented explicitly.
  285 +
  286 +DISTRIBUTE_GROUP_DOC = NO
  287 +
  288 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  289 +# the same type (for instance a group of public functions) to be put as a
  290 +# subgroup of that type (e.g. under the Public Functions section). Set it to
  291 +# NO to prevent subgrouping. Alternatively, this can be done per class using
  292 +# the \nosubgrouping command.
  293 +
  294 +SUBGROUPING = YES
  295 +
  296 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
  297 +# unions are shown inside the group in which they are included (e.g. using
  298 +# @ingroup) instead of on a separate page (for HTML and Man pages) or
  299 +# section (for LaTeX and RTF).
  300 +
  301 +INLINE_GROUPED_CLASSES = NO
  302 +
  303 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
  304 +# unions with only public data fields will be shown inline in the documentation
  305 +# of the scope in which they are defined (i.e. file, namespace, or group
  306 +# documentation), provided this scope is documented. If set to NO (the default),
  307 +# structs, classes, and unions are shown on a separate page (for HTML and Man
  308 +# pages) or section (for LaTeX and RTF).
  309 +
  310 +INLINE_SIMPLE_STRUCTS = NO
  311 +
  312 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
  313 +# is documented as struct, union, or enum with the name of the typedef. So
  314 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  315 +# with name TypeT. When disabled the typedef will appear as a member of a file,
  316 +# namespace, or class. And the struct will be named TypeS. This can typically
  317 +# be useful for C code in case the coding convention dictates that all compound
  318 +# types are typedef'ed and only the typedef is referenced, never the tag name.
  319 +
  320 +TYPEDEF_HIDES_STRUCT = NO
  321 +
  322 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
  323 +# determine which symbols to keep in memory and which to flush to disk.
  324 +# When the cache is full, less often used symbols will be written to disk.
  325 +# For small to medium size projects (<1000 input files) the default value is
  326 +# probably good enough. For larger projects a too small cache size can cause
  327 +# doxygen to be busy swapping symbols to and from disk most of the time
  328 +# causing a significant performance penalty.
  329 +# If the system has enough physical memory increasing the cache will improve the
  330 +# performance by keeping more symbols in memory. Note that the value works on
  331 +# a logarithmic scale so increasing the size by one will roughly double the
  332 +# memory usage. The cache size is given by this formula:
  333 +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
  334 +# corresponding to a cache size of 2^16 = 65536 symbols.
  335 +
  336 +SYMBOL_CACHE_SIZE = 0
  337 +
  338 +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
  339 +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
  340 +# their name and scope. Since this can be an expensive process and often the
  341 +# same symbol appear multiple times in the code, doxygen keeps a cache of
  342 +# pre-resolved symbols. If the cache is too small doxygen will become slower.
  343 +# If the cache is too large, memory is wasted. The cache size is given by this
  344 +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
  345 +# corresponding to a cache size of 2^16 = 65536 symbols.
  346 +
  347 +LOOKUP_CACHE_SIZE = 0
  348 +
  349 +#---------------------------------------------------------------------------
  350 +# Build related configuration options
  351 +#---------------------------------------------------------------------------
  352 +
  353 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  354 +# documentation are documented, even if no documentation was available.
  355 +# Private class members and static file members will be hidden unless
  356 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  357 +
  358 +EXTRACT_ALL = YES
  359 +
  360 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  361 +# will be included in the documentation.
  362 +
  363 +EXTRACT_PRIVATE = YES
  364 +
  365 +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
  366 +
  367 +EXTRACT_PACKAGE = NO
  368 +
  369 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
  370 +# will be included in the documentation.
  371 +
  372 +EXTRACT_STATIC = YES
  373 +
  374 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  375 +# defined locally in source files will be included in the documentation.
  376 +# If set to NO only classes defined in header files are included.
  377 +
  378 +EXTRACT_LOCAL_CLASSES = YES
  379 +
  380 +# This flag is only useful for Objective-C code. When set to YES local
  381 +# methods, which are defined in the implementation section but not in
  382 +# the interface are included in the documentation.
  383 +# If set to NO (the default) only methods in the interface are included.
  384 +
  385 +EXTRACT_LOCAL_METHODS = NO
  386 +
  387 +# If this flag is set to YES, the members of anonymous namespaces will be
  388 +# extracted and appear in the documentation as a namespace called
  389 +# 'anonymous_namespace{file}', where file will be replaced with the base
  390 +# name of the file that contains the anonymous namespace. By default
  391 +# anonymous namespaces are hidden.
  392 +
  393 +EXTRACT_ANON_NSPACES = NO
  394 +
  395 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  396 +# undocumented members of documented classes, files or namespaces.
  397 +# If set to NO (the default) these members will be included in the
  398 +# various overviews, but no documentation section is generated.
  399 +# This option has no effect if EXTRACT_ALL is enabled.
  400 +
  401 +HIDE_UNDOC_MEMBERS = NO
  402 +
  403 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  404 +# undocumented classes that are normally visible in the class hierarchy.
  405 +# If set to NO (the default) these classes will be included in the various
  406 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
  407 +
  408 +HIDE_UNDOC_CLASSES = NO
  409 +
  410 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  411 +# friend (class|struct|union) declarations.
  412 +# If set to NO (the default) these declarations will be included in the
  413 +# documentation.
  414 +
  415 +HIDE_FRIEND_COMPOUNDS = NO
  416 +
  417 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  418 +# documentation blocks found inside the body of a function.
  419 +# If set to NO (the default) these blocks will be appended to the
  420 +# function's detailed documentation block.
  421 +
  422 +HIDE_IN_BODY_DOCS = NO
  423 +
  424 +# The INTERNAL_DOCS tag determines if documentation
  425 +# that is typed after a \internal command is included. If the tag is set
  426 +# to NO (the default) then the documentation will be excluded.
  427 +# Set it to YES to include the internal documentation.
  428 +
  429 +INTERNAL_DOCS = NO
  430 +
  431 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  432 +# file names in lower-case letters. If set to YES upper-case letters are also
  433 +# allowed. This is useful if you have classes or files whose names only differ
  434 +# in case and if your file system supports case sensitive file names. Windows
  435 +# and Mac users are advised to set this option to NO.
  436 +
  437 +CASE_SENSE_NAMES = YES
  438 +
  439 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  440 +# will show members with their full class and namespace scopes in the
  441 +# documentation. If set to YES the scope will be hidden.
  442 +
  443 +HIDE_SCOPE_NAMES = NO
  444 +
  445 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  446 +# will put a list of the files that are included by a file in the documentation
  447 +# of that file.
  448 +
  449 +SHOW_INCLUDE_FILES = YES
  450 +
  451 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
  452 +# will list include files with double quotes in the documentation
  453 +# rather than with sharp brackets.
  454 +
  455 +FORCE_LOCAL_INCLUDES = NO
  456 +
  457 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  458 +# is inserted in the documentation for inline members.
  459 +
  460 +INLINE_INFO = YES
  461 +
  462 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  463 +# will sort the (detailed) documentation of file and class members
  464 +# alphabetically by member name. If set to NO the members will appear in
  465 +# declaration order.
  466 +
  467 +SORT_MEMBER_DOCS = YES
  468 +
  469 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  470 +# brief documentation of file, namespace and class members alphabetically
  471 +# by member name. If set to NO (the default) the members will appear in
  472 +# declaration order.
  473 +
  474 +SORT_BRIEF_DOCS = NO
  475 +
  476 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
  477 +# will sort the (brief and detailed) documentation of class members so that
  478 +# constructors and destructors are listed first. If set to NO (the default)
  479 +# the constructors will appear in the respective orders defined by
  480 +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
  481 +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
  482 +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
  483 +
  484 +SORT_MEMBERS_CTORS_1ST = NO
  485 +
  486 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
  487 +# hierarchy of group names into alphabetical order. If set to NO (the default)
  488 +# the group names will appear in their defined order.
  489 +
  490 +SORT_GROUP_NAMES = NO
  491 +
  492 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  493 +# sorted by fully-qualified names, including namespaces. If set to
  494 +# NO (the default), the class list will be sorted only by class name,
  495 +# not including the namespace part.
  496 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  497 +# Note: This option applies only to the class list, not to the
  498 +# alphabetical list.
  499 +
  500 +SORT_BY_SCOPE_NAME = NO
  501 +
  502 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
  503 +# do proper type resolution of all parameters of a function it will reject a
  504 +# match between the prototype and the implementation of a member function even
  505 +# if there is only one candidate or it is obvious which candidate to choose
  506 +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
  507 +# will still accept a match between prototype and implementation in such cases.
  508 +
  509 +STRICT_PROTO_MATCHING = NO
  510 +
  511 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
  512 +# disable (NO) the todo list. This list is created by putting \todo
  513 +# commands in the documentation.
  514 +
  515 +GENERATE_TODOLIST = YES
  516 +
  517 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
  518 +# disable (NO) the test list. This list is created by putting \test
  519 +# commands in the documentation.
  520 +
  521 +GENERATE_TESTLIST = YES
  522 +
  523 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
  524 +# disable (NO) the bug list. This list is created by putting \bug
  525 +# commands in the documentation.
  526 +
  527 +GENERATE_BUGLIST = YES
  528 +
  529 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  530 +# disable (NO) the deprecated list. This list is created by putting
  531 +# \deprecated commands in the documentation.
  532 +
  533 +GENERATE_DEPRECATEDLIST= YES
  534 +
  535 +# The ENABLED_SECTIONS tag can be used to enable conditional
  536 +# documentation sections, marked by \if sectionname ... \endif.
  537 +
  538 +ENABLED_SECTIONS =
  539 +
  540 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  541 +# the initial value of a variable or macro consists of for it to appear in
  542 +# the documentation. If the initializer consists of more lines than specified
  543 +# here it will be hidden. Use a value of 0 to hide initializers completely.
  544 +# The appearance of the initializer of individual variables and macros in the
  545 +# documentation can be controlled using \showinitializer or \hideinitializer
  546 +# command in the documentation regardless of this setting.
  547 +
  548 +MAX_INITIALIZER_LINES = 30
  549 +
  550 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  551 +# at the bottom of the documentation of classes and structs. If set to YES the
  552 +# list will mention the files that were used to generate the documentation.
  553 +
  554 +SHOW_USED_FILES = YES
  555 +
  556 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
  557 +# This will remove the Files entry from the Quick Index and from the
  558 +# Folder Tree View (if specified). The default is YES.
  559 +
  560 +SHOW_FILES = YES
  561 +
  562 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
  563 +# Namespaces page.
  564 +# This will remove the Namespaces entry from the Quick Index
  565 +# and from the Folder Tree View (if specified). The default is YES.
  566 +
  567 +SHOW_NAMESPACES = YES
  568 +
  569 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
  570 +# doxygen should invoke to get the current version for each file (typically from
  571 +# the version control system). Doxygen will invoke the program by executing (via
  572 +# popen()) the command <command> <input-file>, where <command> is the value of
  573 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  574 +# provided by doxygen. Whatever the program writes to standard output
  575 +# is used as the file version. See the manual for examples.
  576 +
  577 +FILE_VERSION_FILTER =
  578 +
  579 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  580 +# by doxygen. The layout file controls the global structure of the generated
  581 +# output files in an output format independent way. To create the layout file
  582 +# that represents doxygen's defaults, run doxygen with the -l option.
  583 +# You can optionally specify a file name after the option, if omitted
  584 +# DoxygenLayout.xml will be used as the name of the layout file.
  585 +
  586 +LAYOUT_FILE =
  587 +
  588 +# The CITE_BIB_FILES tag can be used to specify one or more bib files
  589 +# containing the references data. This must be a list of .bib files. The
  590 +# .bib extension is automatically appended if omitted. Using this command
  591 +# requires the bibtex tool to be installed. See also
  592 +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
  593 +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
  594 +# feature you need bibtex and perl available in the search path.
  595 +
  596 +CITE_BIB_FILES =
  597 +
  598 +#---------------------------------------------------------------------------
  599 +# configuration options related to warning and progress messages
  600 +#---------------------------------------------------------------------------
  601 +
  602 +# The QUIET tag can be used to turn on/off the messages that are generated
  603 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
  604 +
  605 +QUIET = NO
  606 +
  607 +# The WARNINGS tag can be used to turn on/off the warning messages that are
  608 +# generated by doxygen. Possible values are YES and NO. If left blank
  609 +# NO is used.
  610 +
  611 +WARNINGS = YES
  612 +
  613 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  614 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  615 +# automatically be disabled.
  616 +
  617 +WARN_IF_UNDOCUMENTED = YES
  618 +
  619 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  620 +# potential errors in the documentation, such as not documenting some
  621 +# parameters in a documented function, or documenting parameters that
  622 +# don't exist or using markup commands wrongly.
  623 +
  624 +WARN_IF_DOC_ERROR = YES
  625 +
  626 +# The WARN_NO_PARAMDOC option can be enabled to get warnings for
  627 +# functions that are documented, but have no documentation for their parameters
  628 +# or return value. If set to NO (the default) doxygen will only warn about
  629 +# wrong or incomplete parameter documentation, but not about the absence of
  630 +# documentation.
  631 +
  632 +WARN_NO_PARAMDOC = NO
  633 +
  634 +# The WARN_FORMAT tag determines the format of the warning messages that
  635 +# doxygen can produce. The string should contain the $file, $line, and $text
  636 +# tags, which will be replaced by the file and line number from which the
  637 +# warning originated and the warning text. Optionally the format may contain
  638 +# $version, which will be replaced by the version of the file (if it could
  639 +# be obtained via FILE_VERSION_FILTER)
  640 +
  641 +WARN_FORMAT = "$file:$line: $text"
  642 +
  643 +# The WARN_LOGFILE tag can be used to specify a file to which warning
  644 +# and error messages should be written. If left blank the output is written
  645 +# to stderr.
  646 +
  647 +WARN_LOGFILE =
  648 +
  649 +#---------------------------------------------------------------------------
  650 +# configuration options related to the input files
  651 +#---------------------------------------------------------------------------
  652 +
  653 +# The INPUT tag can be used to specify the files and/or directories that contain
  654 +# documented source files. You may enter file names like "myfile.cpp" or
  655 +# directories like "/usr/src/myproject". Separate the files or directories
  656 +# with spaces.
  657 +
  658 +INPUT = "."
  659 +
  660 +# This tag can be used to specify the character encoding of the source files
  661 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  662 +# also the default input encoding. Doxygen uses libiconv (or the iconv built
  663 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  664 +# the list of possible encodings.
  665 +
  666 +INPUT_ENCODING = UTF-8
  667 +
  668 +# If the value of the INPUT tag contains directories, you can use the
  669 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  670 +# and *.h) to filter out the source-files in the directories. If left
  671 +# blank the following patterns are tested:
  672 +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
  673 +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
  674 +# *.f90 *.f *.for *.vhd *.vhdl
  675 +
  676 +FILE_PATTERNS = *.cpp \
  677 + *.cxx \
  678 + *.hpp \
  679 + *.py
  680 +
  681 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
  682 +# should be searched for input files as well. Possible values are YES and NO.
  683 +# If left blank NO is used.
  684 +
  685 +RECURSIVE = YES
  686 +
  687 +# The EXCLUDE tag can be used to specify files and/or directories that should be
  688 +# excluded from the INPUT source files. This way you can easily exclude a
  689 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
  690 +# Note that relative paths are relative to the directory from which doxygen is
  691 +# run.
  692 +
  693 +EXCLUDE = "pyext"
  694 +
  695 +
  696 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  697 +# directories that are symbolic links (a Unix file system feature) are excluded
  698 +# from the input.
  699 +
  700 +EXCLUDE_SYMLINKS = NO
  701 +
  702 +# If the value of the INPUT tag contains directories, you can use the
  703 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  704 +# certain files from those directories. Note that the wildcards are matched
  705 +# against the file with absolute path, so to exclude all test directories
  706 +# for example use the pattern */test/*
  707 +
  708 +EXCLUDE_PATTERNS =
  709 +
  710 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  711 +# (namespaces, classes, functions, etc.) that should be excluded from the
  712 +# output. The symbol name can be a fully qualified name, a word, or if the
  713 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
  714 +# AClass::ANamespace, ANamespace::*Test
  715 +
  716 +EXCLUDE_SYMBOLS = std* \
  717 + swig* \
  718 + Swig*
  719 +
  720 +# The EXAMPLE_PATH tag can be used to specify one or more files or
  721 +# directories that contain example code fragments that are included (see
  722 +# the \include command).
  723 +
  724 +EXAMPLE_PATH =
  725 +
  726 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
  727 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  728 +# and *.h) to filter out the source-files in the directories. If left
  729 +# blank all files are included.
  730 +
  731 +EXAMPLE_PATTERNS =
  732 +
  733 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  734 +# searched for input files to be used with the \include or \dontinclude
  735 +# commands irrespective of the value of the RECURSIVE tag.
  736 +# Possible values are YES and NO. If left blank NO is used.
  737 +
  738 +EXAMPLE_RECURSIVE = NO
  739 +
  740 +# The IMAGE_PATH tag can be used to specify one or more files or
  741 +# directories that contain image that are included in the documentation (see
  742 +# the \image command).
  743 +
  744 +IMAGE_PATH =
  745 +
  746 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
  747 +# invoke to filter for each input file. Doxygen will invoke the filter program
  748 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
  749 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  750 +# input file. Doxygen will then use the output that the filter program writes
  751 +# to standard output.
  752 +# If FILTER_PATTERNS is specified, this tag will be
  753 +# ignored.
  754 +
  755 +INPUT_FILTER =
  756 +
  757 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  758 +# basis.
  759 +# Doxygen will compare the file name with each pattern and apply the
  760 +# filter if there is a match.
  761 +# The filters are a list of the form:
  762 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  763 +# info on how filters are used. If FILTER_PATTERNS is empty or if
  764 +# non of the patterns match the file name, INPUT_FILTER is applied.
  765 +
  766 +FILTER_PATTERNS =
  767 +
  768 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  769 +# INPUT_FILTER) will be used to filter the input files when producing source
  770 +# files to browse (i.e. when SOURCE_BROWSER is set to YES).
  771 +
  772 +FILTER_SOURCE_FILES = NO
  773 +
  774 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  775 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
  776 +# and it is also possible to disable source filtering for a specific pattern
  777 +# using *.ext= (so without naming a filter). This option only has effect when
  778 +# FILTER_SOURCE_FILES is enabled.
  779 +
  780 +FILTER_SOURCE_PATTERNS =
  781 +
  782 +#---------------------------------------------------------------------------
  783 +# configuration options related to source browsing
  784 +#---------------------------------------------------------------------------
  785 +
  786 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
  787 +# be generated. Documented entities will be cross-referenced with these sources.
  788 +# Note: To get rid of all source code in the generated output, make sure also
  789 +# VERBATIM_HEADERS is set to NO.
  790 +
  791 +SOURCE_BROWSER = YES
  792 +
  793 +# Setting the INLINE_SOURCES tag to YES will include the body
  794 +# of functions and classes directly in the documentation.
  795 +
  796 +INLINE_SOURCES = NO
  797 +
  798 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  799 +# doxygen to hide any special comment blocks from generated source code
  800 +# fragments. Normal C, C++ and Fortran comments will always remain visible.
  801 +
  802 +STRIP_CODE_COMMENTS = NO
  803 +
  804 +# If the REFERENCED_BY_RELATION tag is set to YES
  805 +# then for each documented function all documented
  806 +# functions referencing it will be listed.
  807 +
  808 +REFERENCED_BY_RELATION = YES
  809 +
  810 +# If the REFERENCES_RELATION tag is set to YES
  811 +# then for each documented function all documented entities
  812 +# called/used by that function will be listed.
  813 +
  814 +REFERENCES_RELATION = YES
  815 +
  816 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  817 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  818 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  819 +# link to the source code.
  820 +# Otherwise they will link to the documentation.
  821 +
  822 +REFERENCES_LINK_SOURCE = YES
  823 +
  824 +# If the USE_HTAGS tag is set to YES then the references to source code
  825 +# will point to the HTML generated by the htags(1) tool instead of doxygen
  826 +# built-in source browser. The htags tool is part of GNU's global source
  827 +# tagging system (see http://www.gnu.org/software/global/global.html). You
  828 +# will need version 4.8.6 or higher.
  829 +
  830 +USE_HTAGS = NO
  831 +
  832 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  833 +# will generate a verbatim copy of the header file for each class for
  834 +# which an include is specified. Set to NO to disable this.
  835 +
  836 +VERBATIM_HEADERS = YES
  837 +
  838 +#---------------------------------------------------------------------------
  839 +# configuration options related to the alphabetical class index
  840 +#---------------------------------------------------------------------------
  841 +
  842 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  843 +# of all compounds will be generated. Enable this if the project
  844 +# contains a lot of classes, structs, unions or interfaces.
  845 +
  846 +ALPHABETICAL_INDEX = YES
  847 +
  848 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  849 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  850 +# in which this list will be split (can be a number in the range [1..20])
  851 +
  852 +COLS_IN_ALPHA_INDEX = 5
  853 +
  854 +# In case all classes in a project start with a common prefix, all
  855 +# classes will be put under the same header in the alphabetical index.
  856 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  857 +# should be ignored while generating the index headers.
  858 +
  859 +IGNORE_PREFIX =
  860 +
  861 +#---------------------------------------------------------------------------
  862 +# configuration options related to the HTML output
  863 +#---------------------------------------------------------------------------
  864 +
  865 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  866 +# generate HTML output.
  867 +
  868 +GENERATE_HTML = YES
  869 +
  870 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  871 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  872 +# put in front of it. If left blank `html' will be used as the default path.
  873 +
  874 +HTML_OUTPUT = html/doxygen
  875 +
  876 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  877 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  878 +# doxygen will generate files with .html extension.
  879 +
  880 +HTML_FILE_EXTENSION = .html
  881 +
  882 +# The HTML_HEADER tag can be used to specify a personal HTML header for
  883 +# each generated HTML page. If it is left blank doxygen will generate a
  884 +# standard header. Note that when using a custom header you are responsible
  885 +# for the proper inclusion of any scripts and style sheets that doxygen
  886 +# needs, which is dependent on the configuration options used.
  887 +# It is advised to generate a default header using "doxygen -w html
  888 +# header.html footer.html stylesheet.css YourConfigFile" and then modify
  889 +# that header. Note that the header is subject to change so you typically
  890 +# have to redo this when upgrading to a newer version of doxygen or when
  891 +# changing the value of configuration settings such as GENERATE_TREEVIEW!
  892 +
  893 +HTML_HEADER =
  894 +
  895 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
  896 +# each generated HTML page. If it is left blank doxygen will generate a
  897 +# standard footer.
  898 +
  899 +HTML_FOOTER =
  900 +
  901 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  902 +# style sheet that is used by each HTML page. It can be used to
  903 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
  904 +# will generate a default style sheet. Note that doxygen will try to copy
  905 +# the style sheet file to the HTML output directory, so don't put your own
  906 +# style sheet in the HTML output directory as well, or it will be erased!
  907 +
  908 +HTML_STYLESHEET =
  909 +
  910 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  911 +# other source files which should be copied to the HTML output directory. Note
  912 +# that these files will be copied to the base HTML output directory. Use the
  913 +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  914 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that
  915 +# the files will be copied as-is; there are no commands or markers available.
  916 +
  917 +HTML_EXTRA_FILES =
  918 +
  919 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
  920 +# Doxygen will adjust the colors in the style sheet and background images
  921 +# according to this color. Hue is specified as an angle on a colorwheel,
  922 +# see http://en.wikipedia.org/wiki/Hue for more information.
  923 +# For instance the value 0 represents red, 60 is yellow, 120 is green,
  924 +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
  925 +# The allowed range is 0 to 359.
  926 +
  927 +HTML_COLORSTYLE_HUE = 220
  928 +
  929 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
  930 +# the colors in the HTML output. For a value of 0 the output will use
  931 +# grayscales only. A value of 255 will produce the most vivid colors.
  932 +
  933 +HTML_COLORSTYLE_SAT = 100
  934 +
  935 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
  936 +# the luminance component of the colors in the HTML output. Values below
  937 +# 100 gradually make the output lighter, whereas values above 100 make
  938 +# the output darker. The value divided by 100 is the actual gamma applied,
  939 +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
  940 +# and 100 does not change the gamma.
  941 +
  942 +HTML_COLORSTYLE_GAMMA = 80
  943 +
  944 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  945 +# page will contain the date and time when the page was generated. Setting
  946 +# this to NO can help when comparing the output of multiple runs.
  947 +
  948 +HTML_TIMESTAMP = YES
  949 +
  950 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  951 +# documentation will contain sections that can be hidden and shown after the
  952 +# page has loaded.
  953 +
  954 +HTML_DYNAMIC_SECTIONS = NO
  955 +
  956 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
  957 +# entries shown in the various tree structured indices initially; the user
  958 +# can expand and collapse entries dynamically later on. Doxygen will expand
  959 +# the tree to such a level that at most the specified number of entries are
  960 +# visible (unless a fully collapsed tree already exceeds this amount).
  961 +# So setting the number of entries 1 will produce a full collapsed tree by
  962 +# default. 0 is a special value representing an infinite number of entries
  963 +# and will result in a full expanded tree by default.
  964 +
  965 +HTML_INDEX_NUM_ENTRIES = 100
  966 +
  967 +# If the GENERATE_DOCSET tag is set to YES, additional index files
  968 +# will be generated that can be used as input for Apple's Xcode 3
  969 +# integrated development environment, introduced with OSX 10.5 (Leopard).
  970 +# To create a documentation set, doxygen will generate a Makefile in the
  971 +# HTML output directory. Running make will produce the docset in that
  972 +# directory and running "make install" will install the docset in
  973 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  974 +# it at startup.
  975 +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  976 +# for more information.
  977 +
  978 +GENERATE_DOCSET = NO
  979 +
  980 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  981 +# feed. A documentation feed provides an umbrella under which multiple
  982 +# documentation sets from a single provider (such as a company or product suite)
  983 +# can be grouped.
  984 +
  985 +DOCSET_FEEDNAME = "Doxygen generated docs"
  986 +
  987 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  988 +# should uniquely identify the documentation set bundle. This should be a
  989 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  990 +# will append .docset to the name.
  991 +
  992 +DOCSET_BUNDLE_ID = org.doxygen.Project
  993 +
  994 +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
  995 +# the documentation publisher. This should be a reverse domain-name style
  996 +# string, e.g. com.mycompany.MyDocSet.documentation.
  997 +
  998 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  999 +
  1000 +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
  1001 +
  1002 +DOCSET_PUBLISHER_NAME = Publisher
  1003 +
  1004 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
  1005 +# will be generated that can be used as input for tools like the
  1006 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  1007 +# of the generated HTML documentation.
  1008 +
  1009 +GENERATE_HTMLHELP = NO
  1010 +
  1011 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  1012 +# be used to specify the file name of the resulting .chm file. You
  1013 +# can add a path in front of the file if the result should not be
  1014 +# written to the html output directory.
  1015 +
  1016 +CHM_FILE =
  1017 +
  1018 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  1019 +# be used to specify the location (absolute path including file name) of
  1020 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  1021 +# the HTML help compiler on the generated index.hhp.
  1022 +
  1023 +HHC_LOCATION =
  1024 +
  1025 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  1026 +# controls if a separate .chi index file is generated (YES) or that
  1027 +# it should be included in the master .chm file (NO).
  1028 +
  1029 +GENERATE_CHI = NO
  1030 +
  1031 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  1032 +# is used to encode HtmlHelp index (hhk), content (hhc) and project file
  1033 +# content.
  1034 +
  1035 +CHM_INDEX_ENCODING =
  1036 +
  1037 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  1038 +# controls whether a binary table of contents is generated (YES) or a
  1039 +# normal table of contents (NO) in the .chm file.
  1040 +
  1041 +BINARY_TOC = NO
  1042 +
  1043 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
  1044 +# to the contents of the HTML help documentation and to the tree view.
  1045 +
  1046 +TOC_EXPAND = NO
  1047 +
  1048 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1049 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
  1050 +# that can be used as input for Qt's qhelpgenerator to generate a
  1051 +# Qt Compressed Help (.qch) of the generated HTML documentation.
  1052 +
  1053 +GENERATE_QHP = NO
  1054 +
  1055 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
  1056 +# be used to specify the file name of the resulting .qch file.
  1057 +# The path specified is relative to the HTML output folder.
  1058 +
  1059 +QCH_FILE =
  1060 +
  1061 +# The QHP_NAMESPACE tag specifies the namespace to use when generating
  1062 +# Qt Help Project output. For more information please see
  1063 +# http://doc.trolltech.com/qthelpproject.html#namespace
  1064 +
  1065 +QHP_NAMESPACE = org.doxygen.Project
  1066 +
  1067 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
  1068 +# Qt Help Project output. For more information please see
  1069 +# http://doc.trolltech.com/qthelpproject.html#virtual-folders
  1070 +
  1071 +QHP_VIRTUAL_FOLDER = doc
  1072 +
  1073 +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
  1074 +# add. For more information please see
  1075 +# http://doc.trolltech.com/qthelpproject.html#custom-filters
  1076 +
  1077 +QHP_CUST_FILTER_NAME =
  1078 +
  1079 +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
  1080 +# custom filter to add. For more information please see
  1081 +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
  1082 +# Qt Help Project / Custom Filters</a>.
  1083 +
  1084 +QHP_CUST_FILTER_ATTRS =
  1085 +
  1086 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1087 +# project's
  1088 +# filter section matches.
  1089 +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
  1090 +# Qt Help Project / Filter Attributes</a>.
  1091 +
  1092 +QHP_SECT_FILTER_ATTRS =
  1093 +
  1094 +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
  1095 +# be used to specify the location of Qt's qhelpgenerator.
  1096 +# If non-empty doxygen will try to run qhelpgenerator on the generated
  1097 +# .qhp file.
  1098 +
  1099 +QHG_LOCATION =
  1100 +
  1101 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
  1102 +# will be generated, which together with the HTML files, form an Eclipse help
  1103 +# plugin. To install this plugin and make it available under the help contents
  1104 +# menu in Eclipse, the contents of the directory containing the HTML and XML
  1105 +# files needs to be copied into the plugins directory of eclipse. The name of
  1106 +# the directory within the plugins directory should be the same as
  1107 +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
  1108 +# the help appears.
  1109 +
  1110 +GENERATE_ECLIPSEHELP = NO
  1111 +
  1112 +# A unique identifier for the eclipse help plugin. When installing the plugin
  1113 +# the directory name containing the HTML and XML files should also have
  1114 +# this name.
  1115 +
  1116 +ECLIPSE_DOC_ID = org.doxygen.Project
  1117 +
  1118 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
  1119 +# at top of each HTML page. The value NO (the default) enables the index and
  1120 +# the value YES disables it. Since the tabs have the same information as the
  1121 +# navigation tree you can set this option to NO if you already set
  1122 +# GENERATE_TREEVIEW to YES.
  1123 +
  1124 +DISABLE_INDEX = NO
  1125 +
  1126 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1127 +# structure should be generated to display hierarchical information.
  1128 +# If the tag value is set to YES, a side panel will be generated
  1129 +# containing a tree-like index structure (just like the one that
  1130 +# is generated for HTML Help). For this to work a browser that supports
  1131 +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
  1132 +# Windows users are probably better off using the HTML help feature.
  1133 +# Since the tree basically has the same information as the tab index you
  1134 +# could consider to set DISABLE_INDEX to NO when enabling this option.
  1135 +
  1136 +GENERATE_TREEVIEW = YES
  1137 +
  1138 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
  1139 +# (range [0,1..20]) that doxygen will group on one line in the generated HTML
  1140 +# documentation. Note that a value of 0 will completely suppress the enum
  1141 +# values from appearing in the overview section.
  1142 +
  1143 +ENUM_VALUES_PER_LINE = 4
  1144 +
  1145 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  1146 +# used to set the initial width (in pixels) of the frame in which the tree
  1147 +# is shown.
  1148 +
  1149 +TREEVIEW_WIDTH = 250
  1150 +
  1151 +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
  1152 +# links to external symbols imported via tag files in a separate window.
  1153 +
  1154 +EXT_LINKS_IN_WINDOW = NO
  1155 +
  1156 +# Use this tag to change the font size of Latex formulas included
  1157 +# as images in the HTML documentation. The default is 10. Note that
  1158 +# when you change the font size after a successful doxygen run you need
  1159 +# to manually remove any form_*.png images from the HTML output directory
  1160 +# to force them to be regenerated.
  1161 +
  1162 +FORMULA_FONTSIZE = 10
  1163 +
  1164 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1165 +# generated for formulas are transparent PNGs. Transparent PNGs are
  1166 +# not supported properly for IE 6.0, but are supported on all modern browsers.
  1167 +# Note that when changing this option you need to delete any form_*.png files
  1168 +# in the HTML output before the changes have effect.
  1169 +
  1170 +FORMULA_TRANSPARENT = YES
  1171 +
  1172 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
  1173 +# (see http://www.mathjax.org) which uses client side Javascript for the
  1174 +# rendering instead of using prerendered bitmaps. Use this if you do not
  1175 +# have LaTeX installed or if you want to formulas look prettier in the HTML
  1176 +# output. When enabled you may also need to install MathJax separately and
  1177 +# configure the path to it using the MATHJAX_RELPATH option.
  1178 +
  1179 +USE_MATHJAX = YES
  1180 +
  1181 +# When MathJax is enabled you need to specify the location relative to the
  1182 +# HTML output directory using the MATHJAX_RELPATH option. The destination
  1183 +# directory should contain the MathJax.js script. For instance, if the mathjax
  1184 +# directory is located at the same level as the HTML output directory, then
  1185 +# MATHJAX_RELPATH should be ../mathjax. The default value points to
  1186 +# the MathJax Content Delivery Network so you can quickly see the result without
  1187 +# installing MathJax.
  1188 +# However, it is strongly recommended to install a local
  1189 +# copy of MathJax from http://www.mathjax.org before deployment.
  1190 +
  1191 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1192 +
  1193 +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
  1194 +# names that should be enabled during MathJax rendering.
  1195 +
  1196 +MATHJAX_EXTENSIONS =
  1197 +
  1198 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box
  1199 +# for the HTML output. The underlying search engine uses javascript
  1200 +# and DHTML and should work on any modern browser. Note that when using
  1201 +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
  1202 +# (GENERATE_DOCSET) there is already a search function so this one should
  1203 +# typically be disabled. For large projects the javascript based search engine
  1204 +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
  1205 +
  1206 +SEARCHENGINE = YES
  1207 +
  1208 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1209 +# implemented using a PHP enabled web server instead of at the web client
  1210 +# using Javascript. Doxygen will generate the search PHP script and index
  1211 +# file to put on the web server. The advantage of the server
  1212 +# based approach is that it scales better to large projects and allows
  1213 +# full text search. The disadvantages are that it is more difficult to setup
  1214 +# and does not have live searching capabilities.
  1215 +
  1216 +SERVER_BASED_SEARCH = NO
  1217 +
  1218 +#---------------------------------------------------------------------------
  1219 +# configuration options related to the LaTeX output
  1220 +#---------------------------------------------------------------------------
  1221 +
  1222 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  1223 +# generate Latex output.
  1224 +
  1225 +GENERATE_LATEX = NO
  1226 +
  1227 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  1228 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1229 +# put in front of it. If left blank `latex' will be used as the default path.
  1230 +
  1231 +LATEX_OUTPUT = latex
  1232 +
  1233 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1234 +# invoked. If left blank `latex' will be used as the default command name.
  1235 +# Note that when enabling USE_PDFLATEX this option is only used for
  1236 +# generating bitmaps for formulas in the HTML output, but not in the
  1237 +# Makefile that is written to the output directory.
  1238 +
  1239 +LATEX_CMD_NAME = latex
  1240 +
  1241 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  1242 +# generate index for LaTeX. If left blank `makeindex' will be used as the
  1243 +# default command name.
  1244 +
  1245 +MAKEINDEX_CMD_NAME = makeindex
  1246 +
  1247 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  1248 +# LaTeX documents. This may be useful for small projects and may help to
  1249 +# save some trees in general.
  1250 +
  1251 +COMPACT_LATEX = NO
  1252 +
  1253 +# The PAPER_TYPE tag can be used to set the paper type that is used
  1254 +# by the printer. Possible values are: a4, letter, legal and
  1255 +# executive. If left blank a4wide will be used.
  1256 +
  1257 +PAPER_TYPE = a4wide
  1258 +
  1259 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  1260 +# packages that should be included in the LaTeX output.
  1261 +
  1262 +EXTRA_PACKAGES =
  1263 +
  1264 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  1265 +# the generated latex document. The header should contain everything until
  1266 +# the first chapter. If it is left blank doxygen will generate a
  1267 +# standard header. Notice: only use this tag if you know what you are doing!
  1268 +
  1269 +LATEX_HEADER =
  1270 +
  1271 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
  1272 +# the generated latex document. The footer should contain everything after
  1273 +# the last chapter. If it is left blank doxygen will generate a
  1274 +# standard footer. Notice: only use this tag if you know what you are doing!
  1275 +
  1276 +LATEX_FOOTER =
  1277 +
  1278 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  1279 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
  1280 +# contain links (just like the HTML output) instead of page references
  1281 +# This makes the output suitable for online browsing using a pdf viewer.
  1282 +
  1283 +PDF_HYPERLINKS = YES
  1284 +
  1285 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  1286 +# plain latex in the generated Makefile. Set this option to YES to get a
  1287 +# higher quality PDF documentation.
  1288 +
  1289 +USE_PDFLATEX = NO
  1290 +
  1291 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  1292 +# command to the generated LaTeX files. This will instruct LaTeX to keep
  1293 +# running if errors occur, instead of asking the user for help.
  1294 +# This option is also used when generating formulas in HTML.
  1295 +
  1296 +LATEX_BATCHMODE = NO
  1297 +
  1298 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not
  1299 +# include the index chapters (such as File Index, Compound Index, etc.)
  1300 +# in the output.
  1301 +
  1302 +LATEX_HIDE_INDICES = NO
  1303 +
  1304 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include
  1305 +# source code with syntax highlighting in the LaTeX output.
  1306 +# Note that which sources are shown also depends on other settings
  1307 +# such as SOURCE_BROWSER.
  1308 +
  1309 +LATEX_SOURCE_CODE = NO
  1310 +
  1311 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1312 +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
  1313 +# http://en.wikipedia.org/wiki/BibTeX for more info.
  1314 +
  1315 +LATEX_BIB_STYLE = plain
  1316 +
  1317 +#---------------------------------------------------------------------------
  1318 +# configuration options related to the RTF output
  1319 +#---------------------------------------------------------------------------
  1320 +
  1321 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  1322 +# The RTF output is optimized for Word 97 and may not look very pretty with
  1323 +# other RTF readers or editors.
  1324 +
  1325 +GENERATE_RTF = NO
  1326 +
  1327 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  1328 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1329 +# put in front of it. If left blank `rtf' will be used as the default path.
  1330 +
  1331 +RTF_OUTPUT = rtf
  1332 +
  1333 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  1334 +# RTF documents. This may be useful for small projects and may help to
  1335 +# save some trees in general.
  1336 +
  1337 +COMPACT_RTF = NO
  1338 +
  1339 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  1340 +# will contain hyperlink fields. The RTF file will
  1341 +# contain links (just like the HTML output) instead of page references.
  1342 +# This makes the output suitable for online browsing using WORD or other
  1343 +# programs which support those fields.
  1344 +# Note: wordpad (write) and others do not support links.
  1345 +
  1346 +RTF_HYPERLINKS = NO
  1347 +
  1348 +# Load style sheet definitions from file. Syntax is similar to doxygen's
  1349 +# config file, i.e. a series of assignments. You only have to provide
  1350 +# replacements, missing definitions are set to their default value.
  1351 +
  1352 +RTF_STYLESHEET_FILE =
  1353 +
  1354 +# Set optional variables used in the generation of an rtf document.
  1355 +# Syntax is similar to doxygen's config file.
  1356 +
  1357 +RTF_EXTENSIONS_FILE =
  1358 +
  1359 +#---------------------------------------------------------------------------
  1360 +# configuration options related to the man page output
  1361 +#---------------------------------------------------------------------------
  1362 +
  1363 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  1364 +# generate man pages
  1365 +
  1366 +GENERATE_MAN = NO
  1367 +
  1368 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
  1369 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1370 +# put in front of it. If left blank `man' will be used as the default path.
  1371 +
  1372 +MAN_OUTPUT = man
  1373 +
  1374 +# The MAN_EXTENSION tag determines the extension that is added to
  1375 +# the generated man pages (default is the subroutine's section .3)
  1376 +
  1377 +MAN_EXTENSION = .3
  1378 +
  1379 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  1380 +# then it will generate one additional man file for each entity
  1381 +# documented in the real man page(s). These additional files
  1382 +# only source the real man page, but without them the man command
  1383 +# would be unable to find the correct page. The default is NO.
  1384 +
  1385 +MAN_LINKS = NO
  1386 +
  1387 +#---------------------------------------------------------------------------
  1388 +# configuration options related to the XML output
  1389 +#---------------------------------------------------------------------------
  1390 +
  1391 +# If the GENERATE_XML tag is set to YES Doxygen will
  1392 +# generate an XML file that captures the structure of
  1393 +# the code including all documentation.
  1394 +
  1395 +GENERATE_XML = NO
  1396 +
  1397 +# The XML_OUTPUT tag is used to specify where the XML pages will be put.
  1398 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1399 +# put in front of it. If left blank `xml' will be used as the default path.
  1400 +
  1401 +XML_OUTPUT = xml
  1402 +
  1403 +# The XML_SCHEMA tag can be used to specify an XML schema,
  1404 +# which can be used by a validating XML parser to check the
  1405 +# syntax of the XML files.
  1406 +
  1407 +XML_SCHEMA =
  1408 +
  1409 +# The XML_DTD tag can be used to specify an XML DTD,
  1410 +# which can be used by a validating XML parser to check the
  1411 +# syntax of the XML files.
  1412 +
  1413 +XML_DTD =
  1414 +
  1415 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  1416 +# dump the program listings (including syntax highlighting
  1417 +# and cross-referencing information) to the XML output. Note that
  1418 +# enabling this will significantly increase the size of the XML output.
  1419 +
  1420 +XML_PROGRAMLISTING = YES
  1421 +
  1422 +#---------------------------------------------------------------------------
  1423 +# configuration options for the AutoGen Definitions output
  1424 +#---------------------------------------------------------------------------
  1425 +
  1426 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  1427 +# generate an AutoGen Definitions (see autogen.sf.net) file
  1428 +# that captures the structure of the code including all
  1429 +# documentation. Note that this feature is still experimental
  1430 +# and incomplete at the moment.
  1431 +
  1432 +GENERATE_AUTOGEN_DEF = NO
  1433 +
  1434 +#---------------------------------------------------------------------------
  1435 +# configuration options related to the Perl module output
  1436 +#---------------------------------------------------------------------------
  1437 +
  1438 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will
  1439 +# generate a Perl module file that captures the structure of
  1440 +# the code including all documentation. Note that this
  1441 +# feature is still experimental and incomplete at the
  1442 +# moment.
  1443 +
  1444 +GENERATE_PERLMOD = NO
  1445 +
  1446 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  1447 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able
  1448 +# to generate PDF and DVI output from the Perl module output.
  1449 +
  1450 +PERLMOD_LATEX = NO
  1451 +
  1452 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  1453 +# nicely formatted so it can be parsed by a human reader.
  1454 +# This is useful
  1455 +# if you want to understand what is going on.
  1456 +# On the other hand, if this
  1457 +# tag is set to NO the size of the Perl module output will be much smaller
  1458 +# and Perl will parse it just the same.
  1459 +
  1460 +PERLMOD_PRETTY = YES
  1461 +
  1462 +# The names of the make variables in the generated doxyrules.make file
  1463 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  1464 +# This is useful so different doxyrules.make files included by the same
  1465 +# Makefile don't overwrite each other's variables.
  1466 +
  1467 +PERLMOD_MAKEVAR_PREFIX =
  1468 +
  1469 +#---------------------------------------------------------------------------
  1470 +# Configuration options related to the preprocessor
  1471 +#---------------------------------------------------------------------------
  1472 +
  1473 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  1474 +# evaluate all C-preprocessor directives found in the sources and include
  1475 +# files.
  1476 +
  1477 +ENABLE_PREPROCESSING = YES
  1478 +
  1479 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  1480 +# names in the source code. If set to NO (the default) only conditional
  1481 +# compilation will be performed. Macro expansion can be done in a controlled
  1482 +# way by setting EXPAND_ONLY_PREDEF to YES.
  1483 +
  1484 +MACRO_EXPANSION = NO
  1485 +
  1486 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  1487 +# then the macro expansion is limited to the macros specified with the
  1488 +# PREDEFINED and EXPAND_AS_DEFINED tags.
  1489 +
  1490 +EXPAND_ONLY_PREDEF = NO
  1491 +
  1492 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  1493 +# pointed to by INCLUDE_PATH will be searched when a #include is found.
  1494 +
  1495 +SEARCH_INCLUDES = YES
  1496 +
  1497 +# The INCLUDE_PATH tag can be used to specify one or more directories that
  1498 +# contain include files that are not input files but should be processed by
  1499 +# the preprocessor.
  1500 +
  1501 +INCLUDE_PATH =
  1502 +
  1503 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1504 +# patterns (like *.h and *.hpp) to filter out the header-files in the
  1505 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
  1506 +# be used.
  1507 +
  1508 +INCLUDE_FILE_PATTERNS =
  1509 +
  1510 +# The PREDEFINED tag can be used to specify one or more macro names that
  1511 +# are defined before the preprocessor is started (similar to the -D option of
  1512 +# gcc). The argument of the tag is a list of macros of the form: name
  1513 +# or name=definition (no spaces). If the definition and the = are
  1514 +# omitted =1 is assumed. To prevent a macro definition from being
  1515 +# undefined via #undef or recursively expanded use the := operator
  1516 +# instead of the = operator.
  1517 +
  1518 +PREDEFINED =
  1519 +
  1520 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  1521 +# this tag can be used to specify a list of macro names that should be expanded.
  1522 +# The macro definition that is found in the sources will be used.
  1523 +# Use the PREDEFINED tag if you want to use a different macro definition that
  1524 +# overrules the definition found in the source code.
  1525 +
  1526 +EXPAND_AS_DEFINED =
  1527 +
  1528 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  1529 +# doxygen's preprocessor will remove all references to function-like macros
  1530 +# that are alone on a line, have an all uppercase name, and do not end with a
  1531 +# semicolon, because these will confuse the parser if not removed.
  1532 +
  1533 +SKIP_FUNCTION_MACROS = YES
  1534 +
  1535 +#---------------------------------------------------------------------------
  1536 +# Configuration::additions related to external references
  1537 +#---------------------------------------------------------------------------
  1538 +
  1539 +# The TAGFILES option can be used to specify one or more tagfiles. For each
  1540 +# tag file the location of the external documentation should be added. The
  1541 +# format of a tag file without this location is as follows:
  1542 +#
  1543 +# TAGFILES = file1 file2 ...
  1544 +# Adding location for the tag files is done as follows:
  1545 +#
  1546 +# TAGFILES = file1=loc1 "file2 = loc2" ...
  1547 +# where "loc1" and "loc2" can be relative or absolute paths
  1548 +# or URLs. Note that each tag file must have a unique name (where the name does
  1549 +# NOT include the path). If a tag file is not located in the directory in which
  1550 +# doxygen is run, you must also specify the path to the tagfile here.
  1551 +
  1552 +TAGFILES =
  1553 +
  1554 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
  1555 +# a tag file that is based on the input files it reads.
  1556 +
  1557 +GENERATE_TAGFILE =
  1558 +
  1559 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
  1560 +# in the class index. If set to NO only the inherited external classes
  1561 +# will be listed.
  1562 +
  1563 +ALLEXTERNALS = NO
  1564 +
  1565 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  1566 +# in the modules index. If set to NO, only the current project's groups will
  1567 +# be listed.
  1568 +
  1569 +EXTERNAL_GROUPS = YES
  1570 +
  1571 +# The PERL_PATH should be the absolute path and name of the perl script
  1572 +# interpreter (i.e. the result of `which perl').
  1573 +
  1574 +PERL_PATH = /usr/bin/perl
  1575 +
  1576 +#---------------------------------------------------------------------------
  1577 +# Configuration options related to the dot tool
  1578 +#---------------------------------------------------------------------------
  1579 +
  1580 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  1581 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  1582 +# or super classes. Setting the tag to NO turns the diagrams off. Note that
  1583 +# this option also works with HAVE_DOT disabled, but it is recommended to
  1584 +# install and use dot, since it yields more powerful graphs.
  1585 +
  1586 +CLASS_DIAGRAMS = YES
  1587 +
  1588 +# You can define message sequence charts within doxygen comments using the \msc
  1589 +# command. Doxygen will then run the mscgen tool (see
  1590 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  1591 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1592 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
  1593 +# default search path.
  1594 +
  1595 +MSCGEN_PATH =
  1596 +
  1597 +# If set to YES, the inheritance and collaboration graphs will hide
  1598 +# inheritance and usage relations if the target is undocumented
  1599 +# or is not a class.
  1600 +
  1601 +HIDE_UNDOC_RELATIONS = NO
  1602 +
  1603 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1604 +# available from the path. This tool is part of Graphviz, a graph visualization
  1605 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
  1606 +# have no effect if this option is set to NO (the default)
  1607 +
  1608 +HAVE_DOT = NO
  1609 +
  1610 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
  1611 +# allowed to run in parallel. When set to 0 (the default) doxygen will
  1612 +# base this on the number of processors available in the system. You can set it
  1613 +# explicitly to a value larger than 0 to get control over the balance
  1614 +# between CPU load and processing speed.
  1615 +
  1616 +DOT_NUM_THREADS = 0
  1617 +
  1618 +# By default doxygen will use the Helvetica font for all dot files that
  1619 +# doxygen generates. When you want a differently looking font you can specify
  1620 +# the font name using DOT_FONTNAME. You need to make sure dot is able to find
  1621 +# the font, which can be done by putting it in a standard location or by setting
  1622 +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
  1623 +# directory containing the font.
  1624 +
  1625 +DOT_FONTNAME = Helvetica
  1626 +
  1627 +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
  1628 +# The default size is 10pt.
  1629 +
  1630 +DOT_FONTSIZE = 10
  1631 +
  1632 +# By default doxygen will tell dot to use the Helvetica font.
  1633 +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
  1634 +# set the path where dot can find it.
  1635 +
  1636 +DOT_FONTPATH =
  1637 +
  1638 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1639 +# will generate a graph for each documented class showing the direct and
  1640 +# indirect inheritance relations. Setting this tag to YES will force the
  1641 +# CLASS_DIAGRAMS tag to NO.
  1642 +
  1643 +CLASS_GRAPH = YES
  1644 +
  1645 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1646 +# will generate a graph for each documented class showing the direct and
  1647 +# indirect implementation dependencies (inheritance, containment, and
  1648 +# class references variables) of the class with other documented classes.
  1649 +
  1650 +COLLABORATION_GRAPH = YES
  1651 +
  1652 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  1653 +# will generate a graph for groups, showing the direct groups dependencies
  1654 +
  1655 +GROUP_GRAPHS = YES
  1656 +
  1657 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1658 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
  1659 +# Language.
  1660 +
  1661 +UML_LOOK = NO
  1662 +
  1663 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside
  1664 +# the class node. If there are many fields or methods and many nodes the
  1665 +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
  1666 +# threshold limits the number of items for each type to make the size more
  1667 +# managable. Set this to 0 for no limit. Note that the threshold may be
  1668 +# exceeded by 50% before the limit is enforced.
  1669 +
  1670 +UML_LIMIT_NUM_FIELDS = 10
  1671 +
  1672 +# If set to YES, the inheritance and collaboration graphs will show the
  1673 +# relations between templates and their instances.
  1674 +
  1675 +TEMPLATE_RELATIONS = NO
  1676 +
  1677 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  1678 +# tags are set to YES then doxygen will generate a graph for each documented
  1679 +# file showing the direct and indirect include dependencies of the file with
  1680 +# other documented files.
  1681 +
  1682 +INCLUDE_GRAPH = YES
  1683 +
  1684 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  1685 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  1686 +# documented header file showing the documented files that directly or
  1687 +# indirectly include this file.
  1688 +
  1689 +INCLUDED_BY_GRAPH = YES
  1690 +
  1691 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then
  1692 +# doxygen will generate a call dependency graph for every global function
  1693 +# or class method. Note that enabling this option will significantly increase
  1694 +# the time of a run. So in most cases it will be better to enable call graphs
  1695 +# for selected functions only using the \callgraph command.
  1696 +
  1697 +CALL_GRAPH = NO
  1698 +
  1699 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  1700 +# doxygen will generate a caller dependency graph for every global function
  1701 +# or class method. Note that enabling this option will significantly increase
  1702 +# the time of a run. So in most cases it will be better to enable caller
  1703 +# graphs for selected functions only using the \callergraph command.
  1704 +
  1705 +CALLER_GRAPH = NO
  1706 +
  1707 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  1708 +# will generate a graphical hierarchy of all classes instead of a textual one.
  1709 +
  1710 +GRAPHICAL_HIERARCHY = YES
  1711 +
  1712 +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
  1713 +# then doxygen will show the dependencies a directory has on other directories
  1714 +# in a graphical way. The dependency relations are determined by the #include
  1715 +# relations between the files in the directories.
  1716 +
  1717 +DIRECTORY_GRAPH = YES
  1718 +
  1719 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1720 +# generated by dot. Possible values are svg, png, jpg, or gif.
  1721 +# If left blank png will be used. If you choose svg you need to set
  1722 +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
  1723 +# visible in IE 9+ (other browsers do not have this requirement).
  1724 +
  1725 +DOT_IMAGE_FORMAT = svg
  1726 +
  1727 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1728 +# enable generation of interactive SVG images that allow zooming and panning.
  1729 +# Note that this requires a modern browser other than Internet Explorer.
  1730 +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
  1731 +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
  1732 +# visible. Older versions of IE do not have SVG support.
  1733 +
  1734 +INTERACTIVE_SVG = NO
  1735 +
  1736 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
  1737 +# found. If left blank, it is assumed the dot tool can be found in the path.
  1738 +
  1739 +DOT_PATH =
  1740 +
  1741 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
  1742 +# contain dot files that are included in the documentation (see the
  1743 +# \dotfile command).
  1744 +
  1745 +DOTFILE_DIRS =
  1746 +
  1747 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
  1748 +# contain msc files that are included in the documentation (see the
  1749 +# \mscfile command).
  1750 +
  1751 +MSCFILE_DIRS =
  1752 +
  1753 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  1754 +# nodes that will be shown in the graph. If the number of nodes in a graph
  1755 +# becomes larger than this value, doxygen will truncate the graph, which is
  1756 +# visualized by representing a node as a red box. Note that doxygen if the
  1757 +# number of direct children of the root node in a graph is already larger than
  1758 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  1759 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1760 +
  1761 +DOT_GRAPH_MAX_NODES = 50
  1762 +
  1763 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  1764 +# graphs generated by dot. A depth value of 3 means that only nodes reachable
  1765 +# from the root by following a path via at most 3 edges will be shown. Nodes
  1766 +# that lay further from the root node will be omitted. Note that setting this
  1767 +# option to 1 or 2 may greatly reduce the computation time needed for large
  1768 +# code bases. Also note that the size of a graph can be further restricted by
  1769 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1770 +
  1771 +MAX_DOT_GRAPH_DEPTH = 0
  1772 +
  1773 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1774 +# background. This is disabled by default, because dot on Windows does not
  1775 +# seem to support this out of the box. Warning: Depending on the platform used,
  1776 +# enabling this option may lead to badly anti-aliased labels on the edges of
  1777 +# a graph (i.e. they become hard to read).
  1778 +
  1779 +DOT_TRANSPARENT = NO
  1780 +
  1781 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1782 +# files in one run (i.e. multiple -o and -T options on the command line). This
  1783 +# makes dot run faster, but since only newer versions of dot (>1.8.10)
  1784 +# support this, this feature is disabled by default.
  1785 +
  1786 +DOT_MULTI_TARGETS = NO
  1787 +
  1788 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1789 +# generate a legend page explaining the meaning of the various boxes and
  1790 +# arrows in the dot generated graphs.
  1791 +
  1792 +GENERATE_LEGEND = YES
  1793 +
  1794 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1795 +# remove the intermediate dot files that are used to generate
  1796 +# the various graphs.
  1797 +
  1798 +DOT_CLEANUP = YES
... ...
m4/ax_prog_doxygen.m4 0 → 100644
  1 +# ===========================================================================
  2 +# http://www.gnu.org/software/autoconf-archive/ax_prog_doxygen.html
  3 +# ===========================================================================
  4 +#
  5 +# SYNOPSIS
  6 +#
  7 +# DX_INIT_DOXYGEN(PROJECT-NAME, DOXYFILE-PATH, [OUTPUT-DIR])
  8 +# DX_DOXYGEN_FEATURE(ON|OFF)
  9 +# DX_DOT_FEATURE(ON|OFF)
  10 +# DX_HTML_FEATURE(ON|OFF)
  11 +# DX_CHM_FEATURE(ON|OFF)
  12 +# DX_CHI_FEATURE(ON|OFF)
  13 +# DX_MAN_FEATURE(ON|OFF)
  14 +# DX_RTF_FEATURE(ON|OFF)
  15 +# DX_XML_FEATURE(ON|OFF)
  16 +# DX_PDF_FEATURE(ON|OFF)
  17 +# DX_PS_FEATURE(ON|OFF)
  18 +#
  19 +# DESCRIPTION
  20 +#
  21 +# The DX_*_FEATURE macros control the default setting for the given
  22 +# Doxygen feature. Supported features are 'DOXYGEN' itself, 'DOT' for
  23 +# generating graphics, 'HTML' for plain HTML, 'CHM' for compressed HTML
  24 +# help (for MS users), 'CHI' for generating a seperate .chi file by the
  25 +# .chm file, and 'MAN', 'RTF', 'XML', 'PDF' and 'PS' for the appropriate
  26 +# output formats. The environment variable DOXYGEN_PAPER_SIZE may be
  27 +# specified to override the default 'a4wide' paper size.
  28 +#
  29 +# By default, HTML, PDF and PS documentation is generated as this seems to
  30 +# be the most popular and portable combination. MAN pages created by
  31 +# Doxygen are usually problematic, though by picking an appropriate subset
  32 +# and doing some massaging they might be better than nothing. CHM and RTF
  33 +# are specific for MS (note that you can't generate both HTML and CHM at
  34 +# the same time). The XML is rather useless unless you apply specialized
  35 +# post-processing to it.
  36 +#
  37 +# The macros mainly control the default state of the feature. The use can
  38 +# override the default by specifying --enable or --disable. The macros
  39 +# ensure that contradictory flags are not given (e.g.,
  40 +# --enable-doxygen-html and --enable-doxygen-chm,
  41 +# --enable-doxygen-anything with --disable-doxygen, etc.) Finally, each
  42 +# feature will be automatically disabled (with a warning) if the required
  43 +# programs are missing.
  44 +#
  45 +# Once all the feature defaults have been specified, call DX_INIT_DOXYGEN
  46 +# with the following parameters: a one-word name for the project for use
  47 +# as a filename base etc., an optional configuration file name (the
  48 +# default is 'Doxyfile', the same as Doxygen's default), and an optional
  49 +# output directory name (the default is 'doxygen-doc').
  50 +#
  51 +# Automake Support
  52 +#
  53 +# The following is a template aminclude.am file for use with Automake.
  54 +# Make targets and variables values are controlled by the various
  55 +# DX_COND_* conditionals set by autoconf.
  56 +#
  57 +# The provided targets are:
  58 +#
  59 +# doxygen-doc: Generate all doxygen documentation.
  60 +#
  61 +# doxygen-run: Run doxygen, which will generate some of the
  62 +# documentation (HTML, CHM, CHI, MAN, RTF, XML)
  63 +# but will not do the post processing required
  64 +# for the rest of it (PS, PDF, and some MAN).
  65 +#
  66 +# doxygen-man: Rename some doxygen generated man pages.
  67 +#
  68 +# doxygen-ps: Generate doxygen PostScript documentation.
  69 +#
  70 +# doxygen-pdf: Generate doxygen PDF documentation.
  71 +#
  72 +# Note that by default these are not integrated into the automake targets.
  73 +# If doxygen is used to generate man pages, you can achieve this
  74 +# integration by setting man3_MANS to the list of man pages generated and
  75 +# then adding the dependency:
  76 +#
  77 +# $(man3_MANS): doxygen-doc
  78 +#
  79 +# This will cause make to run doxygen and generate all the documentation.
  80 +#
  81 +# The following variable is intended for use in Makefile.am:
  82 +#
  83 +# DX_CLEANFILES = everything to clean.
  84 +#
  85 +# Then add this variable to MOSTLYCLEANFILES.
  86 +#
  87 +# ----- begin aminclude.am -------------------------------------
  88 +#
  89 +# ## --------------------------------- ##
  90 +# ## Format-independent Doxygen rules. ##
  91 +# ## --------------------------------- ##
  92 +#
  93 +# if DX_COND_doc
  94 +#
  95 +# ## ------------------------------- ##
  96 +# ## Rules specific for HTML output. ##
  97 +# ## ------------------------------- ##
  98 +#
  99 +# if DX_COND_html
  100 +#
  101 +# DX_CLEAN_HTML = @DX_DOCDIR@/html
  102 +#
  103 +# endif DX_COND_html
  104 +#
  105 +# ## ------------------------------ ##
  106 +# ## Rules specific for CHM output. ##
  107 +# ## ------------------------------ ##
  108 +#
  109 +# if DX_COND_chm
  110 +#
  111 +# DX_CLEAN_CHM = @DX_DOCDIR@/chm
  112 +#
  113 +# if DX_COND_chi
  114 +#
  115 +# DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi
  116 +#
  117 +# endif DX_COND_chi
  118 +#
  119 +# endif DX_COND_chm
  120 +#
  121 +# ## ------------------------------ ##
  122 +# ## Rules specific for MAN output. ##
  123 +# ## ------------------------------ ##
  124 +#
  125 +# if DX_COND_man
  126 +#
  127 +# DX_CLEAN_MAN = @DX_DOCDIR@/man
  128 +#
  129 +# endif DX_COND_man
  130 +#
  131 +# ## ------------------------------ ##
  132 +# ## Rules specific for RTF output. ##
  133 +# ## ------------------------------ ##
  134 +#
  135 +# if DX_COND_rtf
  136 +#
  137 +# DX_CLEAN_RTF = @DX_DOCDIR@/rtf
  138 +#
  139 +# endif DX_COND_rtf
  140 +#
  141 +# ## ------------------------------ ##
  142 +# ## Rules specific for XML output. ##
  143 +# ## ------------------------------ ##
  144 +#
  145 +# if DX_COND_xml
  146 +#
  147 +# DX_CLEAN_XML = @DX_DOCDIR@/xml
  148 +#
  149 +# endif DX_COND_xml
  150 +#
  151 +# ## ----------------------------- ##
  152 +# ## Rules specific for PS output. ##
  153 +# ## ----------------------------- ##
  154 +#
  155 +# if DX_COND_ps
  156 +#
  157 +# DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps
  158 +#
  159 +# DX_PS_GOAL = doxygen-ps
  160 +#
  161 +# doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps
  162 +#
  163 +# @DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag
  164 +# cd @DX_DOCDIR@/latex; \
  165 +# rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
  166 +# $(DX_LATEX) refman.tex; \
  167 +# $(MAKEINDEX_PATH) refman.idx; \
  168 +# $(DX_LATEX) refman.tex; \
  169 +# countdown=5; \
  170 +# while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
  171 +# refman.log > /dev/null 2>&1 \
  172 +# && test $$countdown -gt 0; do \
  173 +# $(DX_LATEX) refman.tex; \
  174 +# countdown=`expr $$countdown - 1`; \
  175 +# done; \
  176 +# $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi
  177 +#
  178 +# endif DX_COND_ps
  179 +#
  180 +# ## ------------------------------ ##
  181 +# ## Rules specific for PDF output. ##
  182 +# ## ------------------------------ ##
  183 +#
  184 +# if DX_COND_pdf
  185 +#
  186 +# DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf
  187 +#
  188 +# DX_PDF_GOAL = doxygen-pdf
  189 +#
  190 +# doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf
  191 +#
  192 +# @DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag
  193 +# cd @DX_DOCDIR@/latex; \
  194 +# rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
  195 +# $(DX_PDFLATEX) refman.tex; \
  196 +# $(DX_MAKEINDEX) refman.idx; \
  197 +# $(DX_PDFLATEX) refman.tex; \
  198 +# countdown=5; \
  199 +# while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \
  200 +# refman.log > /dev/null 2>&1 \
  201 +# && test $$countdown -gt 0; do \
  202 +# $(DX_PDFLATEX) refman.tex; \
  203 +# countdown=`expr $$countdown - 1`; \
  204 +# done; \
  205 +# mv refman.pdf ../@PACKAGE@.pdf
  206 +#
  207 +# endif DX_COND_pdf
  208 +#
  209 +# ## ------------------------------------------------- ##
  210 +# ## Rules specific for LaTeX (shared for PS and PDF). ##
  211 +# ## ------------------------------------------------- ##
  212 +#
  213 +# if DX_COND_latex
  214 +#
  215 +# DX_CLEAN_LATEX = @DX_DOCDIR@/latex
  216 +#
  217 +# endif DX_COND_latex
  218 +#
  219 +# .PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
  220 +#
  221 +# .INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
  222 +#
  223 +# doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
  224 +#
  225 +# doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
  226 +#
  227 +# @DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
  228 +# rm -rf @DX_DOCDIR@
  229 +# $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG)
  230 +#
  231 +# DX_CLEANFILES = \
  232 +# @DX_DOCDIR@/@PACKAGE@.tag \
  233 +# -r \
  234 +# $(DX_CLEAN_HTML) \
  235 +# $(DX_CLEAN_CHM) \
  236 +# $(DX_CLEAN_CHI) \
  237 +# $(DX_CLEAN_MAN) \
  238 +# $(DX_CLEAN_RTF) \
  239 +# $(DX_CLEAN_XML) \
  240 +# $(DX_CLEAN_PS) \
  241 +# $(DX_CLEAN_PDF) \
  242 +# $(DX_CLEAN_LATEX)
  243 +#
  244 +# endif DX_COND_doc
  245 +#
  246 +# ----- end aminclude.am ---------------------------------------
  247 +#
  248 +# LICENSE
  249 +#
  250 +# Copyright (c) 2009 Oren Ben-Kiki <oren@ben-kiki.org>
  251 +#
  252 +# Copying and distribution of this file, with or without modification, are
  253 +# permitted in any medium without royalty provided the copyright notice
  254 +# and this notice are preserved. This file is offered as-is, without any
  255 +# warranty.
  256 +
  257 +#serial 11
  258 +
  259 +## ----------##
  260 +## Defaults. ##
  261 +## ----------##
  262 +
  263 +DX_ENV=""
  264 +AC_DEFUN([DX_FEATURE_doc], ON)
  265 +AC_DEFUN([DX_FEATURE_dot], OFF)
  266 +AC_DEFUN([DX_FEATURE_man], OFF)
  267 +AC_DEFUN([DX_FEATURE_html], ON)
  268 +AC_DEFUN([DX_FEATURE_chm], OFF)
  269 +AC_DEFUN([DX_FEATURE_chi], OFF)
  270 +AC_DEFUN([DX_FEATURE_rtf], OFF)
  271 +AC_DEFUN([DX_FEATURE_xml], OFF)
  272 +AC_DEFUN([DX_FEATURE_pdf], ON)
  273 +AC_DEFUN([DX_FEATURE_ps], ON)
  274 +
  275 +## --------------- ##
  276 +## Private macros. ##
  277 +## --------------- ##
  278 +
  279 +# DX_ENV_APPEND(VARIABLE, VALUE)
  280 +# ------------------------------
  281 +# Append VARIABLE="VALUE" to DX_ENV for invoking doxygen.
  282 +AC_DEFUN([DX_ENV_APPEND], [AC_SUBST([DX_ENV], ["$DX_ENV $1='$2'"])])
  283 +
  284 +# DX_DIRNAME_EXPR
  285 +# ---------------
  286 +# Expand into a shell expression prints the directory part of a path.
  287 +AC_DEFUN([DX_DIRNAME_EXPR],
  288 + [[expr ".$1" : '\(\.\)[^/]*$' \| "x$1" : 'x\(.*\)/[^/]*$']])
  289 +
  290 +# DX_IF_FEATURE(FEATURE, IF-ON, IF-OFF)
  291 +# -------------------------------------
  292 +# Expands according to the M4 (static) status of the feature.
  293 +AC_DEFUN([DX_IF_FEATURE], [ifelse(DX_FEATURE_$1, ON, [$2], [$3])])
  294 +
  295 +# DX_REQUIRE_PROG(VARIABLE, PROGRAM)
  296 +# ----------------------------------
  297 +# Require the specified program to be found for the DX_CURRENT_FEATURE to work.
  298 +AC_DEFUN([DX_REQUIRE_PROG], [
  299 +AC_PATH_TOOL([$1], [$2])
  300 +if test "$DX_FLAG_[]DX_CURRENT_FEATURE$$1" = 1; then
  301 + AC_MSG_WARN([$2 not found - will not DX_CURRENT_DESCRIPTION])
  302 + AC_SUBST(DX_FLAG_[]DX_CURRENT_FEATURE, 0)
  303 +fi
  304 +])
  305 +
  306 +# DX_TEST_FEATURE(FEATURE)
  307 +# ------------------------
  308 +# Expand to a shell expression testing whether the feature is active.
  309 +AC_DEFUN([DX_TEST_FEATURE], [test "$DX_FLAG_$1" = 1])
  310 +
  311 +# DX_CHECK_DEPEND(REQUIRED_FEATURE, REQUIRED_STATE)
  312 +# -------------------------------------------------
  313 +# Verify that a required features has the right state before trying to turn on
  314 +# the DX_CURRENT_FEATURE.
  315 +AC_DEFUN([DX_CHECK_DEPEND], [
  316 +test "$DX_FLAG_$1" = "$2" \
  317 +|| AC_MSG_ERROR([doxygen-DX_CURRENT_FEATURE ifelse([$2], 1,
  318 + requires, contradicts) doxygen-DX_CURRENT_FEATURE])
  319 +])
  320 +
  321 +# DX_CLEAR_DEPEND(FEATURE, REQUIRED_FEATURE, REQUIRED_STATE)
  322 +# ----------------------------------------------------------
  323 +# Turn off the DX_CURRENT_FEATURE if the required feature is off.
  324 +AC_DEFUN([DX_CLEAR_DEPEND], [
  325 +test "$DX_FLAG_$1" = "$2" || AC_SUBST(DX_FLAG_[]DX_CURRENT_FEATURE, 0)
  326 +])
  327 +
  328 +# DX_FEATURE_ARG(FEATURE, DESCRIPTION,
  329 +# CHECK_DEPEND, CLEAR_DEPEND,
  330 +# REQUIRE, DO-IF-ON, DO-IF-OFF)
  331 +# --------------------------------------------
  332 +# Parse the command-line option controlling a feature. CHECK_DEPEND is called
  333 +# if the user explicitly turns the feature on (and invokes DX_CHECK_DEPEND),
  334 +# otherwise CLEAR_DEPEND is called to turn off the default state if a required
  335 +# feature is disabled (using DX_CLEAR_DEPEND). REQUIRE performs additional
  336 +# requirement tests (DX_REQUIRE_PROG). Finally, an automake flag is set and
  337 +# DO-IF-ON or DO-IF-OFF are called according to the final state of the feature.
  338 +AC_DEFUN([DX_ARG_ABLE], [
  339 + AC_DEFUN([DX_CURRENT_FEATURE], [$1])
  340 + AC_DEFUN([DX_CURRENT_DESCRIPTION], [$2])
  341 + AC_ARG_ENABLE(doxygen-$1,
  342 + [AS_HELP_STRING(DX_IF_FEATURE([$1], [--disable-doxygen-$1],
  343 + [--enable-doxygen-$1]),
  344 + DX_IF_FEATURE([$1], [don't $2], [$2]))],
  345 + [
  346 +case "$enableval" in
  347 +#(
  348 +y|Y|yes|Yes|YES)
  349 + AC_SUBST([DX_FLAG_$1], 1)
  350 + $3
  351 +;; #(
  352 +n|N|no|No|NO)
  353 + AC_SUBST([DX_FLAG_$1], 0)
  354 +;; #(
  355 +*)
  356 + AC_MSG_ERROR([invalid value '$enableval' given to doxygen-$1])
  357 +;;
  358 +esac
  359 +], [
  360 +AC_SUBST([DX_FLAG_$1], [DX_IF_FEATURE([$1], 1, 0)])
  361 +$4
  362 +])
  363 +if DX_TEST_FEATURE([$1]); then
  364 + $5
  365 + :
  366 +fi
  367 +if DX_TEST_FEATURE([$1]); then
  368 + AM_CONDITIONAL(DX_COND_$1, :)
  369 + $6
  370 + :
  371 +else
  372 + AM_CONDITIONAL(DX_COND_$1, false)
  373 + $7
  374 + :
  375 +fi
  376 +])
  377 +
  378 +## -------------- ##
  379 +## Public macros. ##
  380 +## -------------- ##
  381 +
  382 +# DX_XXX_FEATURE(DEFAULT_STATE)
  383 +# -----------------------------
  384 +AC_DEFUN([DX_DOXYGEN_FEATURE], [AC_DEFUN([DX_FEATURE_doc], [$1])])
  385 +AC_DEFUN([DX_DOT_FEATURE], [AC_DEFUN([DX_FEATURE_dot], [$1])])
  386 +AC_DEFUN([DX_MAN_FEATURE], [AC_DEFUN([DX_FEATURE_man], [$1])])
  387 +AC_DEFUN([DX_HTML_FEATURE], [AC_DEFUN([DX_FEATURE_html], [$1])])
  388 +AC_DEFUN([DX_CHM_FEATURE], [AC_DEFUN([DX_FEATURE_chm], [$1])])
  389 +AC_DEFUN([DX_CHI_FEATURE], [AC_DEFUN([DX_FEATURE_chi], [$1])])
  390 +AC_DEFUN([DX_RTF_FEATURE], [AC_DEFUN([DX_FEATURE_rtf], [$1])])
  391 +AC_DEFUN([DX_XML_FEATURE], [AC_DEFUN([DX_FEATURE_xml], [$1])])
  392 +AC_DEFUN([DX_XML_FEATURE], [AC_DEFUN([DX_FEATURE_xml], [$1])])
  393 +AC_DEFUN([DX_PDF_FEATURE], [AC_DEFUN([DX_FEATURE_pdf], [$1])])
  394 +AC_DEFUN([DX_PS_FEATURE], [AC_DEFUN([DX_FEATURE_ps], [$1])])
  395 +
  396 +# DX_INIT_DOXYGEN(PROJECT, [CONFIG-FILE], [OUTPUT-DOC-DIR])
  397 +# ---------------------------------------------------------
  398 +# PROJECT also serves as the base name for the documentation files.
  399 +# The default CONFIG-FILE is "Doxyfile" and OUTPUT-DOC-DIR is "doxygen-doc".
  400 +AC_DEFUN([DX_INIT_DOXYGEN], [
  401 +
  402 +# Files:
  403 +AC_SUBST([DX_PROJECT], [$1])
  404 +AC_SUBST([DX_CONFIG], [ifelse([$2], [], Doxyfile, [$2])])
  405 +AC_SUBST([DX_DOCDIR], [ifelse([$3], [], doxygen-doc, [$3])])
  406 +
  407 +# Environment variables used inside doxygen.cfg:
  408 +DX_ENV_APPEND(SRCDIR, $srcdir)
  409 +DX_ENV_APPEND(PROJECT, $DX_PROJECT)
  410 +DX_ENV_APPEND(DOCDIR, $DX_DOCDIR)
  411 +DX_ENV_APPEND(VERSION, $PACKAGE_VERSION)
  412 +
  413 +# Doxygen itself:
  414 +DX_ARG_ABLE(doc, [generate any doxygen documentation],
  415 + [],
  416 + [],
  417 + [DX_REQUIRE_PROG([DX_DOXYGEN], doxygen)
  418 + DX_REQUIRE_PROG([DX_PERL], perl)],
  419 + [DX_ENV_APPEND(PERL_PATH, $DX_PERL)])
  420 +
  421 +# Dot for graphics:
  422 +DX_ARG_ABLE(dot, [generate graphics for doxygen documentation],
  423 + [DX_CHECK_DEPEND(doc, 1)],
  424 + [DX_CLEAR_DEPEND(doc, 1)],
  425 + [DX_REQUIRE_PROG([DX_DOT], dot)],
  426 + [DX_ENV_APPEND(HAVE_DOT, YES)
  427 + DX_ENV_APPEND(DOT_PATH, [`DX_DIRNAME_EXPR($DX_DOT)`])],
  428 + [DX_ENV_APPEND(HAVE_DOT, NO)])
  429 +
  430 +# Man pages generation:
  431 +DX_ARG_ABLE(man, [generate doxygen manual pages],
  432 + [DX_CHECK_DEPEND(doc, 1)],
  433 + [DX_CLEAR_DEPEND(doc, 1)],
  434 + [],
  435 + [DX_ENV_APPEND(GENERATE_MAN, YES)],
  436 + [DX_ENV_APPEND(GENERATE_MAN, NO)])
  437 +
  438 +# RTF file generation:
  439 +DX_ARG_ABLE(rtf, [generate doxygen RTF documentation],
  440 + [DX_CHECK_DEPEND(doc, 1)],
  441 + [DX_CLEAR_DEPEND(doc, 1)],
  442 + [],
  443 + [DX_ENV_APPEND(GENERATE_RTF, YES)],
  444 + [DX_ENV_APPEND(GENERATE_RTF, NO)])
  445 +
  446 +# XML file generation:
  447 +DX_ARG_ABLE(xml, [generate doxygen XML documentation],
  448 + [DX_CHECK_DEPEND(doc, 1)],
  449 + [DX_CLEAR_DEPEND(doc, 1)],
  450 + [],
  451 + [DX_ENV_APPEND(GENERATE_XML, YES)],
  452 + [DX_ENV_APPEND(GENERATE_XML, NO)])
  453 +
  454 +# (Compressed) HTML help generation:
  455 +DX_ARG_ABLE(chm, [generate doxygen compressed HTML help documentation],
  456 + [DX_CHECK_DEPEND(doc, 1)],
  457 + [DX_CLEAR_DEPEND(doc, 1)],
  458 + [DX_REQUIRE_PROG([DX_HHC], hhc)],
  459 + [DX_ENV_APPEND(HHC_PATH, $DX_HHC)
  460 + DX_ENV_APPEND(GENERATE_HTML, YES)
  461 + DX_ENV_APPEND(GENERATE_HTMLHELP, YES)],
  462 + [DX_ENV_APPEND(GENERATE_HTMLHELP, NO)])
  463 +
  464 +# Seperate CHI file generation.
  465 +DX_ARG_ABLE(chi, [generate doxygen seperate compressed HTML help index file],
  466 + [DX_CHECK_DEPEND(chm, 1)],
  467 + [DX_CLEAR_DEPEND(chm, 1)],
  468 + [],
  469 + [DX_ENV_APPEND(GENERATE_CHI, YES)],
  470 + [DX_ENV_APPEND(GENERATE_CHI, NO)])
  471 +
  472 +# Plain HTML pages generation:
  473 +DX_ARG_ABLE(html, [generate doxygen plain HTML documentation],
  474 + [DX_CHECK_DEPEND(doc, 1) DX_CHECK_DEPEND(chm, 0)],
  475 + [DX_CLEAR_DEPEND(doc, 1) DX_CLEAR_DEPEND(chm, 0)],
  476 + [],
  477 + [DX_ENV_APPEND(GENERATE_HTML, YES)],
  478 + [DX_TEST_FEATURE(chm) || DX_ENV_APPEND(GENERATE_HTML, NO)])
  479 +
  480 +# PostScript file generation:
  481 +DX_ARG_ABLE(ps, [generate doxygen PostScript documentation],
  482 + [DX_CHECK_DEPEND(doc, 1)],
  483 + [DX_CLEAR_DEPEND(doc, 1)],
  484 + [DX_REQUIRE_PROG([DX_LATEX], latex)
  485 + DX_REQUIRE_PROG([DX_MAKEINDEX], makeindex)
  486 + DX_REQUIRE_PROG([DX_DVIPS], dvips)
  487 + DX_REQUIRE_PROG([DX_EGREP], egrep)])
  488 +
  489 +# PDF file generation:
  490 +DX_ARG_ABLE(pdf, [generate doxygen PDF documentation],
  491 + [DX_CHECK_DEPEND(doc, 1)],
  492 + [DX_CLEAR_DEPEND(doc, 1)],
  493 + [DX_REQUIRE_PROG([DX_PDFLATEX], pdflatex)
  494 + DX_REQUIRE_PROG([DX_MAKEINDEX], makeindex)
  495 + DX_REQUIRE_PROG([DX_EGREP], egrep)])
  496 +
  497 +# LaTeX generation for PS and/or PDF:
  498 +if DX_TEST_FEATURE(ps) || DX_TEST_FEATURE(pdf); then
  499 + AM_CONDITIONAL(DX_COND_latex, :)
  500 + DX_ENV_APPEND(GENERATE_LATEX, YES)
  501 +else
  502 + AM_CONDITIONAL(DX_COND_latex, false)
  503 + DX_ENV_APPEND(GENERATE_LATEX, NO)
  504 +fi
  505 +
  506 +# Paper size for PS and/or PDF:
  507 +AC_ARG_VAR(DOXYGEN_PAPER_SIZE,
  508 + [a4wide (default), a4, letter, legal or executive])
  509 +case "$DOXYGEN_PAPER_SIZE" in
  510 +#(
  511 +"")
  512 + AC_SUBST(DOXYGEN_PAPER_SIZE, "")
  513 +;; #(
  514 +a4wide|a4|letter|legal|executive)
  515 + DX_ENV_APPEND(PAPER_SIZE, $DOXYGEN_PAPER_SIZE)
  516 +;; #(
  517 +*)
  518 + AC_MSG_ERROR([unknown DOXYGEN_PAPER_SIZE='$DOXYGEN_PAPER_SIZE'])
  519 +;;
  520 +esac
  521 +
  522 +# For debugging:
  523 +#echo DX_FLAG_doc=$DX_FLAG_doc
  524 +#echo DX_FLAG_dot=$DX_FLAG_dot
  525 +#echo DX_FLAG_man=$DX_FLAG_man
  526 +#echo DX_FLAG_html=$DX_FLAG_html
  527 +#echo DX_FLAG_chm=$DX_FLAG_chm
  528 +#echo DX_FLAG_chi=$DX_FLAG_chi
  529 +#echo DX_FLAG_rtf=$DX_FLAG_rtf
  530 +#echo DX_FLAG_xml=$DX_FLAG_xml
  531 +#echo DX_FLAG_pdf=$DX_FLAG_pdf
  532 +#echo DX_FLAG_ps=$DX_FLAG_ps
  533 +#echo DX_ENV=$DX_ENV
  534 +
  535 +# Conditionals kluge for old automake versions
  536 +if test "x$DX_FLAG_doc" = "x1"; then
  537 + AM_CONDITIONAL(DX_COND_doc, test "x$DX_FLAG_doc" = "x1")
  538 + AM_CONDITIONAL(DX_COND_html, test "x$DX_FLAG_html" = "x1")
  539 + AM_CONDITIONAL(DX_COND_chm, test "x$DX_FLAG_chm" = "x1")
  540 + AM_CONDITIONAL(DX_COND_chi, test "x$DX_FLAG_chi" = "x1")
  541 + AM_CONDITIONAL(DX_COND_man, test "x$DX_FLAG_man" = "x1")
  542 + AM_CONDITIONAL(DX_COND_rtf, test "x$DX_FLAG_rtf" = "x1")
  543 + AM_CONDITIONAL(DX_COND_xml, test "x$DX_FLAG_xml" = "x1")
  544 + AM_CONDITIONAL(DX_COND_ps, test "x$DX_FLAG_ps" = "x1")
  545 + AM_CONDITIONAL(DX_COND_pdf, test "x$DX_FLAG_pdf" = "x1")
  546 +fi
  547 +])
  548 +
... ...
src/ctbin/main.cpp
... ... @@ -19,7 +19,7 @@
19 19 * *
20 20 ***************************************************************************/
21 21 /**
22   - * @file main.cpp
  22 + * @file ctbin/main.cpp
23 23 * @brief CTA data binning tool main code
24 24 * @author J. Knodlseder
25 25 */
... ...
src/ctlike/main.cpp
... ... @@ -19,7 +19,7 @@
19 19 * *
20 20 ***************************************************************************/
21 21 /**
22   - * @file main.cpp
  22 + * @file ctlike/main.cpp
23 23 * @brief CTA maximum likelihood tool main code
24 24 * @author J. Knodlseder
25 25 */
... ...
src/ctmodel/main.cpp
... ... @@ -19,7 +19,7 @@
19 19 * *
20 20 ***************************************************************************/
21 21 /**
22   - * @file main.cpp
  22 + * @file ctmodel/main.cpp
23 23 * @brief CTA counts model tool main code
24 24 * @author Juergen Knoedlseder
25 25 */
... ...
src/ctobssim/ctobssim.cpp
... ... @@ -594,7 +594,7 @@ void ctobssim::set_list(GCTAObservation* obs)
594 594 * @brief Simulate source events from photon list
595 595 *
596 596 * @param[in] obs Pointer on CTA observation.
597   - * @param[in] photons Photon list.
  597 + * @param[in] models Model list.
598 598 * @param[in] ran Random number generator.
599 599 * @param[in] wrklog Pointer to logger.
600 600 *
... ...
src/ctobssim/main.cpp
1 1 /***************************************************************************
2 2 * ctobssim - CTA observation simulator tool main code *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2011-2012 by Juergen Knoedlseder *
  4 + * copyright (C) 2011-2013 by Juergen Knoedlseder *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -19,9 +19,9 @@
19 19 * *
20 20 ***************************************************************************/
21 21 /**
22   - * @file ctobssim.cpp
  22 + * @file ctobssim/main.cpp
23 23 * @brief CTA observation simulator tool main code
24   - * @author J. Knoedlseder
  24 + * @author Juergen Knoedlseder
25 25 */
26 26  
27 27 /* __ Includes ___________________________________________________________ */
... ...
src/ctselect/main.cpp
1 1 /***************************************************************************
2 2 * ctselect - CTA data selection tool main code *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2010-2011 by Jurgen Knodlseder *
  4 + * copyright (C) 2010-2013 by Juergen Knoedlseder *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -19,9 +19,9 @@
19 19 * *
20 20 ***************************************************************************/
21 21 /**
22   - * @file ctselect.cpp
  22 + * @file ctselect/main.cpp
23 23 * @brief CTA data selection tool main code
24   - * @author J. Knodlseder
  24 + * @author Juergen Knoedlseder
25 25 */
26 26  
27 27 /* __ Includes ___________________________________________________________ */
... ...
src/ctskymap/main.cpp
1 1 /***************************************************************************
2 2 * ctskymap - CTA sky mapping main code *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2010-2011 by Jurgen Knodlseder *
  4 + * copyright (C) 2010-2013 by Juergen Knoedlseder *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -19,9 +19,9 @@
19 19 * *
20 20 ***************************************************************************/
21 21 /**
22   - * @file main.cpp
  22 + * @file ctskymap/main.cpp
23 23 * @brief CTA sky mapping tool main code
24   - * @author J. Knodlseder
  24 + * @author Juergen Knoedlseder
25 25 */
26 26  
27 27 /* __ Includes ___________________________________________________________ */
... ...