Doxyfile.cmake   Doxyfile.cmake
# Doxyfile 1.8. # Doxyfile 1.8.6
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project. # doxygen (www.doxygen.org) for a project.
# #
# All text after a hash (#) is considered a comment and will be # All text after a double hash (##) is considered a comment and is placed i
n
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be igno
red.
# The format is: # The format is:
# TAG = value [value, ...] # TAG = value [value, ...]
# For items can also be appended using: # For lists, items can also be appended using:
# TAG += value [value, ...] # TAG += value [value, ...]
# Values that contain spaces should be placed between quotes # Values that contain spaces should be placed between quotes (\" \").
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# Project related configuration options # Project related configuration options
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# This tag specifies the encoding used for all characters in the config fil e # This tag specifies the encoding used for all characters in the config fil e
# that follow. The default is UTF-8 which is also the encoding used for all # that follow. The default is UTF-8 which is also the encoding used for all
text before the first occurrence of this tag. Doxygen uses libiconv (or text
# before the first occurrence of this tag. Doxygen uses libiconv (or the ic
# built into libc) for the transcoding. See onv
# for the list of possible encodings. # built into libc) for the transcoding. See http://www.gnu.org/software/lib
iconv
# for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8 DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or sequence of that should # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
identify the by
# project name # double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in th
e
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = Stellarium PROJECT_NAME = Stellarium
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
This could be handy for archiving the generated documentation or This
if some control system is used. # could be handy for archiving the generated documentation or if some versi
on
# control system is used.
PROJECT_NUMBER = @VERSION@ PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line descript ion # Using the PROJECT_BRIEF tag one can provide an optional one line descript ion
# for a project that appears at the top of each page and should give viewer # 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 a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify an logo or icon that is # With the PROJECT_LOGO tag one can specify an logo or icon that is include
in the documentation. The maximum height of the logo should not d in
exceed 55 and the maximum width should not exceed 200 pixels. # the documentation. The maximum height of the logo should not exceed 55 pi
Doxygen will copy the logo to the output directory. xels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the
logo
# to the output directory.
PROJECT_LOGO = @PROJECT_SOURCE_DIR@/doc/images/stellarium-logo.pn g PROJECT_LOGO = @PROJECT_SOURCE_DIR@/doc/images/stellarium-logo.pn g
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) pa
# the generated documentation will be th
If a relative is entered, it will be relative to the location # into which the generated documentation will be written. If a relative pat
where doxygen was started. left blank the current directory will be h is
# entered, it will be relative to the location where doxygen was started. I
f
# left blank the current directory will be used.
OUTPUT_DIRECTORY = doc OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 su
4096 (in 2 levels) under the output directory of each b-
# directories (in 2 levels) under the output directory of each output forma
and will distribute the generated files over these directories. t and
Enabling this option can be useful when feeding doxygen a huge amount of # will distribute the generated files over these directories. Enabling this
source files, where putting all generated files in the same directory # option can be useful when feeding doxygen a huge amount of source files,
where
otherwise performance problems for the file system. # putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all # The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this # documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language. # information to generate all constant output in the proper language.
# are: # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chi
Afrikaans, Arabic, Brazilian, Catalan, nese,
# Croatian, Czech, Danish, Dutch, Esperanto, Finnish, French, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United Stat
es),
Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Korean, Lithuanian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English message
# Polish, Portuguese, Romanian, Serbian, Serbian-Cyrillic, Slovak, s),
Slovene, Spanish, Swedish, and Vietnamese. # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Rus
sian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES will # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief mem
include brief descriptions after the members that are listed in ber
the file and class documentation (similar to # descriptions after the members that are listed in the file and class
Set to NO to disable this. # documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES will prepend # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
the brief description of a member or function before the detailed # description of a member or function before the detailed description
#
# Note: both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed. # brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator # This tag implements a quasi-intelligent brief description abbreviator tha
is used to form the text in various listings. Each string t is
in this list, if as the leading text of the brief description, will # used to form the text in various listings. Each string in this list, if f
be ound
stripped from the and the after processing the whole list, is # as the leading text of the brief description, will be stripped from the t
used as the annotated text. Otherwise, the brief description is used ext
# and the result, after processing the whole list, is used as the annotated
If left blank, the following values are used is automatically # text. Otherwise, the brief description is used as-is. If left blank, the
replaced with the name of the $name$name # following values are used ($name is automatically replaced with the name of$name # the entity):The $name class, The$name widget, The $name file, is, provid es, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The$name class" \ ABBREVIATE_BRIEF = "The $name class" \ "The$name widget" \ "The $name widget" \ "The$name file" \ "The $name file" \ is \ is \ provides \ provides \ specifies \ specifies \ contains \ contains \ represents \ represents \ a \ a \ an \ an \ the the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # oxygen will generate a detailed section even if there is only a brief # doxygen will generate a detailed section even if there is only a brief # description. # description. # The default value is: NO. ALWAYS_DETAILED_SEC = YES ALWAYS_DETAILED_SEC = YES # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if tho se # inherited members of a class in the documentation of that class as if tho se # members were ordinary class members. Constructors, destructors and assign ment # members were ordinary class members. Constructors, destructors and assign ment # operators of the base classes will not be shown. # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES will prepend the # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full pa th # before files name in the file list and in the header files. If set # before files name in the file list and in the header files. If set to NO to NO the shortest path that makes the file name unique will be the # shortest path that makes the file name unique will be used FULL_PATH_NAMES = # The default value is: YES. # STRIP_FROM_PATH tag FULL_PATH_NAMES = NO can be used to strip a user-defined part of the Stripping is only done if one of the specified strings matches the part of # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the p the path. The tag can be used to show relative paths in the file list. ath. # If left blank the directory from which doxygen is run is used as the # Stripping is only done if one of the specified strings matches the left-h path to strip. and # part of the path. The tag can be used to show relative paths in the file STRIP_FROM_PATH = list. # If left blank the directory from which doxygen is run is used as the path # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of to # path mentioned in the documentation of a class, which tells # strip. the reader header file to include in order to use a class. # If left blank only the of the header file containing the class # Note that you can specify absolute paths here, but also relative paths, w definition is used. Otherwise one specify the include paths that hich are normally passed to the using the -I flag. # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of t he # path mentioned in the documentation of a class, which tells the reader wh ich # header file to include in order to use a class. If left blank only the na me of # the header file containing the class definition is used. Otherwise one sh ould # specify the list of include paths that are normally passed to the compile r # using the -I flag. STRIP_FROM_INC_PATH = STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but less readable) file names. This can be useful your file (but # support long names like on DOS, Mac, or CD-ROM. # less readable) file names. This can be useful is your file systems doesn' t # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret th will interpret first line (until the first dot) of a e comment as the brief description. If set to NO, the # first line (until the first dot) of a Javadoc-style comment as the brief will behave just like # description. If set to NO, the Javadoc-style will behave just like regula # (thus requiring an explicit @brief command for a brief description.) r Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = YES JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then will # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the fir interpret the line (until the first dot) of a Qt-style st comment as the brief If set to NO, the # line (until the first dot) of a Qt-style comment as the brief description will behave just like regular Qt-style comments . If # an explicit \brief command for a brief description.) # set to NO, the Qt-style will behave just like regular Qt-style comments ( thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a treat a multi-line C++ special comment block (i.e. a block of //! or /// # multi-line C++ special comment block (i.e. a block of //! or /// comments as a brief description. This used to be the default ) as The new is to treat a multi-line C++ comment block as a detailed # a brief description. This used to be the default behavior. The new defaul description. Set tag to YES if you prefer the old instead. t is # to treat a multi-line C++ comment block as a detailed description. Set th is # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented # If the INHERIT_DOCS tag is set to YES then an undocumented member inherit member the documentation from any documented member that it s the re-implements. # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a new page for each member. If set to NO, the documentation of a member a # new page for each member. If set to NO, the documentation of a member wil be part of the file/class/namespace that contains it. l be # part of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxyge # uses this value to replace tabs by spaces in code fragments. n # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 TAB_SIZE = 4 # This tag can be used to specify a number of aliases that # This tag can be used to specify a number of aliases that act as commands as commands in the documentation. An alias has the in # For example adding Side Effects:\n" will allow you to # the documentation. An alias has the form: put the command \sideeffect (or @sideeffect) in the documentation, which # name=value will result in a user-defined paragraph with heading "Side Effects:". # For example adding You can put \n's in the value part of an alias to insert newlines. # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL on ly). # This tag can be used to specify a number of word-keyword mappings (TCL on ly). # A mapping has the form "name=value". For example adding # A mapping has the form "name=value". For example adding "class=itcl::clas # will allow you to use the command class in the s" itcl::class meaning. # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C so # only. Doxygen will then generate output that is more tailored for urces C. # only. Doxygen will then generate output that is more tailored for C. For For instance, some of the names that are used will be different. The list # instance, some of the names that are used will be different. The list of of all members will be omitted, etc. all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more or # For instance, namespaces will be presented as # Python sources only. Doxygen will then generate output that is more tailo # scopes will look different, etc. red # for that language. For instance, namespaces will be presented as packages , # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortr an # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortr an # Doxygen will then generate output that is tailored for # sources. Doxygen will then generate output that is tailored for Fortran. Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # sources. Doxygen will then generate output that is tailored for VHDL. VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend # Doxygen has a built-in mapping, but you can override or extend it it # using this tag. The format is ext=language, where ext is a file extension # tag. The format is ext=language, where ext is a file and , and # language is one of the parsers supported by doxygen: IDL, Java, Javascrip # is one of the parsers supported by doxygen: IDL, Java, t, # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to m # C++, D, PHP, Objective-C, Python, Fortran, For instance to ake # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C # (default is Fortran), use: inc=Fortran f=C. Note that for custom # (default is Fortran), use: inc=Fortran f=C. # you also need to set FILE_PATTERNS the files are not read by # Note For files without extension you can use no_extension as a placeholde r. # # Note that for custom extensions you also need to set FILE_PATTERNS otherw ise # the files are not read by doxygen. EXTENSION_MAPPING = EXTENSION_MAPPING = # If MARKDOWN_SUPPORT is enabled then doxygen pre-processes # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all com ments # according to the Markdown format, which allows for more readable # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for detai ls. # documentation. See http://daringfireball.net/projects/markdown/ for detai ls. # The output of markdown processing is further processed by doxygen, so you # The output of markdown processing is further processed by doxygen, so you can mix doxygen, HTML, and XML commands with Markdown formatting. can Disable in case of backward compatibilities issues. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable onl y in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by by putting a % sign in front of the w ord # or globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not w ant # If you use STL classes (i.e. std::string, std::vector, etc.) but do not w ant # to include (a tag file for) the STL sources as input, then you should # to include (a tag file for) the STL sources as input, then you should set set this tag to YES in order to let doxygen match functions declarations this and # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collabor # func(std::string) {}). This also the inheritance and ation # diagrams that involve STL classes more complete and accurate. # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = YES BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YE S to # If you use Microsoft's C++/CLI language, you should set this option to YE S to # enable parsing support. # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Dox # will parse them like normal C++ but will assume all classes use ygen # will parse them like normal C++ but will assume all classes use public in # of private inheritance when no explicit protection keyword is stead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will # and setter methods for a property. Setting this option to YES make # doxygen to replace the get and set methods by a property in the documenta will make doxygen replace the get and set methods by a property in the tion. # This will only work if the methods are indeed getting or # This will only work if the methods are indeed getting or setting a simple setting a simple type. If this is not the case, or you want to show the # type. If this is not the case, or you want to show the methods anyway, yo methods anyway, should set this option to NO. u # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_ DOC # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_ DOC # tag is set to YES, then doxygen will reuse the documentation of the first # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By defau lt # member in the group (if any) for the other members of the group. By defau lt # all members of a group must be documented explicitly. # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES to allow class member groups # Set the SUBGROUPING tag to YES to allow class member groups of the same t of ype the same (for instance a group of public functions) to be put as a # (for instance a group of public functions) to be put as a subgroup of tha subgroup of type (e.g. under the Public Functions section). Set it t # type (e.g. under the Public Functions section). Set it to NO to prevent NO to prevent subgrouping. Alternatively, this can be done per class # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. the \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and u # are shown inside the group in which they are included (e.g. using nions # instead of on a separate page (for HTML and Man pages) or # are shown inside the group in which they are included (e.g. using \ingrou section (for and RTF). p) # instead of on a separate page (for HTML and Man pages) or section (for La TeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and u # with only public data fields will be shown in nions # with only public data fields or simple typedef fields will be shown inlin # of the scope in which they are defined (i.e. file, namespace, or group e in documentation), provided this scope is documented. If set # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If # structs, classes, and unions are shown on a separate page (for and set # to NO, structs, classes, and unions are shown on a separate page (for HTM # pages) or section (for LaTeX and RTF). L and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, o r # is documented as struct, union, or enum with the name of the So # enum is documented as struct, union, or enum with the name of the typedef . So # typedef struct TypeS {} TypeT, will appear in the documentation as a stru ct # typedef struct TypeS {} TypeT, will appear in the documentation as a stru ct # with name TypeT. When disabled the typedef will appear as a member of a f ile, # with name TypeT. When disabled the typedef will appear as a member of a f ile, # namespace, or class. And the struct will be named TypeS. This can typical # namespace, or class. And the struct will be named TypeS. This can typical ly ly be be useful for C code in case the coding convention dictates that all # useful for C code in case the coding convention dictates that all compoun d # types are typedef'ed and only the typedef is referenced, never the tag na me. # types are typedef'ed and only the typedef is referenced, never the tag na me. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO TYPEDEF_HIDES_STRUCT = NO # The # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. T his # cache is used to resolve symbols given their name and scope. Since this c an be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and sugg est # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. cache is used to resolve symbols given their name and scope. Since this be an expensive process and often same symbol multiple times in the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small doxygen will become If the cache is too large, memory is wasted. The cache size is given by formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default 0, corresponding to a cache size of symbols. LOOKUP_CACHE_SIZE = 0 LOOKUP_CACHE_SIZE = 0 #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # Build related configuration options # Build related configuration options #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # documentation are documented, even if no documentation was available. Pri # class members and static file members will be hidden unless vate the EXTRACT_PRIVATE EXTRACT_STATIC tags are set to # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # If the EXTRACT_PRIVATE tag is set to YES all private members of a class w # be included in the documentation. ill # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or inte # If the EXTRACT_PACKAGE tag is set to YES all members with package or inte rnal scope will be included in the documentation. rnal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # If the EXTRACT_STATIC tag is set to YES all static members of a file will will be included in the documentation. be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defi # locally in source files will be included in the documentation. ned If set to NO only classes defined in header files are included. # locally in source files will be included in the documentation. If set to NO # only classes defined in header files are included. Does not have any effe ct # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # This flag is only useful for Objective-C code. When set to YES local meth # which are defined in the implementation section but not in ods, the interface are included in the documentation. # which are defined in the implementation section but not in the interface If set to NO only methods in the interface are included. are # included in the documentation. If set to NO only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # 'anonymous_namespace{file}', where file will be replaced with the base na of the file that contains the anonymous namespace. By default me of anonymous are hidden. # the file that contains the anonymous namespace. By default anonymous name space # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, will hide all # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members documented or # undocumented members inside documented classes or files. If set to NO the If set to NO members will be included in the se various overviews, but no documentation section is generated. # members will be included in the various overviews, but no documentation This option has no effect if EXTRACT_ALL is # section is generated. This option has no effect if EXTRACT_ALL is enabled . # The default value is: NO. HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, will hide all # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # undocumented classes that are normally visible in the class hierarchy. If If set to NO these classes will be included in the various set overviews. This has no effect if EXTRACT_ALL is enabled. # to NO these classes will be included in the various overviews. This optio n has # no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, will hide all # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all fri # (class|struct|union) declarations. end If set to NO these declarations will included in the # (class|struct|union) declarations. If set to NO these declarations will b documentation. e # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = YES HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, will hide any # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. # documentation blocks found inside the body of a function. If set to NO th If set to NO blocks will be appended to the ese function's detailed documentation block. # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # The INTERNAL_DOCS tag determines if documentation that is typed after a that is typed after a \internal command is included. If the tag is set # \internal command is included. If the tag is set to NO then the documenta to NO then the will be excluded. tion Set it to YES to include the internal documentation. # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then will only generate # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file names in lower-case letters. If set to YES upper-case letters are file # names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only dif fer # allowed. This is useful if you have classes or files whose names only dif fer # in case and if your file system supports case sensitive file names. Windo ws # in case and if your file system supports case sensitive file names. Windo ws # and Mac users are advised to set this option to NO. # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members w will show members their full class and namespace scopes in the ith documentation. If set to YES the scope will be hidden. # their full class and namespace scopes in the documentation. If set to YES the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES then # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list will put a list of the files that are included by a file in the of # the files that are included by a file in the documentation of that file. of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES SHOW_INCLUDE_FILES = YES # If the tag is set to YES then Doxygen # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for # will list files with double quotes in the documentation each rather than with sharp # grouped member an include statement to the documentation, telling the rea der # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list incl ude # files with double quotes in the documentation rather than with sharp brac kets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in t is inserted in documentation for inline members. he # documentation for inline members. # The default value is: YES. INLINE_INFO = YES INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the will sort the (detailed) documentation of file and class members # (detailed) documentation of file and class members alphabetically by memb alphabetically by name. If set to NO the members will appear in er declaration order. # name. If set to NO the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief brief of file, namespace and class members alphabetically # descriptions of file, namespace and class members alphabetically by membe by name. If set to NO the members will appear in r declaration order. # name. If set to NO the members will appear in declaration order. Note tha t # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort th will sort (brief and detailed) documentation of class members so that e constructors and destructors are listed first. If set to NO # (brief and detailed) documentation of class members so that constructors the constructors will appear the respective orders defined by and and # destructors are listed first. If set to NO the constructors will appear i # SORT_BRIEF_DOCS is set to NO n the ignored for SORT_MEMBER_DOCS is set to NO. # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = YES SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hier # of group names into alphabetical order. If set to NO archy # of group names into alphabetical order. If set to NO the group names will the group names will appear in their defined order. # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorte by fully-qualified names, including namespaces. If set to d by the class list will be sorted only by class name, # fully-qualified names, including namespaces. If set to NO, the class list not including the namespace part. will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # Note: This option applies only to the class list, not to the alphabetical alphabetical list. # list. # The default value is: NO. SORT_BY_SCOPE_NAME = YES SORT_BY_SCOPE_NAME = YES # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do pr do type resolution of all parameters of a function it will reject oper a # type resolution of all parameters of a function it will reject a match be match the prototype and the implementation of a member function tween # the prototype and the implementation of a member function even if there i if there only one candidate or it is obvious which candidate to choose s by doing a simple string match. By disabling STRICT_PROTO_MATCHING # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will stil will accept a match between prototype and implementation in such l # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable or # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) t disable todo list. This list is created by putting \todo he commands in the documentation. # todo list. This list is created by putting \todo commands in the # documentation. # The default value is: YES. GENERATE_TODOLIST = NO GENERATE_TODOLIST = NO # The GENERATE_TESTLIST tag can be used to enable or # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) t disable test list. This list is created by putting \test he commands in the documentation. # test list. This list is created by putting \test commands in the # documentation. # The default value is: YES. GENERATE_TESTLIST = NO GENERATE_TESTLIST = NO # The GENERATE_BUGLIST tag can be used to enable or # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) th disable bug list. This list is created by putting \bug e bug commands in the documentation. # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = NO GENERATE_BUGLIST = NO # The GENERATE_DEPRECATEDLIST tag can be used to enable or # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( disable the deprecated list. This list is created by putting NO) \deprecated commands in the documentation. # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # The ENABLED_SECTIONS tag can be used to enable conditional documentation documentation sections, marked by \if ... # sections, marked by \if <section_label> ... \endif and \cond <section_lab el> # ... \endcond blocks. ENABLED_SECTIONS = ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the initial value of a variable or macro for it to appear the the documentation. If the initializer consists of more lines than # initial value of a variable or macro / define can have for it to appear i n the # it will be hidden. Use a value of 0 to hide initializers completely. # documentation. If the initializer consists of more lines than specified h The appearance of the of individual variables and macros ere # it will be hidden. Use a value of 0 to hide initializers completely. The can be controlled using \showinitializer or # appearance of the value of individual variables and macros / defines can be command in the documentation regardless of this setting. # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at the bottom of the documentation of classes and structs. If set to YES at the # the bottom of the documentation of classes and structs. If set to YES the list will mention the files that were used to generate the documentation. list # will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES SHOW_USED_FILES = YES # # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. Set the SHOW_FILES tag to NO to disable the generation of the Files page. This will remove the Files entry from the Quick Index and from the Folder Tree View (if specified). The default YES. SHOW_FILES = YES SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namesp # page. aces This will remove the Namespaces entry from the Quick Index # page. This will remove the Namespaces entry from the Quick Index and from and from the Folder Tree View (if specified). The default YES. the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script th at # The FILE_VERSION_FILTER tag can be used to specify a program or script th at # doxygen should invoke to get the current version for each file (typically from # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # the version control system). Doxygen will invoke the program by executing (via # popen()) the command where is the value # popen()) the command command input-file, where command is the value of th of e # FILE_VERSION_FILTER tag, and is the name of an input # FILE_VERSION_FILTER tag, and input-file is the name of an input file prov ided # by doxygen. Whatever the program writes to standard output # by doxygen. Whatever the program writes to standard output is used as the is used as the file version. the file # version. For an example see the documentation. FILE_VERSION_FILTER = FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be pa rsed # The LAYOUT_FILE tag can be used to specify a layout file which will be pa rsed # by doxygen. The layout file controls the global structure of the generate d # by doxygen. The layout file controls the global structure of the generate d # output files in an output format independent way. create the layout # output files in an output format independent way. To create the layout fi le # that represents doxygen's defaults, run doxygen with the -l option. # that represents doxygen's defaults, run doxygen with the -l option. You c You optionally specify a file name after the option, if omitted an # will be used as the name of the layout file. # optionally specify a file name after the option, if omitted DoxygenLayout .xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT _FILE # tag is left empty. LAYOUT_FILE = @PROJECT_SOURCE_DIR@/doc/DoxygenLayout.xml LAYOUT_FILE = @PROJECT_SOURCE_DIR@/doc/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files # The CITE_BIB_FILES tag can be used to specify one or more bib files conta # the This must be a list of .bib files. The ining .bib extension is automatically appended if omitted. # the reference definitions. This must be a list of .bib files. The .bib requires the bibtex tool to be installed. See also # extension is automatically appended if omitted. This requires the bibtex http://en.wikipedia.org/wiki/BibTeX for more For LaTeX the style tool of the bibliography can be controlled using LATEX_BIB_STYLE. To use this # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more in feature you need bibtex and perl available the search path. fo. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available i n the # search path. Do not use file names with spaces, bibtex cannot handle them . See # also \cite for info how to create references. CITE_BIB_FILES = CITE_BIB_FILES = #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # onfiguration options related to warning and progress messages # Configuration options related to warning and progress messages #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # The QUIET tag can be used to turn on/off the messages that are generated # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. If is to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. If # generated to standard error ( stderr) by doxygen. If WARNINGS is set to Y is ES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this # for undocumented members. If EXTRACT_ALL is set to YES then this flag flag # will automatically be disabled. # automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = NO WARN_IF_UNDOCUMENTED = NO # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate for # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warning # potential errors in the documentation, such as not documenting some s for # in a documented function, or documenting parameters that # potential errors in the documentation, such as not documenting some param don't exist or markup commands wrongly. eters # in a documented function, or documenting parameters that don't exist or u sing # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES WARN_IF_DOC_ERROR = YES # WARN_NO_PARAMDOC option can be enabled to get warnings for # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions functions that are documented, but have no documentation for their that # are documented, but have no documentation for their parameters or return or return value. If set to NO doxygen will only warn about # value. If set to NO doxygen will only warn about wrong or incomplete para wrong or incomplete documentation, but not about the absence of meter documentation. # documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = NO # The WARN_FORMAT tag determines the format of the warning messages that # The WARN_FORMAT tag determines the format of the warning messages that do # can produce. The string should contain the$file, $line, and xygen # can produce. The string should contain the$file, $line, and$text tags,
tags, which will be replaced by the file and line number from which the which
warning and the warning text. Optionally the format may # will be replaced by the file and line number from which the warning origi
nated
$version, which be replaced by the version of the file (if it could # and the warning text. Optionally the format may contain$version, which w
be obtained via FILE_VERSION_FILTER) ill
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line:$text" WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # The WARN_LOGFILE tag can be used to specify a file to which warning and e and messages should be written. If left blank the output is written rror to # messages should be written. If left blank the output is written to standa rd # error (stderr). WARN_LOGFILE = WARN_LOGFILE = #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # onfiguration options related to the input files # Configuration options related to the input files #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # The INPUT tag used to specify the files and/or directories that # The INPUT tag is used to specify the files and/or directories that contai n # documented source files. You may enter file names like or # documented source files. You may enter file names like myfile.cpp or # directories like Separate the files or directories # directories like /usr/src/myproject. Separate the files or directories wi # spaces. th # spaces. # Note: If this tag is empty the current directory is searched. INPUT = @PROJECT_SOURCE_DIR@/src/ \ INPUT = @PROJECT_SOURCE_DIR@/src/ \ @PROJECT_SOURCE_DIR@/doc/ @PROJECT_SOURCE_DIR@/doc/ # This tag can be used to specify the character encoding of the source file s # This tag can be used to specify the character encoding of the source file s # that doxygen parses. Internally doxygen uses the UTF-8 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen encoding. Doxygen uses libiconv (or the iconv uses # libiconv (or the iconv built into libc) for the transcoding. See the libi into libc) for the transcoding. See conv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # the list of possible encodings. # possible encodings. # 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 (like *.cpp # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp an # *.h) to filter out the source-files in the directories. If left d blank the following patterns are # *.h) to filter out the source-files in the directories. If left blank the # # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.i i, # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = *.h \ FILE_PATTERNS = *.h \ *.hpp \ *.hpp \ *.doxygen *.doxygen # The RECURSIVE tag can be used to specify whether or not # The RECURSIVE tag can be used to specify whether or not subdirectories sh ould # be searched for input files as well. # be searched for input files as well. # The default value is: NO. # RECURSIVE = YES RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that shou ld be # The EXCLUDE tag can be used to specify files and/or directories that shou ld 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. EXCLUDE = @PROJECT_SOURCE_DIR@/src/core/external EXCLUDE = @PROJECT_SOURCE_DIR@/src/core/external # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excl uded # directories that are symbolic links (a Unix file system feature) are excl uded # from the input. # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO EXCLUDE_SYMLINKS = NO # 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 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # certain files from those directories. against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = */.bzr/* EXCLUDE_PATTERNS = */.bzr/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # The EXAMPLE_PATH tag can be used to specify one or more files or director # that contain example code fragments that are included (see ies the \include command). # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use th e # If the value of the EXAMPLE_PATH tag contains directories, you can use th e # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and *.h) to filter out the source-files in the directories. If left and blank all files are included. # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # searched for input files to be used with the \include or \dontinclude com # irrespective of the value of the RECURSIVE tag. mands # NO. # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # The IMAGE_PATH tag can be used to specify one or more files or directorie # that contain that are included in the documentation s # that contain images that are to be included in the documentation (see the the \image command). # \image command). IMAGE_PATH = @PROJECT_SOURCE_DIR@/doc/images/ IMAGE_PATH = @PROJECT_SOURCE_DIR@/doc/images/ # The INPUT_FILTER tag can be used to specify a program that doxygen should # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter prog ram # invoke to filter for each input file. Doxygen will invoke the filter prog ram # by executing (via popen()) the <filter> # by executing (via popen()) the command: # # is the value of the INPUT_FILTER tag, and <input-file> is the name of an # <filter> <input-file> input file. Doxygen will then use the output that the filter # # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is # to standard output. the If FILTER_PATTERNS is specified, this tag will be # name of an input file. Doxygen will then use the output that the filter ignored. # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before t he # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. INPUT_FILTER = INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file patt ern # The FILTER_PATTERNS tag can be used to specify filters on a per file patt ern # basis. # basis. Doxygen will compare the file name with each pattern and apply the Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=f # filter if there is a match. ilter The filters are a list of the form: # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on h # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further ow on filters are used. If FILTER_PATTERNS is empty or if # filters are used. If the FILTER_PATTERNS tag is empty or if none of the of the patterns match the file name, INPUT_FILTER is applied. # patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set us ing # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set us ing # will be used to filter the input files # INPUT_FILTER ) will also be used to filter the input files that are used for # files to browse (i.e. when SOURCE_BROWSER is set to YES). # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and it is also possible to disable source filtering for a specific and # it is also possible to disable source filtering for a specific pattern us # *.ext= (so without naming a filter). ing # *.ext= (so without naming a filter). # FILTER_SOURCE_FILES is # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file t hat # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance Gi tHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # onfiguration options related to source browsing # Configuration options related to source browsing #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # If the SOURCE_BROWSER tag is set to YES then a list of source files will # If the SOURCE_BROWSER tag is set to YES then a list of source files will be generated. Documented entities will be cross-referenced with these be # generated. Documented entities will be cross-referenced with these source # Note: To get rid of all source code in the generated output, make sure s. # # VERBATIM_HEADERS is set to NO. # Note: To get rid of all source code in the generated output, make sure th at # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body # Setting the INLINE_SOURCES tag to YES will include the body of functions, of classes directly the documentation. # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide doxygen to hide any special comment blocks from generated source code any fragments. Normal and comments will always remain visible. # special comment blocks from generated source code fragments. Normal C, C+ + and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented then for each documented function all documented # function all documented functions referencing it will be listed. functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # If the REFERENCES_RELATION tag is set to YES then for each documented fun then for each documented all documented entities ction called/used by that function will be listed. # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is and SOURCE_BROWSER tag is set to YES, then the hyperlinks from set functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # to YES, then the hyperlinks from functions in REFERENCES_RELATION and link to the source code. # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they Otherwise they will link to the documentation. will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = NO REFERENCES_LINK_SOURCE = NO # If the USE_HTAGS tag is set to YES then the references to source code # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in # point to the HTML generated by the htags(1) tool instead of doxygen the # source browser. The htags tool is part of GNU's global source # source code will show a tooltip with additional information such as proto tagging (see http://www.gnu.org/software/global/global.html). You type, will need 4.8.6 or higher. # brief description and links to the definition and documentation. Since th is # will make the HTML file larger and loading of large files a bit slower, y ou # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code wil l # point to the HTML generated by the htags(1) tool instead of doxygen built -in # source browser. The htags tool is part of GNU's global source tagging sys tem # (see http://www.gnu.org/software/global/global.html). You will need versi on # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set YES then # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a will generate a verbatim copy of the header file for each class for # verbatim copy of the header file for each class for which an include is which an include is specified. Set to NO to disable this. # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES VERBATIM_HEADERS = YES #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # onfiguration 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 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all of all compounds will be generated. Enable this if the project # compounds will be generated. Enable this if the project contains a lot of contains a lot of classes, structs, unions or interfaces. # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES ALPHABETICAL_INDEX = YES # # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in in which list will be the # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 3 COLS_IN_ALPHA_INDEX = 3 # In case all classes in a project start with a common prefix, all # In case all classes in a project start with a common prefix, all classes classes will be put under the same header in the alphabetical index. will The IGNORE_PREFIX tag can be used to specify that # be put under the same header in the alphabetical index. The IGNORE_PREFIX should be while generating the index headers. tag # can be used to specify a prefix (or a list of prefixes) that should be ig nored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = IGNORE_PREFIX = #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # onfiguration options related to the HTML output # Configuration options related to the HTML output #-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- - # If the GENERATE_HTML tag is set to YES will # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output generate HTML # The default value is: YES. GENERATE_HTML = YES GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. I a relative path is entered the value of OUTPUT_DIRECTORY will be f a put in of it. default # relative path is entered the value of OUTPUT_DIRECTORY will be put in fro nt of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each generated HTML page (for example: each # generated HTML page (for example: .htm, .php, .asp). # # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a HTML header for # The HTML_HEADER tag can be used to specify a user-defined HTML header fil # each generated HTML page. If is left blank doxygen will generate a e for # standard header. # each generated HTML page. If the tag is left blank doxygen will generate # the any scripts and style that doxygen a needs, which is dependent on the configuration options # standard header. # It is to a default header using -w html # # and then modify # To get valid HTML the header file that includes any scripts and style she # the header is subject to change so you typically ets have to when upgrading to a newer version of # that doxygen needs, which is dependent on the configuration options used # of (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage " # for information on how to generate the default header that doxygen normal ly # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a descri ption # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = @PROJECT_SOURCE_DIR@/doc/doc-header.html HTML_HEADER = @PROJECT_SOURCE_DIR@/doc/doc-header.html # The HTML_FOOTER tag can be used to specify a HTML footer for # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each generated HTML page. If is left blank doxygen will generate a each # footer. # generated HTML page. If the tag is left blank doxygen will generate a sta ndard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default fo oter # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # The HTML_STYLESHEET tag can be used to specify a user-defined cascading s # sheet that is used by each HTML page. It can be used to tyle fine-tune the of the HTML output. If left blank doxygen # sheet that is used by each HTML page. It can be used to fine-tune the loo will generate a default style k of # to the # the HTML output. If left blank doxygen will generate a default style shee # sheet as it will t. # See also section "Doxygen usage" for information on how to generate the s tyle # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future becom e # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = @PROJECT_SOURCE_DIR@/doc/doxygen.css HTML_STYLESHEET = @PROJECT_SOURCE_DIR@/doc/doxygen.css # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- # defined cascading style sheet that is included after the standard style s heets # created by doxygen. Using this option one can overrule certain style aspe cts. # This is preferred over using HTML_STYLESHEET since it does not replace th e # standard style sheet and is therefor more robust against future updates. # Doxygen will copy the style sheet file to the output directory. For an ex ample # see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. N ote # other source files which should be copied to the HTML output directory. N ote # that these files will be copied to the base HTML output directory. Use th e # that these files will be copied to the base HTML output directory. Use th e # marker in the HTML_HEADER and/or HTML_FOOTER files to load thes #$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load thes
e e
# files. In the HTML_STYLESHEET file, use the file name only. Also note tha # files. In the HTML_STYLESHEET file, use the file name only. Also note tha
t t the
the files will be copied as-is; there are no commands or markers # files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES = HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxyge
# will adjust the colors in the and background images n
according to this color. Hue is specified as an angle on a colorwheel, # will adjust the colors in the stylesheet and background images according
For instance the 0 represents red, 60 is yellow, 120 is green, # this color. Hue is specified as an angle on a colorwheel, see
180 is cyan, 240 is blue, purple, and 360 is red again. # http://en.wikipedia.org/wiki/Hue for more information. For instance the v
# is to alue
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 3
00
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the co
the in the HTML output. For a value of 0 the output will use lors
grayscales only. A value of 255 will produce the most vivid colors. # in the HTML output. For a value of 0 the output will use grayscales only.
A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to th
# luminance component of the colors in the HTML output. Values below e
100 gradually make the output lighter, whereas values above 100 make # luminance component of the colors in the HTML output. Values below 100
the darker. The value divided by 100 is the actual gamma applied, # gradually make the output lighter, whereas values above 100 make the outp
so 80 a gamma of 0.8, The value 220 represents a gamma of 2.2, ut
and 100 does not change the gamma. # darker. The value divided by 100 is the actual gamma applied, so 80 repre
sents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80 HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting # page will contain the date and time when the page was generated. Setting
this to NO can help when comparing the output of multiple runs. this
# to NO can help when comparing the output of multiple runs.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = YES HTML_TIMESTAMP = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after th e # documentation will contain sections that can be hidden and shown after th e
# page has loaded. # page has loaded.
# # The default value is: NO.
# # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entri
will be generated that can be used as input for Apple's Xcode 3 es
integrated introduced OSX 10.5 (Leopard). # shown in the various tree structured indices initially; the user can expa
To create a documentation set, doxygen will generate a Makefile in the nd
HTML output directory. Running make will produce the in # and collapse entries dynamically later on. Doxygen will expand the tree t
# directory and running will install the docset in o
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # such a level that at most the specified number of entries are visible (un
it at less
# See # a fully collapsed tree already exceeds this amount). So setting the numbe
r of
# entries 1 will produce a full collapsed tree by default. 0 is a special v
alue
# representing an infinite number of entries and will result in a full expa
nded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated develo
pment
# environment (see: http://developer.apple.com/tools/xcode/), introduced wi
th
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate
a
# Makefile in the HTML output directory. Running make will produce the docs
et in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.
html
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO GENERATE_DOCSET = NO
# tag determines the name of # This tag determines the name of the docset feed. A documentation feed pro
vides
feed. A documentation feed an umbrella under which multiple # an umbrella under which multiple documentation sets from a single provide
documentation sets from a single (such as a company or product r
# (such as a company or product suite) can be grouped.
can be grouped. # The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Stellarium Developers Documentation" DOCSET_FEEDNAME = "Stellarium Developers Documentation"
# tag specifies a string that # This tag specifies a string that should uniquely identify the documentati
should uniquely identify the set bundle. This should be a on
reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # set bundle. This should be a reverse domain-name style string, e.g.
will append .docset to the name. # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.stellarium DOCSET_BUNDLE_ID = org.stellarium
# ify # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely ident ify
# the documentation publisher. This should be a reverse domain-name style # the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation. # string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The tag identifies the documentation publisher. # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to additional index # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# that can be # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# HTML a compiled HTML file # index.hhp is a project file that can be read by Microsoft's HTML Help Wor
# the HTML documentation. kshop
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML outp
ut
# generated by doxygen into a single compiled HTML file (.chm). Compiled HT
ML
# files are now used as the Windows 98 help format, and will replace the ol
d
# Windows help format (.hlp) on all Windows platforms in the future. Compre
ssed
# HTML files also contain an index, a table of contents, and you can search
for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO GENERATE_HTMLHELP = NO
# CHM_FILE tag can # The CHM_FILE tag can be used to specify the file name of the resulting .c
be used to specify the file name of the resulting file. You hm
can add a path in front of the file if the result should not be # file. You can add a path in front of the file if the result should not be
# written to the html output directory. # written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE = CHM_FILE =
# HHC_LOCATION tag can # The HHC_LOCATION tag can be used to specify the location (absolute path
be used to specify the location (absolute path including file name) of # including file name) of the HTML help compiler ( hhc.exe). If non-empty
the HTML help compiler If non-empty doxygen will try to run # doxygen will try to run the HTML help compiler on the generated index.hhp
the HTML help compiler on the generated .
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION = HHC_LOCATION =
# GENERATE_CHI flag # The GENERATE_CHI flag controls if a separate .chi index file is generated
controls if a separate .chi index file is generated or that (
it should be included in the master .chm file # YES) or that it should be included in the master .chm file ( NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO GENERATE_CHI = NO
# CHM_INDEX_ENCODING # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content (
is used to encode HtmlHelp index content and project file hhc)
content. # and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING = CHM_INDEX_ENCODING =
# BINARY_TOC flag # The BINARY_TOC flag controls whether a binary table of contents is genera
controls whether a binary table of contents is or a ted (
normal table of contents in the .chm file. # YES) or a normal table of contents ( NO) in the .chm file.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group member # The TOC_EXPAND flag can be set to YES to add extra items for group member
s s to
to the contents of the HTML help documentation and to the tree # the table of contents of the HTML help documentation and to the tree view
.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated th
# can be used as input for Qt's qhelpgenerator to generate a at
Qt Compressed Help (.qch) of the generated HTML documentation. # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed
Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to spe
be used to the file name of the resulting .qch file. cify
The path specified is relative to the HTML output folder. # the file name of the resulting .qch file. The path specified is relative
to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE = QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt H
# # Project output. For more information please see Qt Help Project / Namespa
ce
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.stellarium QHP_NAMESPACE = org.stellarium
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
Qt Help Project output. For more information please see Qt
# # Help Project output. For more information please see Qt Help Project / Vi
rtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual
-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
to # filter to add. For more information please see Qt Help Project / Custom
# # filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME = QHP_CUST_FILTER_NAME =
# The tag specifies the list of the attributes of the # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
ustom
Qt Help Project / # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS = QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's # project's filter section matches. Qt Help Project / Filter Attributes (se
filter section matches. e:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
Qt Help Project / Filter # This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS =
# QHG_LOCATION tag can # The QHG_LOCATION tag can be used to specify the location of Qt's
be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on th
# If non-empty doxygen will try to run qhelpgenerator on e
# .qhp file. # generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION = QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files wil
be generated, together with the HTML files, form an Eclipse l be
# generated, together with the HTML files, they form an Eclipse help plugin
To install this plugin and make it available under the help . To
# install this plugin and make it available under the help contents menu in
menu in Eclipse, the contents of the directory containing the HTML and # Eclipse, the contents of the directory containing the HTML and XML files
needs
files needs to be copied into the plugins directory of eclipse. The name # to be copied into the plugins directory of eclipse. The name of the direc
of tory
the within the plugins directory should be the same as # within the plugins directory should be the same as the ECLIPSE_DOC_ID val
the ECLIPSE_DOC_ID After copying Eclipse needs to be restarted ue.
# After copying Eclipse needs to be restarted before the help appears.
the help appears. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO GENERATE_ECLIPSEHELP = NO
# A unique identifier for the help plugin. When installing the plug # A unique identifier for the Eclipse help plugin. When installing the plug
in in
# the directory name containing the HTML and XML files should also have # the directory name containing the HTML and XML files should also have thi
# name. s
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index # If you want full control over the layout of the generated HTML pages it m
ight
top of each HTML page. value NO enables the index # be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) a
the value YES it. Since the tabs the same information as t top
# of each HTML page. A value of NO enables the index and the value YES disa
# you can set this option to if you set bles
GENERATE_TREEVIEW to YES. # it. Since the tabs in the index contain the same information as the navig
ation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to
YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. # structure should be generated to display hierarchical information. If the
If the tag value is set to YES, a side panel will be generated tag
containing a index structure (just like the one that # value is set to YES, a side panel will be generated containing a tree-lik
is generated for HTML Help). For this to work a browser that supports e
JavaScript, DHTML, CSS and frames is (i.e. any modern browser). # index structure (just like the one that is generated for HTML Help). For
Windows users are probably better off using HTML help feature. this
# Since the tree has the same information as the tab you # to work a browser that supports JavaScript, DHTML, CSS and frames is requ
could consider DISABLE_INDEX to when enabling this option. ired
# (i.e. any modern browser). Windows users are probably better off using th
e
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one
can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image
at
# the root of the tree instead of the PROJECT_NAME. Since the tree basicall
y has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
that doxygen will group on one line in the generated that
# doxygen will group on one line in the generated HTML documentation.
documentation. Note that a value of 0 will completely suppress the enum #
values from in the overview section. # Note that a value of 0 will completely suppress the enum values from appe
aring
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4 ENUM_VALUES_PER_LINE = 4
# # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be u
sed
# to set the initial width (in pixels) of the frame in which the tree is sh
own.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# to set the initial width (in pixels) of the frame in which the tree
# is
TREEVIEW_WIDTH = 250 TREEVIEW_WIDTH = 250
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links
links to external symbols imported via tag files in a separate window. to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
# Use this tag to change the font size of formulas included # Use this tag to change the font size of LaTeX formulas included as images
as images in the HTML documentation. in
you change the font size after a successful doxygen run you need # the HTML documentation. When you change the font size after a successful
to manually remove any form_*.png images from the output directory # doxygen run you need to manually remove any form_*.png images from the HT
to force them to be regenerated. ML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10 FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images # Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are # generated for formulas are transparent PNGs. Transparent PNGs are not
not supported properly for IE 6.0, but are supported on all modern # supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png fil # Note that when changing this option you need to delete any form_*.png fil
es es in
in the HTML output before the changes have effect. # the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
(see http://www.mathjax.org) which uses client side Javascript for the # http://www.mathjax.org) which uses client side Javascript for the renderi
# instead of using prerendered bitmaps. Use this if you do not ng
have LaTeX installed or if you want to formulas look prettier in the HTML # instead of using prerendered bitmaps. Use this if you do not have LaTeX
output. enabled you may also need to install MathJax separately and # installed or if you want to formulas look prettier in the HTML output. Wh
configure the path to it using the MATHJAX_RELPATH option. en
# enabled you may also need to install MathJax separately and configure the
path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO USE_MATHJAX = NO
# When MathJax is enabled you need to specify the location relative to the # When MathJax is enabled you can set the default output format to be used
HTML output directory using the MATHJAX_RELPATH option. The destination for
# should contain the MathJax.js script. For instance, if the # the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# is located at the same level as the HTML output directory, then # Possible values are: HTML-CSS (which is slower, but has the best
# MATHJAX_RELPATH should be ../mathjax. The default value points to # compatibility), NativeMML (i.e. MathML) and SVG.
the Content Delivery Network so you can quickly see the result # The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
# MathJax.
However, it is strongly recommended to install a local MATHJAX_FORMAT = HTML-CSS
copy of MathJax from http://www.mathjax.org before deployment.
# When MathJax is enabled you need to specify the location relative to the
HTML
# output directory using the MATHJAX_RELPATH option. The destination direct
ory
# should contain the MathJax.js script. For instance, if the mathjax direct
ory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the Mat
hJax
# Content Delivery Network so you can quickly see the result without instal
ling
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For exam
# names that should be enabled during MathJax rendering. ple
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS = MATHJAX_EXTENSIONS =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pi
# the HTML output. The underlying search engine uses javascript eces
and DHTML should work on any modern browser. Note that when using # of code that will be used on startup of the MathJax code. See the MathJax
HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets site
(GENERATE_DOCSET) there is already a search function so this one should # (see: http://docs.mathjax.org/en/latest/output.html) for more details. Fo
typically be For large projects the javascript based search r an
# example see the documentation.
can be slow, then enabling SERVER_BASED_SEARCH may provide a better # This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box f
or
# the HTML output. The underlying search engine uses javascript and DHTML a
nd
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabl
ed.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possibl
e to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typica
lly
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor d
own
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to c
ancel
# 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 k
eys>
# to select a filter and <Enter> or <escape> to activate or cancel the filt
er
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = NO SEARCHENGINE = NO
# 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 web client # implemented using a web server instead of a web client using Javascript.
using Javascript. will generate PHP and index There
file the # are two flavours of web server based searching depending on the
is to and # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP scrip
# The that is to t for
# searching and 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 "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the P
HP
# script for searching. Instead the search results are written to an XML fi
le
# which needs to be processed by an external indexer. Doxygen will invoke a
n
# external search engine pointed to by the SEARCHENGINE_URL option to obtai
n the
# search results.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web serv
er
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer ( doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindex
ed
# search data is written to a file for indexing by an external tool. With t
he
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This
is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multip
le
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through dox
ygen
# projects other than the one defined by this configuration file, but that
are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
of
# to a relative location where the documentation can be found. The format i
s:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# onfiguration options related to the LaTeX output # Configuration options related to the LaTeX output
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the GENERATE_LATEX tag is set to YES will # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX outpu
generate t.
# The default value is: YES.
GENERATE_LATEX = NO GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # 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 If a
put in of it. default # relative path is entered the value of OUTPUT_DIRECTORY will be put in fro
nt of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to b e # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to b e
# invoked. # invoked.
# Note that when enabling USE_PDFLATEX this option is only used for #
# bitmaps for formulas in the HTML output, but not in the # Note that when enabling USE_PDFLATEX this option is only used for generat
Makefile that is written to the output directory. ing
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to gen
# index for LaTeX. erate
# default # index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES generates more compact # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaT
# documents. This may be useful for small projects and may help to eX
save trees in general. # documents. This may be useful for small projects and may help to save som
e
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used # The PAPER_TYPE tag can be used to set the paper type that is used by the
by the printer. Possible values are: legal and # printer.
# # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (
8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more LaTeX # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package n
# that should be included in the LaTeX output. ames
# that should be included in the LaTeX output. To get the times font for
# instance you can specify
# EXTRA_PACKAGES=times
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES = EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for # The LATEX_HEADER tag can be used to specify a personal LaTeX header for t
# generated document. The header should contain everything until he
the first chapter. If it is left blank doxygen will generate a # generated LaTeX document. The header should contain everything until the
standard header. use if you know what you are first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title, #$datetime, $date,$doxygenversion, $projectname,$projectnumber. Doxygen
will
# replace them by respectively the title of the page, the current date and
time,
# only the current date, the version number of doxygen, the project name (s
ee
# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
# This tag requires that the tag GENERATE_LATEX is set to YES.
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for t
# generated document. The footer should contain everything after he
the last chapter. If it is left blank doxygen will generate a # generated LaTeX document. The footer should contain everything after the
standard footer. use if you know what you are last
# chapter. If it is left blank doxygen will generate a standard footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER = LATEX_FOOTER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
is prepared for conversion to (using The file or
# contain links (just like the HTML output) instead of page # other source files which should be copied to the LATEX_OUTPUT output
# makes the output suitable for online browsing using a viewer. # directory. Note that the files will be copied as-is; there are no command
s or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file w
ill
# contain links (just like the HTML output) instead of page references. Thi
s
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
# If the tag is set to YES, will # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to gen
# the Set this option to YES to get a erate
# the PDF file directly from the LaTeX files. Set this option to YES to get
a
# higher quality PDF documentation. # higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = NO USE_PDFLATEX = NO
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep ru
# command to the generated LaTeX files. This will instruct LaTeX to keep nning
# if errors occur, instead of asking the user for help. # if errors occur, instead of asking the user for help. This option is also
This option is also used when generating formulas in HTML. used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include
include the index chapters (such as File Index, Compound Index, etc.) the
in the output. # index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include sour
# code with syntax highlighting in the LaTeX output. ce
# Note that which sources are shown also depends on other settings # code with syntax highlighting in the LaTeX output.
such as SOURCE_BROWSER. #
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See # bibliography, e.g. plainnat, or ieeetr. See
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain LATEX_BIB_STYLE = plain
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# onfiguration options related to the RTF output # Configuration options related to the RTF output
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the GENERATE_RTF tag is set to YES will generate RTF # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. T
# RTF output is optimized for Word 97 and may not look pretty with he
RTF # RTF output is optimized for Word 97 and may not look too pretty with othe
r RTF
# The default value is: NO.
GENERATE_RTF = NO GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If
If a relative path is entered the value of OUTPUT_DIRECTORY will be a
put in of it. default # relative path is entered the value of OUTPUT_DIRECTORY will be put in fro
nt of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES generates more compact # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
RTF documents. This may be useful for small projects and may help to # documents. This may be useful for small projects and may help to save som
save trees in general. e
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
will contain hyperlink fields. The RTF file will # contain hyperlink fields. The RTF file will contain links (just like the
contain links (just like the HTML output) instead of page references. HTML
This makes the output suitable for browsing using or other # output) instead of page references. This makes the output suitable for on
support fields. line
# Note: (write) and others do not support links. # browsing using Word or some other Word compatible readers that support th
ose
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
# Load definitions from file. Syntax is similar to doxygen's # Load stylesheet definitions from file. Syntax is similar to doxygen's con
# file, i.e. a series of assignments. You only have to provide fig
# missing definitions are set to their default value. # file, i.e. a series of assignments. You only have to provide replacements
,
# missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE = RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an document. # Set optional variables used in the generation of an RTF document. Syntax
Syntax is similar to doxygen's config file. is
# similar to doxygen's config file. A template extensions file can be gener
ated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE = RTF_EXTENSIONS_FILE =
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# onfiguration options related to the man page output # Configuration options related to the man page output
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the GENERATE_MAN tag is set to YES will # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
generate man pages # classes and files.
# The default value is: NO.
GENERATE_MAN = NO GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. # The MAN_OUTPUT tag is used to specify where the man pages will be put. If
If a relative path is entered the value of OUTPUT_DIRECTORY will be a
put in of it. will be the default # relative path is entered the value of OUTPUT_DIRECTORY will be put in fro
nt of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to # The MAN_EXTENSION tag determines the extension that is added to the gener
the man the section ated
# man pages. In case the manual section does not start with a number, the n
umber
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3 MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and generates man output, # If the MAN_LINKS tag is set to YES and doxygen generates man output, then
then it will generate one additional man file for each entity it
documented in the man page(s). These additional files # will generate one additional man file for each entity documented in the r
only source the real man page, but them the man command eal
would be unable to find the correct page. The default NO. # man page(s). These additional files only source the real man page, but wi
thout
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# onfiguration options related to the XML output # Configuration options related to the XML output
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the GENERATE_XML tag is set to YES will # If the GENERATE_XML tag is set to YES doxygen will generate an XML file t
generate an XML file captures the structure of hat
the code including all documentation. # captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. # The XML_OUTPUT tag is used to specify where the XML pages will be put. If
If a relative path is entered the value of OUTPUT_DIRECTORY will be a
put in of it. default # relative path is entered the value of OUTPUT_DIRECTORY will be put in fro
nt of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify XML schema, # The XML_SCHEMA tag can be used to specify a XML schema, which can be used
which can be used by a validating XML parser to check the by a
syntax of the XML files. # validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_SCHEMA = XML_SCHEMA =
# The XML_DTD tag can be used to specify XML DTD, # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
which can be used by a validating XML parser to check the # validating XML parser to check the syntax of the XML files.
syntax of the XML files. # This tag requires that the tag GENERATE_XML is set to YES.
XML_DTD = XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES will # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
dump the program listings (including syntax highlighting # listings (including syntax highlighting and cross-referencing information
and cross-referencing to the XML output. Note that ) to
enabling this will significantly increase the of the XML output. # the XML output. Note that enabling this will significantly increase the s
ize
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES XML_PROGRAMLISTING = YES
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# output # Configuration options related to the DOCBOOK output
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the tag is set to YES will # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook f
# generate AutoGen Definitions (see file iles
that captures the structure of the code including all # that can be used to generate PDF.
documentation. Note that this feature is still # The default value is: NO.
# and incomplete at the moment.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be
put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put i
n
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#--------------------------------------------------------------------------
-
# Configuration options for the AutoGen Definitions output
#--------------------------------------------------------------------------
-
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an Au
toGen
# Definitions (see http://autogen.sf.net) file that captures the structure
of
# the code including all documentation. Note that this feature is still
# experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO GENERATE_AUTOGEN_DEF = NO
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# onfiguration options related to the Perl module output # Configuration options related to the Perl module output
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the GENERATE_PERLMOD tag is set to YES will # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl mo
generate a Perl file that captures the structure of dule
the code including all documentation. Note that this # file that captures the structure of the code including all documentation.
feature is still experimental and incomplete at the #
# # Note that this feature is still experimental and incomplete at the moment
.
# The default value is: NO.
GENERATE_PERLMOD = NO GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES will generate # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessar
the Makefile rules, Perl scripts and LaTeX code to be able y
to generate PDF DVI output from the Perl module output. # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF an
d DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be ni
# formatted so it can be parsed by a human reader. cely
This is useful # formatted so it can be parsed by a human reader. This is useful if you wa
if you to understand what is going on. nt to
On the other hand, if this # understand what is going on. On the other hand, if this tag is set to NO
tag is set to NO the size of the Perl module output will be much smaller the
and Perl will parse just the same. # size of the Perl module output will be much smaller and Perl will parse i
t
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file # The names of the make variables in the generated doxyrules.make file are
are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is use
This is so different doxyrules.make files included by the same ful
Makefile don't overwrite each other's variables. # so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX = PERLMOD_MAKEVAR_PREFIX =
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# Configuration options related to the preprocessor # Configuration options related to the preprocessor
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# If the ENABLE_PREPROCESSING tag is set to YES will # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
evaluate all C-preprocessor directives found in the sources and include # C-preprocessor directives found in the sources and include files.
files. # The default value is: YES.
ENABLE_PREPROCESSING = YES ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES will expand all macro # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro na
# in the source code. If set to NO only conditional mes
compilation will be performed. Macro expansion can be done in a # in the source code. If set to NO only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
way by setting EXPAND_ONLY_PREDEF to YES. # EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES th
# the macro expansion is limited to the macros specified with the en
and EXPAND_AS_DEFINED tags. # the macro expansion is limited to the macros specified with the PREDEFINE
D and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES the includes files # If the SEARCH_INCLUDES tag is set to YES the includes files in the
# INCLUDE_PATH will be searched a #include is found. # INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
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 # contain include files that are not input files but should be processed by
the preprocessor. the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH = 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 wil # directories. If left blank, the patterns specified with FILE_PATTERNS wil
l l be
be used. # used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS = INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that # The PREDEFINED tag can be used to specify one or more macro names that ar
# defined before the preprocessor is started (similar to the -D option e
of # defined before the preprocessor is started (similar to the -D option of e
# gcc). The argument of the tag is a list of macros of the form: name .g.
or name=definition (no spaces). If the definition and the are # gcc). The argument of the tag is a list of macros of the form: name or
# is assumed. To prevent a macro definition from being # name=definition (no spaces). If the definition and the "=" are omitted, "
undefined via #undef or recursively expanded use the := operator =1"
instead of the = operator. # is assumed. To prevent a macro definition from being undefined via #undef
or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then th
# tag can be used to specify a list of macro names that should be is
# tag can be used to specify a list of macro names that should be expanded.
The macro definition that is found in the sources will be used. The
Use the tag if you want to use a different macro definition # macro definition that is found in the sources will be used. Use the PREDE
FINED
overrules the definition found in the source code. # tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED = EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor
doxygen's preprocessor will remove all to function-like macros will
that are alone on a line, an all uppercase name, and do not end with # remove all refrences to function-like macros that are alone on a line, ha
a ve an
# will confuse the parser if not removed. # all uppercase name, and do not end with a semicolon. Such function macros
are
# typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = NO SKIP_FUNCTION_MACROS = NO
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# Configurationtions related to external references # Configuration options related to external references
#-------------------------------------------------------------------------- - #-------------------------------------------------------------------------- -
# The TAGFILES can be used to specify one or more For each # The TAGFILES tag can be used to specify one or more tag files. For each t
# file the location of the external documentation should be added. The ag
of a tag file without this location is as follows: # file the location of the external documentation should be added. The form
at of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ... # TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows: # Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ... # TAGFILES = file1=loc1 "file2 = loc2" ...
# where and can be relative or absolute paths # where loc1 and loc2 can be relative or absolute paths or URLs. See the
or URLs. tag file must have unique name (where the name # section "Linking to external documentation" for more information about th
does e use
NOT the path). If a tag file is not located in the directory in # of tag files.
# Note: Each tag file must have an unique name (where the name does NOT inc
doxygen is run, you must also specify the path to the tagfile here. lude
# the path). If a tag file is not located in the directory in which doxygen
TAGFILES = is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create # When a file name is specified after GENERATE_TAGFILE, doxygen will create
a tag file that is based on the input files it reads. a
# tag file that is based on the input files it reads. See section "Linking
to
# external documentation" for more information about the usage of tag files
.
GENERATE_TAGFILE = Stellarium.tag GENERATE_TAGFILE = Stellarium.tag
# If the ALLEXTERNALS tag is set to YES all external will be listed # If the ALLEXTERNALS tag is set to YES all external class will be listed i
the class index. If set to NO only the inherited external classes n the
will be # class index. If set to NO only the inherited external classes will be lis
ted.
# The default value is: NO.
ALLEXTERNALS = NO ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be list # If the EXTERNAL_GROUPS tag is set to YES all external groups will be list
ed ed in
in the modules index. If set to NO, only the current project's groups # the modules index. If set to NO, only the current project's groups will b
e
# listed. # listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = YES
# 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 w
ill
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script # The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of perl'). # interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /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 will # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class dia
generate a (in and LaTeX) for classes with gram
base # (in HTML and LaTeX) for classes with base or super classes. Setting the t
or super classes. Setting the to NO turns the diagrams off. Note that ag to
this option also works with HAVE_DOT disabled, but it is recommended to # NO turns the diagrams off. Note that this option also works with HAVE_DOT
install and use dot, since it yields powerful graphs. # disabled, but it is recommended to install and use dot, since it yields m
ore
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = NO CLASS_DIAGRAMS = NO
# You can define message sequence charts within doxygen comments using the \msc # You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool # command. Doxygen will then run the mscgen tool (see:
# to produce the chart and insert it in # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in
the the
# documentation. The MSCGEN_PATH tag allows you to specify the directory wh ere # documentation. The MSCGEN_PATH tag allows you to specify the directory wh ere
# the mscgen tool resides. If left empty the tool is assumed to be found in the # the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path. # default search path.
MSCGEN_PATH = MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide # You can include diagrams made with dia in doxygen documentation. Doxygen
# and usage relations if the target is undocumented will
or is not a class. # then run dia to produce the diagram and insert it in the documentation. T
he
# DIA_PATH tag allows you to specify the directory where the dia binary res
ides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES, the inheritance and collaboration graphs will hide inherit
ance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of a graph # available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lu
toolkit from AT&T and Bell Labs. The other options in this section cent
have no effect if this is set to NO # Bell Labs. The other options in this section have no effect if this optio
n is
# set to NO
# The default value is: NO.
HAVE_DOT = NO HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is al
# to run in parallel. When set to 0 doxygen will lowed
base this on the number of processors available in the system. You can # to run in parallel. When set to 0 doxygen will base this on the number of
it # processors available in the system. You can set it explicitly to a value
explicitly to a value larger than 0 to get control over the balance # larger than 0 to get control over the balance between CPU load and proces
between CPU load and speed. sing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
# # When you want a differently looking font n the dot files that doxygen
When you want a differently looking font you can # generates you can specify the font name using DOT_FONTNAME. You need to m
ake
the font name using DOT_FONTNAME. You need to sure dot is able to # sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or b
the font, which can be done by putting it in a standard location or by y
# setting DOT_FONTPATH to the directory containing the font.
the DOTFONTPATH environment variable or setting DOT_FONTPATH to the # The default value is: Helvetica.
directory containing the font. # This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = FreeSans DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot # The DOT_FONTSIZE tag can be used to set the size (in points) of the font
of
# default is # dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10 DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the # By default doxygen will tell dot to use the default font as specified wit
# If you specify a different font using DOT_FONTNAME you can h
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can
set the path where dot can find set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH = DOT_FONTPATH =
# If the CLASS_GRAPH set to YES then doxygen # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph f
will generate a graph each documented class showing the direct and or
indirect inheritance Setting this tag to YES will force the # each documented class showing the direct and indirect inheritance relatio
CLASS_DIAGRAMS tag to NO. ns.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = NO CLASS_GRAPH = NO
# If the COLLABORATION_GRAPH set to YES then doxygen # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
will generate a graph for each documented class showing the direct and # graph for each documented class showing the direct and indirect implement
indirect dependencies (inheritance, containment, and ation
class references variables) the class with other documented classes. # dependencies (inheritance, containment, and class references variables) o
f the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = NO COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS set to YES then doxygen # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph
will generate a graph for groups, showing the direct groups for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling # collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language. # Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside # If the UML_LOOK tag is enabled, the fields and methods are shown inside t
# class node. If there are many fields or methods and many nodes the he
graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS # class node. If there are many fields or methods and many nodes the graph
threshold limits number of items for each type to make the size more may
Set this to 0 for no limit. Note that the threshold may be # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits th
exceeded by 50% before the is enforced. e
# number of items for each type to make the size more manageable. Set this
to 0
# for no limit. Note that the threshold may be exceeded by 50% before the l
imit
# is enforced. So when you set the threshold to 10, up to 15 fields may app
ear,
# but if the number exceeds 15, the total amount of fields shown is limited
to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10 UML_LIMIT_NUM_FIELDS = 10
# If set to the inheritance and collaboration graphs will show the # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
relations between templates and their instances. # collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, and # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are s
tags are to YES then doxygen will generate a graph for each et to
# YES then doxygen will generate a graph for each documented file showing t
file showing direct and indirect include dependencies of the file he
# direct and indirect include dependencies of the file with other documente
other files. d
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, and # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags a
tags set to YES then doxygen will generate a graph for each re
documented file # set to YES then doxygen will generate a graph for each documented file sh
# include owing
# the direct and indirect include dependencies of the file with other docum
ented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH set to YES then # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
doxygen will generate a call dependency graph for every global function # dependency graph for every global function or class method.
or class method. Note that enabling this option will significantly #
# Note that enabling this option will significantly increase the time of a
the time of a run. So in most cases it will be better to enable call run.
# So in most cases it will be better to enable call graphs for selected
for selected functions only using the \callgraph command. # functions only using the \callgraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO CALL_GRAPH = NO
# If the CALLER_GRAPH set to YES then # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
doxygen will generate a caller dependency graph for every global function # dependency graph for every global function or class method.
or class method. Note that enabling this option will significantly #
# Note that enabling this option will significantly increase the time of a
the time of a run. So in most cases it will be better to enable caller run.
graphs for selected functions only using the \callergraph command. # So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY set to YES then doxygen # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
will graphical hierarchy of all classes instead of a textual # hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES GRAPHICAL_HIERARCHY = YES
# If the set to YES # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
then doxygen will show the dependencies a directory has on other # dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
in a graphical way. The dependency relations are determined by the # files in the directories.
# The default value is: YES.
relations between the files in the directories. # This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the image s # The DOT_IMAGE_FORMAT tag can be used to set the image format of the image s
# generated by dot. # generated by dot.
# If you choose svg you need to set # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in o
HTML_FILE_EXTENSION to xhtml in to make the SVG files rder
visible in IE 9+ (other browsers do not have this requirement). # to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif and svg.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and pannin g. # enable generation of interactive SVG images that allow zooming and pannin g.
# Note that this requires a modern browser other than Internet Explorer. #
# and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you # Note that this requires a modern browser other than Internet Explorer. Te
need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files sted
visible. Older versions of IE do not have SVG support. # and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to
make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO INTERACTIVE_SVG = NO
# The can be used to specify the path where the dot tool can b e # The DOT_PATH tag can be used to specify the path where the dot tool can b e
# found. If left blank, it is assumed the dot tool can be found in the path . # found. If left blank, it is assumed the dot tool can be found in the path .
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH = DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that # The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the # contain dot files that are included in the documentation (see the \dotfil
# command). e
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS = DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that # The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the # contain msc files that are included in the documentation (see the \mscfil
# command). e
# command).
MSCFILE_DIRS = MSCFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # The DIAFILE_DIRS tag can be used to specify one or more directories that
# that will be shown in the graph. If the number of nodes in a graph # contain dia files that are included in the documentation (see the \diafil
# larger than this value, doxygen will truncate the graph, which is e
# by representing a node as a red box. Note that doxygen if the # command).
number of children of the root node in a graph is already larger
DIAFILE_DIRS =
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# the size of a graph can be further restricted by # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of node
s
# that will be shown in the graph. If the number of nodes in a graph become
s
# larger than this value, doxygen will truncate the graph, which is visuali
zed
# by representing a node as a red box. Note that doxygen if the number of d
irect
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note th
at
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50 DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the g
# generated by dot. A depth value of 3 means that only nodes raphs
# generated by dot. A depth value of 3 means that only nodes reachable from
from the root by following a path via at most 3 edges will be shown. the
# root by following a path via at most 3 edges will be shown. Nodes that la
that further from the root node will be omitted. Note that setting y
# further from the root node will be omitted. Note that setting this option
option to 1 or 2 may greatly reduce the computation time needed for large to 1
code bases. Also note that the size of a graph can be further restricted # or 2 may greatly reduce the computation time needed for large code bases.
by Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 1000 MAX_DOT_GRAPH_DEPTH = 1000
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not # background. This is disabled by default, because dot on Windows does not
seem to support this out of the box. Warning: Depending on the platform seem
# to support this out of the box.
enabling this option may lead to badly anti-aliased labels on the edges #
# Warning: Depending on the platform used, enabling this option may lead to
a graph (i.e. they become hard to read). # badly anti-aliased labels on the edges of a graph (i.e. they become hard
to
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple outpu t # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple outpu t
# files in one run (i.e. multiple -o and -T options on the command line). T his # files in one run (i.e. multiple -o and -T options on the command line). T his
# makes dot run faster, but since only newer versions of dot (>1.8.10) # makes dot run faster, but since only newer versions of dot (>1.8.10) supp
# this, this feature is disabled by default. ort
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES will # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend p
generate a legend explaining the meaning of the various boxes and age
arrows in the dot graphs. # explaining the meaning of the various boxes and arrows in the dot generat
ed
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES will # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate
remove the intermediate dot files that are used to generate dot
the various graphs. # files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES DOT_CLEANUP = YES
End of changes. 271 change blocks.
1086 lines changed or deleted 1970 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/