Changeset View
Changeset View
Standalone View
Standalone View
doc/Doxyfile.in
- This file was moved from Doxyfile.
Show All 26 Lines | |||||
DOXYFILE_ENCODING = UTF-8 | DOXYFILE_ENCODING = UTF-8 | ||||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by | ||||
# double-quotes, unless you are using Doxywizard) that should identify the | # double-quotes, unless you are using Doxywizard) that should identify the | ||||
# project for which the documentation is generated. This name is used in the | # project for which the documentation is generated. This name is used in the | ||||
# title of most generated pages and in a few other places. | # title of most generated pages and in a few other places. | ||||
# The default value is: My Project. | # The default value is: My Project. | ||||
PROJECT_NAME = Laura++ | PROJECT_NAME = "@PROJECT_NAME@" | ||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This | ||||
# could be handy for archiving the generated documentation or if some version | # could be handy for archiving the generated documentation or if some version | ||||
# control system is used. | # control system is used. | ||||
PROJECT_NUMBER = v3r5 | PROJECT_NUMBER = "@PROJECT_VERSION@" | ||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description | # Using the PROJECT_BRIEF tag one can provide an optional one line description | ||||
# for a project that appears at the top of each page and should give viewer a | # for a project that appears at the top of each page and should give viewer a | ||||
# quick idea about the purpose of the project. Keep the description short. | # quick idea about the purpose of the project. Keep the description short. | ||||
PROJECT_BRIEF = "A maximum likelihood fitting package for performing Dalitz-plot analysis." | PROJECT_BRIEF = "@PROJECT_DESCRIPTION@" | ||||
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included | ||||
# in the documentation. The maximum height of the logo should not exceed 55 | # in the documentation. The maximum height of the logo should not exceed 55 | ||||
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy | ||||
# the logo to the output directory. | # the logo to the output directory. | ||||
PROJECT_LOGO = | PROJECT_LOGO = | ||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path | ||||
# into which the generated documentation will be written. If a relative path is | # into which the generated documentation will be written. If a relative path is | ||||
# entered, it will be relative to the location where doxygen was started. If | # entered, it will be relative to the location where doxygen was started. If | ||||
# left blank the current directory will be used. | # left blank the current directory will be used. | ||||
OUTPUT_DIRECTORY = doxygen | OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@" | ||||
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- | ||||
# directories (in 2 levels) under the output directory of each output format and | # directories (in 2 levels) under the output directory of each output format and | ||||
# will distribute the generated files over these directories. Enabling this | # will distribute the generated files over these directories. Enabling this | ||||
# option can be useful when feeding doxygen a huge amount of source files, where | # option can be useful when feeding doxygen a huge amount of source files, where | ||||
# putting all generated files in the same directory would otherwise causes | # putting all generated files in the same directory would otherwise causes | ||||
# performance problems for the file system. | # performance problems for the file system. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
▲ Show 20 Lines • Show All 86 Lines • ▼ Show 20 Lines | |||||
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the | ||||
# path mentioned in the documentation of a class, which tells the reader which | # path mentioned in the documentation of a class, which tells the reader which | ||||
# header file to include in order to use a class. If left blank only the name of | # header file to include in order to use a class. If left blank only the name of | ||||
# the header file containing the class definition is used. Otherwise one should | # the header file containing the class definition is used. Otherwise one should | ||||
# specify the list of include paths that are normally passed to the compiler | # specify the list of include paths that are normally passed to the compiler | ||||
# using the -I flag. | # using the -I flag. | ||||
STRIP_FROM_INC_PATH = | STRIP_FROM_INC_PATH = "@PROJECT_SOURCE_DIR@/inc" | ||||
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but | ||||
# less readable) file names. This can be useful is your file systems doesn't | # less readable) file names. This can be useful is your file systems doesn't | ||||
# support long names like on DOS, Mac, or CD-ROM. | # support long names like on DOS, Mac, or CD-ROM. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
SHORT_NAMES = NO | SHORT_NAMES = NO | ||||
▲ Show 20 Lines • Show All 602 Lines • ▼ Show 20 Lines | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# The INPUT tag is used to specify the files and/or directories that contain | # The INPUT tag is used to specify the files and/or directories that contain | ||||
# documented source files. You may enter file names like myfile.cpp or | # documented source files. You may enter file names like myfile.cpp or | ||||
# directories like /usr/src/myproject. Separate the files or directories with | # directories like /usr/src/myproject. Separate the files or directories with | ||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING | ||||
# Note: If this tag is empty the current directory is searched. | # Note: If this tag is empty the current directory is searched. | ||||
INPUT = inc \ | INPUT = "@PROJECT_SOURCE_DIR@/inc" \ | ||||
src \ | "@PROJECT_SOURCE_DIR@/src" \ | ||||
doc/mainpage.dox | "@PROJECT_SOURCE_DIR@/README.md" \ | ||||
"@PROJECT_SOURCE_DIR@/doc/ReleaseNotes.md" \ | |||||
"@PROJECT_BINARY_DIR@/doc/mainpage.dox" | |||||
# This tag can be used to specify the character encoding of the source files | # This tag can be used to specify the character encoding of the source files | ||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | ||||
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | ||||
# documentation (see: http://www.gnu.org/software/libiconv) for the list of | # documentation (see: http://www.gnu.org/software/libiconv) for the list of | ||||
# possible encodings. | # possible encodings. | ||||
# The default value is: UTF-8. | # The default value is: UTF-8. | ||||
INPUT_ENCODING = UTF-8 | INPUT_ENCODING = UTF-8 | ||||
# If the value of the INPUT tag contains directories, you can use the | # If the value of the INPUT tag contains directories, you can use the | ||||
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | ||||
# *.h) to filter out the source-files in the directories. | # *.h) to filter out the source-files in the directories. | ||||
# | # | ||||
# Note that for custom extensions or not directly supported extensions you also | # Note that for custom extensions or not directly supported extensions you also | ||||
# need to set EXTENSION_MAPPING for the extension otherwise the files are not | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | ||||
# read by doxygen. | # read by doxygen. | ||||
# | # | ||||
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | ||||
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | ||||
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | ||||
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | ||||
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. | ||||
FILE_PATTERNS = | FILE_PATTERNS = *.cc *.hh | ||||
# The RECURSIVE tag can be used to specify whether or not subdirectories should | # The RECURSIVE tag can be used to specify whether or not subdirectories should | ||||
# be searched for input files as well. | # be searched for input files as well. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
RECURSIVE = YES | RECURSIVE = NO | ||||
# The EXCLUDE tag can be used to specify files and/or directories that should be | # The EXCLUDE tag can be used to specify files and/or directories that should be | ||||
# excluded from the INPUT source files. This way you can easily exclude a | # excluded from the INPUT source files. This way you can easily exclude a | ||||
# subdirectory from a directory tree whose root is specified with the INPUT tag. | # subdirectory from a directory tree whose root is specified with the INPUT tag. | ||||
# | # | ||||
# Note that relative paths are relative to the directory from which doxygen is | # Note that relative paths are relative to the directory from which doxygen is | ||||
# run. | # run. | ||||
▲ Show 20 Lines • Show All 198 Lines • ▼ Show 20 Lines | |||||
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the | ||||
# cost of reduced performance. This can be particularly helpful with template | # cost of reduced performance. This can be particularly helpful with template | ||||
# rich C++ code for which doxygen's built-in parser lacks the necessary type | # rich C++ code for which doxygen's built-in parser lacks the necessary type | ||||
# information. | # information. | ||||
# Note: The availability of this option depends on whether or not doxygen was | # Note: The availability of this option depends on whether or not doxygen was | ||||
# generated with the -Duse-libclang=ON option for CMake. | # generated with the -Duse-libclang=ON option for CMake. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
CLANG_ASSISTED_PARSING = NO | #CLANG_ASSISTED_PARSING = NO | ||||
# If clang assisted parsing is enabled you can provide the compiler with command | # If clang assisted parsing is enabled you can provide the compiler with command | ||||
# line options that you would normally use when invoking the compiler. Note that | # line options that you would normally use when invoking the compiler. Note that | ||||
# the include paths will already be set by doxygen for the files and directories | # the include paths will already be set by doxygen for the files and directories | ||||
# specified with INPUT and INCLUDE_PATH. | # specified with INPUT and INCLUDE_PATH. | ||||
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||||
CLANG_OPTIONS = | #CLANG_OPTIONS = | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# Configuration options related to the alphabetical class index | # Configuration options related to the alphabetical class index | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all | ||||
# compounds will be generated. Enable this if the project contains a lot of | # compounds will be generated. Enable this if the project contains a lot of | ||||
# classes, structs, unions or interfaces. | # classes, structs, unions or interfaces. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
ALPHABETICAL_INDEX = NO | ALPHABETICAL_INDEX = YES | ||||
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in | ||||
# which the alphabetical index list will be split. | # which the alphabetical index list will be split. | ||||
# Minimum value: 1, maximum value: 20, default value: 5. | # Minimum value: 1, maximum value: 20, default value: 5. | ||||
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||||
COLS_IN_ALPHA_INDEX = 5 | COLS_IN_ALPHA_INDEX = 5 | ||||
▲ Show 20 Lines • Show All 477 Lines • ▼ Show 20 Lines | |||||
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel | # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel | ||||
# the search. The filter options can be selected when the cursor is inside the | # the search. The filter options can be selected when the cursor is inside the | ||||
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> | # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> | ||||
# to select a filter and <Enter> or <escape> to activate or cancel the filter | # to select a filter and <Enter> or <escape> to activate or cancel the filter | ||||
# option. | # option. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
# This tag requires that the tag GENERATE_HTML is set to YES. | # This tag requires that the tag GENERATE_HTML is set to YES. | ||||
SEARCHENGINE = NO | SEARCHENGINE = YES | ||||
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | ||||
# implemented using a web server instead of a web client using Javascript. There | # implemented using a web server instead of a web client using Javascript. There | ||||
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH | ||||
# setting. When disabled, doxygen will generate a PHP script for searching and | # setting. When disabled, doxygen will generate a PHP script for searching and | ||||
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing | ||||
# and searching needs to be provided by external tools. See the section | # and searching needs to be provided by external tools. See the section | ||||
# "External Indexing and Searching" for details. | # "External Indexing and Searching" for details. | ||||
▲ Show 20 Lines • Show All 57 Lines • ▼ Show 20 Lines | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# Configuration options related to the LaTeX output | # Configuration options related to the LaTeX output | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. | # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
GENERATE_LATEX = YES | GENERATE_LATEX = NO | ||||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a | ||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of | ||||
# it. | # it. | ||||
# The default directory is: latex. | # The default directory is: latex. | ||||
# This tag requires that the tag GENERATE_LATEX is set to YES. | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||||
LATEX_OUTPUT = latex | LATEX_OUTPUT = latex | ||||
▲ Show 20 Lines • Show All 398 Lines • ▼ Show 20 Lines | |||||
SEARCH_INCLUDES = YES | SEARCH_INCLUDES = YES | ||||
# The INCLUDE_PATH tag can be used to specify one or more directories that | # The INCLUDE_PATH tag can be used to specify one or more directories that | ||||
# contain include files that are not input files but should be processed by the | # contain include files that are not input files but should be processed by the | ||||
# preprocessor. | # preprocessor. | ||||
# This tag requires that the tag SEARCH_INCLUDES is set to YES. | # This tag requires that the tag SEARCH_INCLUDES is set to YES. | ||||
INCLUDE_PATH = inc | INCLUDE_PATH = | ||||
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | ||||
# patterns (like *.h and *.hpp) to filter out the header-files in the | # patterns (like *.h and *.hpp) to filter out the header-files in the | ||||
# directories. If left blank, the patterns specified with FILE_PATTERNS will be | # directories. If left blank, the patterns specified with FILE_PATTERNS will be | ||||
# used. | # used. | ||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. | ||||
INCLUDE_FILE_PATTERNS = | INCLUDE_FILE_PATTERNS = | ||||
▲ Show 20 Lines • Show All 68 Lines • ▼ Show 20 Lines | |||||
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in | # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in | ||||
# the related pages index. If set to NO, only the current project's pages will | # the related pages index. If set to NO, only the current project's pages will | ||||
# be listed. | # be listed. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
EXTERNAL_PAGES = YES | EXTERNAL_PAGES = YES | ||||
# The PERL_PATH should be the absolute path and name of the perl script | |||||
# interpreter (i.e. the result of 'which perl'). | |||||
# The default file (with absolute path) is: /usr/bin/perl. | |||||
PERL_PATH = /usr/bin/perl | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# Configuration options related to the dot tool | # Configuration options related to the dot tool | ||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram | ||||
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | ||||
# NO turns the diagrams off. Note that this option also works with HAVE_DOT | # NO turns the diagrams off. Note that this option also works with HAVE_DOT | ||||
# disabled, but it is recommended to install and use dot, since it yields more | # disabled, but it is recommended to install and use dot, since it yields more | ||||
# powerful graphs. | # powerful graphs. | ||||
# The default value is: YES. | # The default value is: YES. | ||||
CLASS_DIAGRAMS = YES | CLASS_DIAGRAMS = YES | ||||
# You can define message sequence charts within doxygen comments using the \msc | |||||
# command. Doxygen will then run the mscgen tool (see: | |||||
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the | |||||
# documentation. The MSCGEN_PATH tag allows you to specify the directory where | |||||
# the mscgen tool resides. If left empty the tool is assumed to be found in the | |||||
# default search path. | |||||
MSCGEN_PATH = | |||||
# You can include diagrams made with dia in doxygen documentation. Doxygen will | # You can include diagrams made with dia in doxygen documentation. Doxygen will | ||||
# then run dia to produce the diagram and insert it in the documentation. The | # then run dia to produce the diagram and insert it in the documentation. The | ||||
# DIA_PATH tag allows you to specify the directory where the dia binary resides. | # DIA_PATH tag allows you to specify the directory where the dia binary resides. | ||||
# If left empty dia is assumed to be found in the default search path. | # If left empty dia is assumed to be found in the default search path. | ||||
DIA_PATH = | DIA_PATH = | ||||
# If set to YES the inheritance and collaboration graphs will hide inheritance | # If set to YES the inheritance and collaboration graphs will hide inheritance | ||||
▲ Show 20 Lines • Show All 255 Lines • ▼ Show 20 Lines | |||||
# to support this out of the box. | # to support this out of the box. | ||||
# | # | ||||
# Warning: Depending on the platform used, enabling this option may lead to | # Warning: Depending on the platform used, enabling this option may lead to | ||||
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | ||||
# read). | # read). | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | # This tag requires that the tag HAVE_DOT is set to YES. | ||||
DOT_TRANSPARENT = YES | DOT_TRANSPARENT = NO | ||||
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | ||||
# files in one run (i.e. multiple -o and -T options on the command line). This | # files in one run (i.e. multiple -o and -T options on the command line). This | ||||
# makes dot run faster, but since only newer versions of dot (>1.8.10) support | # makes dot run faster, but since only newer versions of dot (>1.8.10) support | ||||
# this, this feature is disabled by default. | # this, this feature is disabled by default. | ||||
# The default value is: NO. | # The default value is: NO. | ||||
# This tag requires that the tag HAVE_DOT is set to YES. | # This tag requires that the tag HAVE_DOT is set to YES. | ||||
Show All 16 Lines |