robert@500: # Doxyfile 1.8.11 andrewm@47: andrewm@47: # This file describes the settings to be used by the documentation system andrewm@47: # doxygen (www.doxygen.org) for a project. andrewm@47: # robert@500: # All text after a double hash (##) is considered a comment and is placed in robert@500: # front of the TAG it is preceding. robert@500: # robert@500: # All text after a single hash (#) is considered a comment and will be ignored. andrewm@47: # The format is: robert@500: # TAG = value [value, ...] robert@500: # For lists, items can also be appended using: robert@500: # TAG += value [value, ...] robert@500: # Values that contain spaces should be placed between quotes (\" \"). andrewm@47: andrewm@47: #--------------------------------------------------------------------------- andrewm@47: # Project related configuration options andrewm@47: #--------------------------------------------------------------------------- andrewm@47: andrewm@47: # This tag specifies the encoding used for all characters in the config file robert@500: # that follow. The default is UTF-8 which is also the encoding used for all text robert@500: # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv robert@500: # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv robert@500: # for the list of possible encodings. robert@500: # The default value is: UTF-8. andrewm@47: andrewm@47: DOXYFILE_ENCODING = UTF-8 andrewm@47: robert@500: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by robert@500: # double-quotes, unless you are using Doxywizard) that should identify the robert@500: # project for which the documentation is generated. This name is used in the robert@500: # title of most generated pages and in a few other places. robert@500: # The default value is: My Project. andrewm@47: l@408: PROJECT_NAME = "Bela" andrewm@47: robert@500: # The PROJECT_NUMBER tag can be used to enter a project or revision number. This robert@500: # could be handy for archiving the generated documentation or if some version robert@500: # control system is used. andrewm@47: andrewm@47: PROJECT_NUMBER = andrewm@47: andrewm@47: # Using the PROJECT_BRIEF tag one can provide an optional one line description robert@500: # for a project that appears at the top of each page and should give viewer a robert@500: # quick idea about the purpose of the project. Keep the description short. andrewm@47: andrewm@47: PROJECT_BRIEF = "Real-time, ultra-low-latency audio and sensor processing system for BeagleBone Black" andrewm@47: robert@500: # With the PROJECT_LOGO tag one can specify a logo or an icon that is included robert@500: # in the documentation. The maximum height of the logo should not exceed 55 robert@500: # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy robert@500: # the logo to the output directory. andrewm@47: andrewm@47: PROJECT_LOGO = andrewm@47: robert@500: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path robert@500: # into which the generated documentation will be written. If a relative path is robert@500: # entered, it will be relative to the location where doxygen was started. If robert@500: # left blank the current directory will be used. andrewm@47: l@407: OUTPUT_DIRECTORY = Documentation andrewm@47: robert@500: # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- robert@500: # directories (in 2 levels) under the output directory of each output format and robert@500: # will distribute the generated files over these directories. Enabling this robert@500: # option can be useful when feeding doxygen a huge amount of source files, where robert@500: # putting all generated files in the same directory would otherwise causes robert@500: # performance problems for the file system. robert@500: # The default value is: NO. andrewm@47: andrewm@47: CREATE_SUBDIRS = NO andrewm@47: robert@500: # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII robert@500: # characters to appear in the names of generated files. If set to NO, non-ASCII robert@500: # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode robert@500: # U+3044. robert@500: # The default value is: NO. robert@500: robert@500: ALLOW_UNICODE_NAMES = NO robert@500: andrewm@47: # The OUTPUT_LANGUAGE tag is used to specify the language in which all andrewm@47: # documentation generated by doxygen is written. Doxygen will use this andrewm@47: # information to generate all constant output in the proper language. robert@500: # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, robert@500: # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), robert@500: # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, robert@500: # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), robert@500: # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, robert@500: # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, robert@500: # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, robert@500: # Ukrainian and Vietnamese. robert@500: # The default value is: English. andrewm@47: andrewm@47: OUTPUT_LANGUAGE = English andrewm@47: robert@500: # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member robert@500: # descriptions after the members that are listed in the file and class robert@500: # documentation (similar to Javadoc). Set to NO to disable this. robert@500: # The default value is: YES. andrewm@47: andrewm@47: BRIEF_MEMBER_DESC = YES andrewm@47: robert@500: # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief robert@500: # description of a member or function before the detailed description robert@500: # robert@500: # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the andrewm@47: # brief descriptions will be completely suppressed. robert@500: # The default value is: YES. andrewm@47: andrewm@47: REPEAT_BRIEF = YES andrewm@47: robert@500: # This tag implements a quasi-intelligent brief description abbreviator that is robert@500: # used to form the text in various listings. Each string in this list, if found robert@500: # as the leading text of the brief description, will be stripped from the text robert@500: # and the result, after processing the whole list, is used as the annotated robert@500: # text. Otherwise, the brief description is used as-is. If left blank, the robert@500: # following values are used ($name is automatically replaced with the name of robert@500: # the entity):The $name class, The $name widget, The $name file, is, provides, robert@500: # specifies, contains, represents, a, an and the. andrewm@47: andrewm@47: ABBREVIATE_BRIEF = andrewm@47: andrewm@47: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then robert@500: # doxygen will generate a detailed section even if there is only a brief andrewm@47: # description. robert@500: # The default value is: NO. andrewm@47: andrewm@47: ALWAYS_DETAILED_SEC = NO andrewm@47: andrewm@47: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all andrewm@47: # inherited members of a class in the documentation of that class as if those andrewm@47: # members were ordinary class members. Constructors, destructors and assignment andrewm@47: # operators of the base classes will not be shown. robert@500: # The default value is: NO. andrewm@47: andrewm@47: INLINE_INHERITED_MEMB = NO andrewm@47: robert@500: # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path robert@500: # before files name in the file list and in the header files. If set to NO the robert@500: # shortest path that makes the file name unique will be used robert@500: # The default value is: YES. andrewm@47: andrewm@47: FULL_PATH_NAMES = YES andrewm@47: robert@500: # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. robert@500: # Stripping is only done if one of the specified strings matches the left-hand robert@500: # part of the path. The tag can be used to show relative paths in the file list. robert@500: # If left blank the directory from which doxygen is run is used as the path to robert@500: # strip. robert@500: # robert@500: # Note that you can specify absolute paths here, but also relative paths, which robert@500: # will be relative from the directory where doxygen is started. robert@500: # This tag requires that the tag FULL_PATH_NAMES is set to YES. andrewm@47: andrewm@47: STRIP_FROM_PATH = andrewm@47: robert@500: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the robert@500: # path mentioned in the documentation of a class, which tells the reader which robert@500: # header file to include in order to use a class. If left blank only the name of robert@500: # the header file containing the class definition is used. Otherwise one should robert@500: # specify the list of include paths that are normally passed to the compiler robert@500: # using the -I flag. andrewm@47: andrewm@47: STRIP_FROM_INC_PATH = andrewm@47: robert@500: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but robert@500: # less readable) file names. This can be useful is your file systems doesn't robert@500: # support long names like on DOS, Mac, or CD-ROM. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SHORT_NAMES = NO andrewm@47: robert@500: # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the robert@500: # first line (until the first dot) of a Javadoc-style comment as the brief robert@500: # description. If set to NO, the Javadoc-style will behave just like regular Qt- robert@500: # style comments (thus requiring an explicit @brief command for a brief robert@500: # description.) robert@500: # The default value is: NO. andrewm@47: andrewm@47: JAVADOC_AUTOBRIEF = NO andrewm@47: robert@500: # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first robert@500: # line (until the first dot) of a Qt-style comment as the brief description. If robert@500: # set to NO, the Qt-style will behave just like regular Qt-style comments (thus robert@500: # requiring an explicit \brief command for a brief description.) robert@500: # The default value is: NO. andrewm@47: andrewm@47: QT_AUTOBRIEF = NO andrewm@47: robert@500: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a robert@500: # multi-line C++ special comment block (i.e. a block of //! or /// comments) as robert@500: # a brief description. This used to be the default behavior. The new default is robert@500: # to treat a multi-line C++ comment block as a detailed description. Set this robert@500: # tag to YES if you prefer the old behavior instead. robert@500: # robert@500: # Note that setting this tag to YES also means that rational rose comments are robert@500: # not recognized any more. robert@500: # The default value is: NO. andrewm@47: andrewm@47: MULTILINE_CPP_IS_BRIEF = NO andrewm@47: robert@500: # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the robert@500: # documentation from any documented member that it re-implements. robert@500: # The default value is: YES. andrewm@47: andrewm@47: INHERIT_DOCS = YES andrewm@47: robert@500: # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new robert@500: # page for each member. If set to NO, the documentation of a member will be part robert@500: # of the file/class/namespace that contains it. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SEPARATE_MEMBER_PAGES = NO andrewm@47: robert@500: # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen robert@500: # uses this value to replace tabs by spaces in code fragments. robert@500: # Minimum value: 1, maximum value: 16, default value: 4. andrewm@47: andrewm@47: TAB_SIZE = 8 andrewm@47: robert@500: # This tag can be used to specify a number of aliases that act as commands in robert@500: # the documentation. An alias has the form: robert@500: # name=value robert@500: # For example adding robert@500: # "sideeffect=@par Side Effects:\n" robert@500: # will allow you to put the command \sideeffect (or @sideeffect) in the robert@500: # documentation, which will result in a user-defined paragraph with heading robert@500: # "Side Effects:". You can put \n's in the value part of an alias to insert robert@500: # newlines. andrewm@47: andrewm@47: ALIASES = andrewm@47: andrewm@47: # This tag can be used to specify a number of word-keyword mappings (TCL only). robert@500: # A mapping has the form "name=value". For example adding "class=itcl::class" robert@500: # will allow you to use the command class in the itcl::class meaning. andrewm@47: andrewm@47: TCL_SUBST = andrewm@47: robert@500: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources robert@500: # only. Doxygen will then generate output that is more tailored for C. For robert@500: # instance, some of the names that are used will be different. The list of all robert@500: # members will be omitted, etc. robert@500: # The default value is: NO. andrewm@47: andrewm@47: OPTIMIZE_OUTPUT_FOR_C = NO andrewm@47: robert@500: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or robert@500: # Python sources only. Doxygen will then generate output that is more tailored robert@500: # for that language. For instance, namespaces will be presented as packages, robert@500: # qualified scopes will look different, etc. robert@500: # The default value is: NO. andrewm@47: andrewm@47: OPTIMIZE_OUTPUT_JAVA = NO andrewm@47: andrewm@47: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran robert@500: # sources. Doxygen will then generate output that is tailored for Fortran. robert@500: # The default value is: NO. andrewm@47: andrewm@47: OPTIMIZE_FOR_FORTRAN = NO andrewm@47: andrewm@47: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL robert@500: # sources. Doxygen will then generate output that is tailored for VHDL. robert@500: # The default value is: NO. andrewm@47: andrewm@47: OPTIMIZE_OUTPUT_VHDL = NO andrewm@47: andrewm@47: # Doxygen selects the parser to use depending on the extension of the files it robert@500: # parses. With this tag you can assign which parser to use for a given robert@500: # extension. Doxygen has a built-in mapping, but you can override or extend it robert@500: # using this tag. The format is ext=language, where ext is a file extension, and robert@500: # language is one of the parsers supported by doxygen: IDL, Java, Javascript, robert@500: # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: robert@500: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: robert@500: # Fortran. In the later case the parser tries to guess whether the code is fixed robert@500: # or free formatted code, this is the default for Fortran type files), VHDL. For robert@500: # instance to make doxygen treat .inc files as Fortran files (default is PHP), robert@500: # and .f files as C (default is Fortran), use: inc=Fortran f=C. robert@500: # robert@500: # Note: For files without extension you can use no_extension as a placeholder. robert@500: # robert@500: # Note that for custom extensions you also need to set FILE_PATTERNS otherwise robert@500: # the files are not read by doxygen. andrewm@47: andrewm@47: EXTENSION_MAPPING = andrewm@47: robert@500: # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments robert@500: # according to the Markdown format, which allows for more readable robert@500: # documentation. See http://daringfireball.net/projects/markdown/ for details. robert@500: # The output of markdown processing is further processed by doxygen, so you can robert@500: # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in robert@500: # case of backward compatibilities issues. robert@500: # The default value is: YES. robert@500: robert@500: MARKDOWN_SUPPORT = YES robert@500: robert@500: # When enabled doxygen tries to link words that correspond to documented robert@500: # classes, or namespaces to their corresponding documentation. Such a link can robert@500: # be prevented in individual cases by putting a % sign in front of the word or robert@500: # globally by setting AUTOLINK_SUPPORT to NO. robert@500: # The default value is: YES. robert@500: robert@500: AUTOLINK_SUPPORT = YES robert@500: andrewm@47: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want robert@500: # to include (a tag file for) the STL sources as input, then you should set this robert@500: # tag to YES in order to let doxygen match functions declarations and robert@500: # definitions whose arguments contain STL classes (e.g. func(std::string); robert@500: # versus func(std::string) {}). This also make the inheritance and collaboration andrewm@47: # diagrams that involve STL classes more complete and accurate. robert@500: # The default value is: NO. andrewm@47: andrewm@47: BUILTIN_STL_SUPPORT = NO andrewm@47: andrewm@47: # If you use Microsoft's C++/CLI language, you should set this option to YES to andrewm@47: # enable parsing support. robert@500: # The default value is: NO. andrewm@47: andrewm@47: CPP_CLI_SUPPORT = NO andrewm@47: robert@500: # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: robert@500: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen robert@500: # will parse them like normal C++ but will assume all classes use public instead robert@500: # of private inheritance when no explicit protection keyword is present. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SIP_SUPPORT = NO andrewm@47: robert@500: # For Microsoft's IDL there are propget and propput attributes to indicate robert@500: # getter and setter methods for a property. Setting this option to YES will make robert@500: # doxygen to replace the get and set methods by a property in the documentation. robert@500: # This will only work if the methods are indeed getting or setting a simple robert@500: # type. If this is not the case, or you want to show the methods anyway, you robert@500: # should set this option to NO. robert@500: # The default value is: YES. andrewm@47: andrewm@47: IDL_PROPERTY_SUPPORT = YES andrewm@47: andrewm@47: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC robert@500: # tag is set to YES then doxygen will reuse the documentation of the first andrewm@47: # member in the group (if any) for the other members of the group. By default andrewm@47: # all members of a group must be documented explicitly. robert@500: # The default value is: NO. andrewm@47: andrewm@47: DISTRIBUTE_GROUP_DOC = NO andrewm@47: robert@500: # If one adds a struct or class to a group and this option is enabled, then also robert@500: # any nested class or struct is added to the same group. By default this option robert@500: # is disabled and one has to add nested compounds explicitly via \ingroup. robert@500: # The default value is: NO. robert@500: robert@500: GROUP_NESTED_COMPOUNDS = NO robert@500: robert@500: # Set the SUBGROUPING tag to YES to allow class member groups of the same type robert@500: # (for instance a group of public functions) to be put as a subgroup of that robert@500: # type (e.g. under the Public Functions section). Set it to NO to prevent robert@500: # subgrouping. Alternatively, this can be done per class using the robert@500: # \nosubgrouping command. robert@500: # The default value is: YES. andrewm@47: andrewm@47: SUBGROUPING = YES andrewm@47: robert@500: # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions robert@500: # are shown inside the group in which they are included (e.g. using \ingroup) robert@500: # instead of on a separate page (for HTML and Man pages) or section (for LaTeX robert@500: # and RTF). robert@500: # robert@500: # Note that this feature does not work in combination with robert@500: # SEPARATE_MEMBER_PAGES. robert@500: # The default value is: NO. andrewm@47: andrewm@47: INLINE_GROUPED_CLASSES = NO andrewm@47: robert@500: # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions robert@500: # with only public data fields or simple typedef fields will be shown inline in robert@500: # the documentation of the scope in which they are defined (i.e. file, robert@500: # namespace, or group documentation), provided this scope is documented. If set robert@500: # to NO, structs, classes, and unions are shown on a separate page (for HTML and robert@500: # Man pages) or section (for LaTeX and RTF). robert@500: # The default value is: NO. andrewm@47: andrewm@47: INLINE_SIMPLE_STRUCTS = NO andrewm@47: robert@500: # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or robert@500: # enum is documented as struct, union, or enum with the name of the typedef. So andrewm@47: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct andrewm@47: # with name TypeT. When disabled the typedef will appear as a member of a file, robert@500: # namespace, or class. And the struct will be named TypeS. This can typically be robert@500: # useful for C code in case the coding convention dictates that all compound andrewm@47: # types are typedef'ed and only the typedef is referenced, never the tag name. robert@500: # The default value is: NO. andrewm@47: andrewm@47: TYPEDEF_HIDES_STRUCT = NO andrewm@47: robert@500: # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This robert@500: # cache is used to resolve symbols given their name and scope. Since this can be robert@500: # an expensive process and often the same symbol appears multiple times in the robert@500: # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small robert@500: # doxygen will become slower. If the cache is too large, memory is wasted. The robert@500: # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range robert@500: # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 robert@500: # symbols. At the end of a run doxygen will report the cache usage and suggest robert@500: # the optimal cache size from a speed point of view. robert@500: # Minimum value: 0, maximum value: 9, default value: 0. andrewm@47: andrewm@47: LOOKUP_CACHE_SIZE = 0 andrewm@47: andrewm@47: #--------------------------------------------------------------------------- andrewm@47: # Build related configuration options andrewm@47: #--------------------------------------------------------------------------- andrewm@47: robert@500: # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in robert@500: # documentation are documented, even if no documentation was available. Private robert@500: # class members and static file members will be hidden unless the robert@500: # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. robert@500: # Note: This will also disable the warnings about undocumented members that are robert@500: # normally produced when WARNINGS is set to YES. robert@500: # The default value is: NO. andrewm@47: andrewm@47: EXTRACT_ALL = NO andrewm@47: robert@500: # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will robert@500: # be included in the documentation. robert@500: # The default value is: NO. andrewm@47: andrewm@47: EXTRACT_PRIVATE = NO andrewm@47: robert@500: # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal robert@500: # scope will be included in the documentation. robert@500: # The default value is: NO. robert@500: robert@500: EXTRACT_PACKAGE = NO robert@500: robert@500: # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be robert@500: # included in the documentation. robert@500: # The default value is: NO. andrewm@47: giuliomoro@208: EXTRACT_STATIC = YES andrewm@47: robert@500: # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined robert@500: # locally in source files will be included in the documentation. If set to NO, robert@500: # only classes defined in header files are included. Does not have any effect robert@500: # for Java sources. robert@500: # The default value is: YES. andrewm@47: andrewm@47: EXTRACT_LOCAL_CLASSES = YES andrewm@47: robert@500: # This flag is only useful for Objective-C code. If set to YES, local methods, robert@500: # which are defined in the implementation section but not in the interface are robert@500: # included in the documentation. If set to NO, only methods in the interface are robert@500: # included. robert@500: # The default value is: NO. andrewm@47: andrewm@47: EXTRACT_LOCAL_METHODS = NO andrewm@47: andrewm@47: # If this flag is set to YES, the members of anonymous namespaces will be andrewm@47: # extracted and appear in the documentation as a namespace called robert@500: # 'anonymous_namespace{file}', where file will be replaced with the base name of robert@500: # the file that contains the anonymous namespace. By default anonymous namespace robert@500: # are hidden. robert@500: # The default value is: NO. andrewm@47: andrewm@47: EXTRACT_ANON_NSPACES = NO andrewm@47: robert@500: # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all robert@500: # undocumented members inside documented classes or files. If set to NO these robert@500: # members will be included in the various overviews, but no documentation robert@500: # section is generated. This option has no effect if EXTRACT_ALL is enabled. robert@500: # The default value is: NO. andrewm@47: andrewm@47: HIDE_UNDOC_MEMBERS = NO andrewm@47: robert@500: # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all robert@500: # undocumented classes that are normally visible in the class hierarchy. If set robert@500: # to NO, these classes will be included in the various overviews. This option robert@500: # has no effect if EXTRACT_ALL is enabled. robert@500: # The default value is: NO. andrewm@47: andrewm@47: HIDE_UNDOC_CLASSES = NO andrewm@47: robert@500: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend robert@500: # (class|struct|union) declarations. If set to NO, these declarations will be robert@500: # included in the documentation. robert@500: # The default value is: NO. andrewm@47: andrewm@47: HIDE_FRIEND_COMPOUNDS = NO andrewm@47: robert@500: # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any robert@500: # documentation blocks found inside the body of a function. If set to NO, these robert@500: # blocks will be appended to the function's detailed documentation block. robert@500: # The default value is: NO. andrewm@47: andrewm@47: HIDE_IN_BODY_DOCS = NO andrewm@47: robert@500: # The INTERNAL_DOCS tag determines if documentation that is typed after a robert@500: # \internal command is included. If the tag is set to NO then the documentation robert@500: # will be excluded. Set it to YES to include the internal documentation. robert@500: # The default value is: NO. andrewm@47: andrewm@47: INTERNAL_DOCS = NO andrewm@47: robert@500: # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file robert@500: # names in lower-case letters. If set to YES, upper-case letters are also andrewm@47: # allowed. This is useful if you have classes or files whose names only differ andrewm@47: # in case and if your file system supports case sensitive file names. Windows andrewm@47: # and Mac users are advised to set this option to NO. robert@500: # The default value is: system dependent. andrewm@47: andrewm@47: CASE_SENSE_NAMES = YES andrewm@47: robert@500: # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with robert@500: # their full class and namespace scopes in the documentation. If set to YES, the robert@500: # scope will be hidden. robert@500: # The default value is: NO. andrewm@47: andrewm@47: HIDE_SCOPE_NAMES = NO andrewm@47: robert@500: # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will robert@500: # append additional text to a page's title, such as Class Reference. If set to robert@500: # YES the compound reference will be hidden. robert@500: # The default value is: NO. robert@500: robert@500: HIDE_COMPOUND_REFERENCE= NO robert@500: robert@500: # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of robert@500: # the files that are included by a file in the documentation of that file. robert@500: # The default value is: YES. andrewm@47: andrewm@47: SHOW_INCLUDE_FILES = YES andrewm@47: robert@500: # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each robert@500: # grouped member an include statement to the documentation, telling the reader robert@500: # which file to include in order to use the member. robert@500: # The default value is: NO. robert@500: robert@500: SHOW_GROUPED_MEMB_INC = NO robert@500: robert@500: # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include robert@500: # files with double quotes in the documentation rather than with sharp brackets. robert@500: # The default value is: NO. andrewm@47: andrewm@47: FORCE_LOCAL_INCLUDES = NO andrewm@47: robert@500: # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the robert@500: # documentation for inline members. robert@500: # The default value is: YES. andrewm@47: andrewm@47: INLINE_INFO = YES andrewm@47: robert@500: # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the robert@500: # (detailed) documentation of file and class members alphabetically by member robert@500: # name. If set to NO, the members will appear in declaration order. robert@500: # The default value is: YES. andrewm@47: andrewm@47: SORT_MEMBER_DOCS = NO andrewm@47: robert@500: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief robert@500: # descriptions of file, namespace and class members alphabetically by member robert@500: # name. If set to NO, the members will appear in declaration order. Note that robert@500: # this will also influence the order of the classes in the class list. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SORT_BRIEF_DOCS = NO andrewm@47: robert@500: # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the robert@500: # (brief and detailed) documentation of class members so that constructors and robert@500: # destructors are listed first. If set to NO the constructors will appear in the robert@500: # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. robert@500: # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief robert@500: # member documentation. robert@500: # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting robert@500: # detailed member documentation. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SORT_MEMBERS_CTORS_1ST = NO andrewm@47: robert@500: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy robert@500: # of group names into alphabetical order. If set to NO the group names will robert@500: # appear in their defined order. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SORT_GROUP_NAMES = NO andrewm@47: robert@500: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by robert@500: # fully-qualified names, including namespaces. If set to NO, the class list will robert@500: # be sorted only by class name, not including the namespace part. andrewm@47: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. robert@500: # Note: This option applies only to the class list, not to the alphabetical robert@500: # list. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SORT_BY_SCOPE_NAME = NO andrewm@47: robert@500: # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper robert@500: # type resolution of all parameters of a function it will reject a match between robert@500: # the prototype and the implementation of a member function even if there is robert@500: # only one candidate or it is obvious which candidate to choose by doing a robert@500: # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still robert@500: # accept a match between prototype and implementation in such cases. robert@500: # The default value is: NO. andrewm@47: andrewm@47: STRICT_PROTO_MATCHING = NO andrewm@47: robert@500: # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo robert@500: # list. This list is created by putting \todo commands in the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: GENERATE_TODOLIST = YES andrewm@47: robert@500: # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test robert@500: # list. This list is created by putting \test commands in the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: GENERATE_TESTLIST = YES andrewm@47: robert@500: # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug robert@500: # list. This list is created by putting \bug commands in the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: GENERATE_BUGLIST = YES andrewm@47: robert@500: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) robert@500: # the deprecated list. This list is created by putting \deprecated commands in robert@500: # the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: GENERATE_DEPRECATEDLIST= YES andrewm@47: robert@500: # The ENABLED_SECTIONS tag can be used to enable conditional documentation robert@500: # sections, marked by \if ... \endif and \cond robert@500: # ... \endcond blocks. andrewm@47: andrewm@47: ENABLED_SECTIONS = andrewm@47: robert@500: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the robert@500: # initial value of a variable or macro / define can have for it to appear in the robert@500: # documentation. If the initializer consists of more lines than specified here robert@500: # it will be hidden. Use a value of 0 to hide initializers completely. The robert@500: # appearance of the value of individual variables and macros / defines can be robert@500: # controlled using \showinitializer or \hideinitializer command in the robert@500: # documentation regardless of this setting. robert@500: # Minimum value: 0, maximum value: 10000, default value: 30. andrewm@47: andrewm@47: MAX_INITIALIZER_LINES = 30 andrewm@47: robert@500: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at robert@500: # the bottom of the documentation of classes and structs. If set to YES, the andrewm@47: # list will mention the files that were used to generate the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: SHOW_USED_FILES = YES andrewm@47: robert@500: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This robert@500: # will remove the Files entry from the Quick Index and from the Folder Tree View robert@500: # (if specified). robert@500: # The default value is: YES. andrewm@47: andrewm@47: SHOW_FILES = YES andrewm@47: robert@500: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces robert@500: # page. This will remove the Namespaces entry from the Quick Index and from the robert@500: # Folder Tree View (if specified). robert@500: # The default value is: YES. andrewm@47: andrewm@47: SHOW_NAMESPACES = YES andrewm@47: andrewm@47: # The FILE_VERSION_FILTER tag can be used to specify a program or script that andrewm@47: # doxygen should invoke to get the current version for each file (typically from andrewm@47: # the version control system). Doxygen will invoke the program by executing (via robert@500: # popen()) the command command input-file, where command is the value of the robert@500: # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided robert@500: # by doxygen. Whatever the program writes to standard output is used as the file robert@500: # version. For an example see the documentation. andrewm@47: andrewm@47: FILE_VERSION_FILTER = andrewm@47: andrewm@47: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed andrewm@47: # by doxygen. The layout file controls the global structure of the generated robert@500: # output files in an output format independent way. To create the layout file robert@500: # that represents doxygen's defaults, run doxygen with the -l option. You can robert@500: # optionally specify a file name after the option, if omitted DoxygenLayout.xml robert@500: # will be used as the name of the layout file. robert@500: # robert@500: # Note that if you run doxygen from a directory containing a file called robert@500: # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE robert@500: # tag is left empty. andrewm@47: andrewm@47: LAYOUT_FILE = andrewm@47: robert@500: # The CITE_BIB_FILES tag can be used to specify one or more bib files containing robert@500: # the reference definitions. This must be a list of .bib files. The .bib robert@500: # extension is automatically appended if omitted. This requires the bibtex tool robert@500: # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. robert@500: # For LaTeX the style of the bibliography can be controlled using robert@500: # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the robert@500: # search path. See also \cite for info how to create references. andrewm@47: andrewm@47: CITE_BIB_FILES = andrewm@47: andrewm@47: #--------------------------------------------------------------------------- robert@500: # Configuration options related to warning and progress messages andrewm@47: #--------------------------------------------------------------------------- andrewm@47: robert@500: # The QUIET tag can be used to turn on/off the messages that are generated to robert@500: # standard output by doxygen. If QUIET is set to YES this implies that the robert@500: # messages are off. robert@500: # The default value is: NO. andrewm@47: andrewm@47: QUIET = NO andrewm@47: andrewm@47: # The WARNINGS tag can be used to turn on/off the warning messages that are robert@500: # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES robert@500: # this implies that the warnings are on. robert@500: # robert@500: # Tip: Turn warnings on while writing the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: WARNINGS = YES andrewm@47: robert@500: # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate robert@500: # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag robert@500: # will automatically be disabled. robert@500: # The default value is: YES. andrewm@47: andrewm@47: WARN_IF_UNDOCUMENTED = YES andrewm@47: robert@500: # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for robert@500: # potential errors in the documentation, such as not documenting some parameters robert@500: # in a documented function, or documenting parameters that don't exist or using robert@500: # markup commands wrongly. robert@500: # The default value is: YES. andrewm@47: andrewm@47: WARN_IF_DOC_ERROR = YES andrewm@47: robert@500: # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that robert@500: # are documented, but have no documentation for their parameters or return robert@500: # value. If set to NO, doxygen will only warn about wrong or incomplete robert@500: # parameter documentation, but not about the absence of documentation. robert@500: # The default value is: NO. andrewm@47: andrewm@47: WARN_NO_PARAMDOC = NO andrewm@47: robert@500: # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when robert@500: # a warning is encountered. robert@500: # The default value is: NO. robert@500: robert@500: WARN_AS_ERROR = NO robert@500: robert@500: # The WARN_FORMAT tag determines the format of the warning messages that doxygen robert@500: # can produce. The string should contain the $file, $line, and $text tags, which robert@500: # will be replaced by the file and line number from which the warning originated robert@500: # and the warning text. Optionally the format may contain $version, which will robert@500: # be replaced by the version of the file (if it could be obtained via robert@500: # FILE_VERSION_FILTER) robert@500: # The default value is: $file:$line: $text. andrewm@47: andrewm@47: WARN_FORMAT = "$file:$line: $text" andrewm@47: robert@500: # The WARN_LOGFILE tag can be used to specify a file to which warning and error robert@500: # messages should be written. If left blank the output is written to standard robert@500: # error (stderr). andrewm@47: andrewm@47: WARN_LOGFILE = andrewm@47: andrewm@47: #--------------------------------------------------------------------------- robert@500: # Configuration options related to the input files andrewm@47: #--------------------------------------------------------------------------- andrewm@47: robert@500: # The INPUT tag is used to specify the files and/or directories that contain robert@500: # documented source files. You may enter file names like myfile.cpp or robert@500: # directories like /usr/src/myproject. Separate the files or directories with robert@500: # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING robert@500: # Note: If this tag is empty the current directory is searched. robert@500: robert@524: INPUT = include/ examples/ andrewm@47: andrewm@47: # This tag can be used to specify the character encoding of the source files robert@500: # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses robert@500: # libiconv (or the iconv built into libc) for the transcoding. See the libiconv robert@500: # documentation (see: http://www.gnu.org/software/libiconv) for the list of robert@500: # possible encodings. robert@500: # The default value is: UTF-8. andrewm@47: andrewm@47: INPUT_ENCODING = UTF-8 andrewm@47: andrewm@47: # If the value of the INPUT tag contains directories, you can use the robert@500: # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and robert@500: # *.h) to filter out the source-files in the directories. robert@500: # robert@500: # Note that for custom extensions or not directly supported extensions you also robert@500: # need to set EXTENSION_MAPPING for the extension otherwise the files are not robert@500: # read by doxygen. robert@500: # robert@500: # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, robert@500: # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, robert@500: # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, robert@500: # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, robert@500: # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. andrewm@47: andrewm@47: FILE_PATTERNS = andrewm@47: robert@500: # The RECURSIVE tag can be used to specify whether or not subdirectories should robert@500: # be searched for input files as well. robert@500: # The default value is: NO. andrewm@47: andrewm@47: RECURSIVE = YES andrewm@47: andrewm@47: # The EXCLUDE tag can be used to specify files and/or directories that should be andrewm@47: # excluded from the INPUT source files. This way you can easily exclude a andrewm@47: # subdirectory from a directory tree whose root is specified with the INPUT tag. robert@500: # andrewm@47: # Note that relative paths are relative to the directory from which doxygen is andrewm@47: # run. andrewm@47: robert@524: EXCLUDE = include/ne10/ include/oscpkt.hh include/libpd include/prussdrv.h examples/10-Instruments/ andrewm@47: andrewm@47: # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or andrewm@47: # directories that are symbolic links (a Unix file system feature) are excluded andrewm@47: # from the input. robert@500: # The default value is: NO. andrewm@47: andrewm@47: EXCLUDE_SYMLINKS = NO andrewm@47: andrewm@47: # If the value of the INPUT tag contains directories, you can use the andrewm@47: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude robert@500: # certain files from those directories. robert@500: # robert@500: # Note that the wildcards are matched against the file with absolute path, so to robert@500: # exclude all test directories for example use the pattern */test/* andrewm@47: andrewm@47: EXCLUDE_PATTERNS = andrewm@47: andrewm@47: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names andrewm@47: # (namespaces, classes, functions, etc.) that should be excluded from the andrewm@47: # output. The symbol name can be a fully qualified name, a word, or if the andrewm@47: # wildcard * is used, a substring. Examples: ANamespace, AClass, andrewm@47: # AClass::ANamespace, ANamespace::*Test robert@500: # robert@500: # Note that the wildcards are matched against the file with absolute path, so to robert@500: # exclude all test directories use the pattern */test/* andrewm@47: andrewm@47: EXCLUDE_SYMBOLS = andrewm@47: robert@500: # The EXAMPLE_PATH tag can be used to specify one or more files or directories robert@500: # that contain example code fragments that are included (see the \include robert@500: # command). robert@500: robert@500: EXAMPLE_PATH = examples/01-Basics \ robert@500: examples/02-Digital \ robert@500: examples/03-Analog \ robert@500: examples/04-Audio \ robert@500: examples/05-Communication \ robert@500: examples/06-Sensors \ robert@500: examples/07-DataLogging \ robert@500: examples/08-PureData \ robert@500: examples/09-Capelets \ robert@500: examples/10-Instruments \ robert@500: examples/11-Extras andrewm@47: andrewm@47: # If the value of the EXAMPLE_PATH tag contains directories, you can use the robert@500: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and robert@500: # *.h) to filter out the source-files in the directories. If left blank all robert@500: # files are included. andrewm@47: andrewm@47: EXAMPLE_PATTERNS = andrewm@47: andrewm@47: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be robert@500: # searched for input files to be used with the \include or \dontinclude commands robert@500: # irrespective of the value of the RECURSIVE tag. robert@500: # The default value is: NO. andrewm@47: andrewm@47: EXAMPLE_RECURSIVE = NO andrewm@47: robert@500: # The IMAGE_PATH tag can be used to specify one or more files or directories robert@500: # that contain images that are to be included in the documentation (see the robert@500: # \image command). andrewm@47: andrewm@47: IMAGE_PATH = andrewm@47: andrewm@47: # The INPUT_FILTER tag can be used to specify a program that doxygen should andrewm@47: # invoke to filter for each input file. Doxygen will invoke the filter program robert@500: # by executing (via popen()) the command: robert@500: # robert@500: # robert@500: # robert@500: # where is the value of the INPUT_FILTER tag, and is the robert@500: # name of an input file. Doxygen will then use the output that the filter robert@500: # program writes to standard output. If FILTER_PATTERNS is specified, this tag robert@500: # will be ignored. robert@500: # robert@500: # Note that the filter must not add or remove lines; it is applied before the robert@500: # code is scanned, but not when the output code is generated. If lines are added robert@500: # or removed, the anchors will not be placed correctly. robert@500: # robert@500: # Note that for custom extensions or not directly supported extensions you also robert@500: # need to set EXTENSION_MAPPING for the extension otherwise the files are not robert@500: # properly processed by doxygen. andrewm@47: andrewm@47: INPUT_FILTER = andrewm@47: andrewm@47: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern robert@500: # basis. Doxygen will compare the file name with each pattern and apply the robert@500: # filter if there is a match. The filters are a list of the form: pattern=filter robert@500: # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how robert@500: # filters are used. If the FILTER_PATTERNS tag is empty or if none of the robert@500: # patterns match the file name, INPUT_FILTER is applied. robert@500: # robert@500: # Note that for custom extensions or not directly supported extensions you also robert@500: # need to set EXTENSION_MAPPING for the extension otherwise the files are not robert@500: # properly processed by doxygen. andrewm@47: andrewm@47: FILTER_PATTERNS = andrewm@47: andrewm@47: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using robert@500: # INPUT_FILTER) will also be used to filter the input files that are used for robert@500: # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). robert@500: # The default value is: NO. andrewm@47: andrewm@47: FILTER_SOURCE_FILES = NO andrewm@47: andrewm@47: # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file robert@500: # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and robert@500: # it is also possible to disable source filtering for a specific pattern using robert@500: # *.ext= (so without naming a filter). robert@500: # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. andrewm@47: andrewm@47: FILTER_SOURCE_PATTERNS = andrewm@47: robert@500: # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that robert@500: # is part of the input, its contents will be placed on the main page robert@500: # (index.html). This can be useful if you have a project on for instance GitHub robert@500: # and want to reuse the introduction page also for the doxygen output. robert@500: robert@500: USE_MDFILE_AS_MAINPAGE = robert@500: andrewm@47: #--------------------------------------------------------------------------- robert@500: # Configuration options related to source browsing andrewm@47: #--------------------------------------------------------------------------- andrewm@47: robert@500: # If the SOURCE_BROWSER tag is set to YES then a list of source files will be robert@500: # generated. Documented entities will be cross-referenced with these sources. robert@500: # robert@500: # Note: To get rid of all source code in the generated output, make sure that robert@500: # also VERBATIM_HEADERS is set to NO. robert@500: # The default value is: NO. andrewm@47: andrewm@47: SOURCE_BROWSER = NO andrewm@47: robert@500: # Setting the INLINE_SOURCES tag to YES will include the body of functions, robert@500: # classes and enums directly into the documentation. robert@500: # The default value is: NO. andrewm@47: andrewm@47: INLINE_SOURCES = NO andrewm@47: robert@500: # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any robert@500: # special comment blocks from generated source code fragments. Normal C, C++ and robert@500: # Fortran comments will always remain visible. robert@500: # The default value is: YES. andrewm@47: andrewm@47: STRIP_CODE_COMMENTS = YES andrewm@47: robert@500: # If the REFERENCED_BY_RELATION tag is set to YES then for each documented robert@500: # function all documented functions referencing it will be listed. robert@500: # The default value is: NO. andrewm@47: andrewm@47: REFERENCED_BY_RELATION = NO andrewm@47: robert@500: # If the REFERENCES_RELATION tag is set to YES then for each documented function robert@500: # all documented entities called/used by that function will be listed. robert@500: # The default value is: NO. andrewm@47: andrewm@47: REFERENCES_RELATION = NO andrewm@47: robert@500: # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set robert@500: # to YES then the hyperlinks from functions in REFERENCES_RELATION and robert@500: # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will robert@500: # link to the documentation. robert@500: # The default value is: YES. andrewm@47: andrewm@47: REFERENCES_LINK_SOURCE = YES andrewm@47: robert@500: # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the robert@500: # source code will show a tooltip with additional information such as prototype, robert@500: # brief description and links to the definition and documentation. Since this robert@500: # will make the HTML file larger and loading of large files a bit slower, you robert@500: # can opt to disable this feature. robert@500: # The default value is: YES. robert@500: # This tag requires that the tag SOURCE_BROWSER is set to YES. robert@500: robert@500: SOURCE_TOOLTIPS = YES robert@500: robert@500: # If the USE_HTAGS tag is set to YES then the references to source code will robert@500: # point to the HTML generated by the htags(1) tool instead of doxygen built-in robert@500: # source browser. The htags tool is part of GNU's global source tagging system robert@500: # (see http://www.gnu.org/software/global/global.html). You will need version robert@500: # 4.8.6 or higher. robert@500: # robert@500: # To use it do the following: robert@500: # - Install the latest version of global robert@500: # - Enable SOURCE_BROWSER and USE_HTAGS in the config file robert@500: # - Make sure the INPUT points to the root of the source tree robert@500: # - Run doxygen as normal robert@500: # robert@500: # Doxygen will invoke htags (and that will in turn invoke gtags), so these robert@500: # tools must be available from the command line (i.e. in the search path). robert@500: # robert@500: # The result: instead of the source browser generated by doxygen, the links to robert@500: # source code will now point to the output of htags. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag SOURCE_BROWSER is set to YES. andrewm@47: andrewm@47: USE_HTAGS = NO andrewm@47: robert@500: # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a robert@500: # verbatim copy of the header file for each class for which an include is robert@500: # specified. Set to NO to disable this. robert@500: # See also: Section \class. robert@500: # The default value is: YES. andrewm@47: andrewm@47: VERBATIM_HEADERS = YES andrewm@47: andrewm@47: #--------------------------------------------------------------------------- robert@500: # Configuration options related to the alphabetical class index andrewm@47: #--------------------------------------------------------------------------- andrewm@47: robert@500: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all robert@500: # compounds will be generated. Enable this if the project contains a lot of robert@500: # classes, structs, unions or interfaces. robert@500: # The default value is: YES. andrewm@47: andrewm@47: ALPHABETICAL_INDEX = YES andrewm@47: robert@500: # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in robert@500: # which the alphabetical index list will be split. robert@500: # Minimum value: 1, maximum value: 20, default value: 5. robert@500: # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. andrewm@47: andrewm@47: COLS_IN_ALPHA_INDEX = 5 andrewm@47: robert@500: # In case all classes in a project start with a common prefix, all classes will robert@500: # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag robert@500: # can be used to specify a prefix (or a list of prefixes) that should be ignored robert@500: # while generating the index headers. robert@500: # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. andrewm@47: andrewm@47: IGNORE_PREFIX = andrewm@47: andrewm@47: #--------------------------------------------------------------------------- robert@500: # Configuration options related to the HTML output andrewm@47: #--------------------------------------------------------------------------- andrewm@47: robert@500: # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output robert@500: # The default value is: YES. andrewm@47: andrewm@47: GENERATE_HTML = YES andrewm@47: robert@500: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a robert@500: # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of robert@500: # it. robert@500: # The default directory is: html. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_OUTPUT = html andrewm@47: robert@500: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each robert@500: # generated HTML page (for example: .htm, .php, .asp). robert@500: # The default value is: .html. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_FILE_EXTENSION = .html andrewm@47: robert@500: # The HTML_HEADER tag can be used to specify a user-defined HTML header file for robert@500: # each generated HTML page. If the tag is left blank doxygen will generate a robert@500: # standard header. robert@500: # robert@500: # To get valid HTML the header file that includes any scripts and style sheets robert@500: # that doxygen needs, which is dependent on the configuration options used (e.g. robert@500: # the setting GENERATE_TREEVIEW). It is highly recommended to start with a robert@500: # default header using robert@500: # doxygen -w html new_header.html new_footer.html new_stylesheet.css robert@500: # YourConfigFile robert@500: # and then modify the file new_header.html. See also section "Doxygen usage" robert@500: # for information on how to generate the default header that doxygen normally robert@500: # uses. robert@500: # Note: The header is subject to change so you typically have to regenerate the robert@500: # default header when upgrading to a newer version of doxygen. For a description robert@500: # of the possible markers and block names see the documentation. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_HEADER = andrewm@47: robert@500: # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each robert@500: # generated HTML page. If the tag is left blank doxygen will generate a standard robert@500: # footer. See HTML_HEADER for more information on how to generate a default robert@500: # footer and what special commands can be used inside the footer. See also robert@500: # section "Doxygen usage" for information on how to generate the default footer robert@500: # that doxygen normally uses. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_FOOTER = andrewm@47: robert@500: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style robert@500: # sheet that is used by each HTML page. It can be used to fine-tune the look of robert@500: # the HTML output. If left blank doxygen will generate a default style sheet. robert@500: # See also section "Doxygen usage" for information on how to generate the style robert@500: # sheet that doxygen normally uses. robert@500: # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as robert@500: # it is more robust and this tag (HTML_STYLESHEET) will in the future become robert@500: # obsolete. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_STYLESHEET = andrewm@47: robert@500: # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined robert@500: # cascading style sheets that are included after the standard style sheets robert@500: # created by doxygen. Using this option one can overrule certain style aspects. robert@500: # This is preferred over using HTML_STYLESHEET since it does not replace the robert@500: # standard style sheet and is therefore more robust against future updates. robert@500: # Doxygen will copy the style sheet files to the output directory. robert@500: # Note: The order of the extra style sheet files is of importance (e.g. the last robert@500: # style sheet in the list overrules the setting of the previous ones in the robert@500: # list). For an example see the documentation. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. robert@500: robert@500: HTML_EXTRA_STYLESHEET = robert@500: andrewm@47: # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or andrewm@47: # other source files which should be copied to the HTML output directory. Note andrewm@47: # that these files will be copied to the base HTML output directory. Use the robert@500: # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these robert@500: # files. In the HTML_STYLESHEET file, use the file name only. Also note that the robert@500: # files will be copied as-is; there are no commands or markers available. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_EXTRA_FILES = andrewm@47: robert@500: # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen robert@500: # will adjust the colors in the style sheet and background images according to robert@500: # this color. Hue is specified as an angle on a colorwheel, see robert@500: # http://en.wikipedia.org/wiki/Hue for more information. For instance the value robert@500: # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 robert@500: # purple, and 360 is red again. robert@500: # Minimum value: 0, maximum value: 359, default value: 220. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_COLORSTYLE_HUE = 220 andrewm@47: robert@500: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors robert@500: # in the HTML output. For a value of 0 the output will use grayscales only. A robert@500: # value of 255 will produce the most vivid colors. robert@500: # Minimum value: 0, maximum value: 255, default value: 100. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_COLORSTYLE_SAT = 100 andrewm@47: robert@500: # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the robert@500: # luminance component of the colors in the HTML output. Values below 100 robert@500: # gradually make the output lighter, whereas values above 100 make the output robert@500: # darker. The value divided by 100 is the actual gamma applied, so 80 represents robert@500: # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not robert@500: # change the gamma. robert@500: # Minimum value: 40, maximum value: 240, default value: 80. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_COLORSTYLE_GAMMA = 80 andrewm@47: andrewm@47: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML robert@500: # page will contain the date and time when the page was generated. Setting this robert@500: # to YES can help to show when doxygen was last run and thus if the robert@500: # documentation is up to date. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_TIMESTAMP = YES andrewm@47: andrewm@47: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML andrewm@47: # documentation will contain sections that can be hidden and shown after the robert@500: # page has loaded. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: HTML_DYNAMIC_SECTIONS = NO andrewm@47: robert@500: # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries robert@500: # shown in the various tree structured indices initially; the user can expand robert@500: # and collapse entries dynamically later on. Doxygen will expand the tree to robert@500: # such a level that at most the specified number of entries are visible (unless robert@500: # a fully collapsed tree already exceeds this amount). So setting the number of robert@500: # entries 1 will produce a full collapsed tree by default. 0 is a special value robert@500: # representing an infinite number of entries and will result in a full expanded robert@500: # tree by default. robert@500: # Minimum value: 0, maximum value: 9999, default value: 100. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. robert@500: robert@500: HTML_INDEX_NUM_ENTRIES = 100 robert@500: robert@500: # If the GENERATE_DOCSET tag is set to YES, additional index files will be robert@500: # generated that can be used as input for Apple's Xcode 3 integrated development robert@500: # environment (see: http://developer.apple.com/tools/xcode/), introduced with robert@500: # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a robert@500: # Makefile in the HTML output directory. Running make will produce the docset in robert@500: # that directory and running make install will install the docset in robert@500: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at robert@500: # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html andrewm@47: # for more information. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: GENERATE_DOCSET = NO andrewm@47: robert@500: # This tag determines the name of the docset feed. A documentation feed provides robert@500: # an umbrella under which multiple documentation sets from a single provider robert@500: # (such as a company or product suite) can be grouped. robert@500: # The default value is: Doxygen generated docs. robert@500: # This tag requires that the tag GENERATE_DOCSET is set to YES. andrewm@47: andrewm@47: DOCSET_FEEDNAME = "Doxygen generated docs" andrewm@47: robert@500: # This tag specifies a string that should uniquely identify the documentation robert@500: # set bundle. This should be a reverse domain-name style string, e.g. robert@500: # com.mycompany.MyDocSet. Doxygen will append .docset to the name. robert@500: # The default value is: org.doxygen.Project. robert@500: # This tag requires that the tag GENERATE_DOCSET is set to YES. andrewm@47: andrewm@47: DOCSET_BUNDLE_ID = org.doxygen.Project andrewm@47: robert@500: # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify andrewm@47: # the documentation publisher. This should be a reverse domain-name style andrewm@47: # string, e.g. com.mycompany.MyDocSet.documentation. robert@500: # The default value is: org.doxygen.Publisher. robert@500: # This tag requires that the tag GENERATE_DOCSET is set to YES. andrewm@47: andrewm@47: DOCSET_PUBLISHER_ID = org.doxygen.Publisher andrewm@47: robert@500: # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. robert@500: # The default value is: Publisher. robert@500: # This tag requires that the tag GENERATE_DOCSET is set to YES. andrewm@47: andrewm@47: DOCSET_PUBLISHER_NAME = Publisher andrewm@47: robert@500: # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three robert@500: # additional HTML index files: index.hhp, index.hhc, and index.hhk. The robert@500: # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop robert@500: # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on robert@500: # Windows. robert@500: # robert@500: # The HTML Help Workshop contains a compiler that can convert all HTML output robert@500: # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML robert@500: # files are now used as the Windows 98 help format, and will replace the old robert@500: # Windows help format (.hlp) on all Windows platforms in the future. Compressed robert@500: # HTML files also contain an index, a table of contents, and you can search for robert@500: # words in the documentation. The HTML workshop also contains a viewer for robert@500: # compressed HTML files. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: GENERATE_HTMLHELP = NO andrewm@47: robert@500: # The CHM_FILE tag can be used to specify the file name of the resulting .chm robert@500: # file. You can add a path in front of the file if the result should not be andrewm@47: # written to the html output directory. robert@500: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. andrewm@47: andrewm@47: CHM_FILE = andrewm@47: robert@500: # The HHC_LOCATION tag can be used to specify the location (absolute path robert@500: # including file name) of the HTML help compiler (hhc.exe). If non-empty, robert@500: # doxygen will try to run the HTML help compiler on the generated index.hhp. robert@500: # The file has to be specified with full path. robert@500: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. andrewm@47: andrewm@47: HHC_LOCATION = andrewm@47: robert@500: # The GENERATE_CHI flag controls if a separate .chi index file is generated robert@500: # (YES) or that it should be included in the master .chm file (NO). robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. andrewm@47: andrewm@47: GENERATE_CHI = NO andrewm@47: robert@500: # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) robert@500: # and project file content. robert@500: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. andrewm@47: andrewm@47: CHM_INDEX_ENCODING = andrewm@47: robert@500: # The BINARY_TOC flag controls whether a binary table of contents is generated robert@500: # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it robert@500: # enables the Previous and Next buttons. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. andrewm@47: andrewm@47: BINARY_TOC = NO andrewm@47: robert@500: # The TOC_EXPAND flag can be set to YES to add extra items for group members to robert@500: # the table of contents of the HTML help documentation and to the tree view. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTMLHELP is set to YES. andrewm@47: andrewm@47: TOC_EXPAND = NO andrewm@47: andrewm@47: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and robert@500: # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that robert@500: # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help robert@500: # (.qch) of the generated HTML documentation. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: GENERATE_QHP = NO andrewm@47: robert@500: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify robert@500: # the file name of the resulting .qch file. The path specified is relative to robert@500: # the HTML output folder. robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QCH_FILE = andrewm@47: robert@500: # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help robert@500: # Project output. For more information please see Qt Help Project / Namespace robert@500: # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). robert@500: # The default value is: org.doxygen.Project. robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QHP_NAMESPACE = org.doxygen.Project andrewm@47: robert@500: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt robert@500: # Help Project output. For more information please see Qt Help Project / Virtual robert@500: # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- robert@500: # folders). robert@500: # The default value is: doc. robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QHP_VIRTUAL_FOLDER = doc andrewm@47: robert@500: # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom robert@500: # filter to add. For more information please see Qt Help Project / Custom robert@500: # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- robert@500: # filters). robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QHP_CUST_FILTER_NAME = andrewm@47: robert@500: # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the robert@500: # custom filter to add. For more information please see Qt Help Project / Custom robert@500: # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- robert@500: # filters). robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QHP_CUST_FILTER_ATTRS = andrewm@47: andrewm@47: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this robert@500: # project's filter section matches. Qt Help Project / Filter Attributes (see: robert@500: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QHP_SECT_FILTER_ATTRS = andrewm@47: robert@500: # The QHG_LOCATION tag can be used to specify the location of Qt's robert@500: # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the robert@500: # generated .qhp file. robert@500: # This tag requires that the tag GENERATE_QHP is set to YES. andrewm@47: andrewm@47: QHG_LOCATION = andrewm@47: robert@500: # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be robert@500: # generated, together with the HTML files, they form an Eclipse help plugin. To robert@500: # install this plugin and make it available under the help contents menu in robert@500: # Eclipse, the contents of the directory containing the HTML and XML files needs robert@500: # to be copied into the plugins directory of eclipse. The name of the directory robert@500: # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. robert@500: # After copying Eclipse needs to be restarted before the help appears. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: GENERATE_ECLIPSEHELP = NO andrewm@47: robert@500: # A unique identifier for the Eclipse help plugin. When installing the plugin robert@500: # the directory name containing the HTML and XML files should also have this robert@500: # name. Each documentation set should have its own identifier. robert@500: # The default value is: org.doxygen.Project. robert@500: # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. andrewm@47: andrewm@47: ECLIPSE_DOC_ID = org.doxygen.Project andrewm@47: robert@500: # If you want full control over the layout of the generated HTML pages it might robert@500: # be necessary to disable the index and replace it with your own. The robert@500: # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top robert@500: # of each HTML page. A value of NO enables the index and the value YES disables robert@500: # it. Since the tabs in the index contain the same information as the navigation robert@500: # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: DISABLE_INDEX = NO andrewm@47: andrewm@47: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index robert@500: # structure should be generated to display hierarchical information. If the tag robert@500: # value is set to YES, a side panel will be generated containing a tree-like robert@500: # index structure (just like the one that is generated for HTML Help). For this robert@500: # to work a browser that supports JavaScript, DHTML, CSS and frames is required robert@500: # (i.e. any modern browser). Windows users are probably better off using the robert@500: # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can robert@500: # further fine-tune the look of the index. As an example, the default style robert@500: # sheet generated by doxygen has an example that shows how to put an image at robert@500: # the root of the tree instead of the PROJECT_NAME. Since the tree basically has robert@500: # the same information as the tab index, you could consider setting robert@500: # DISABLE_INDEX to YES when enabling this option. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: GENERATE_TREEVIEW = NO andrewm@47: robert@500: # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that robert@500: # doxygen will group on one line in the generated HTML documentation. robert@500: # robert@500: # Note that a value of 0 will completely suppress the enum values from appearing robert@500: # in the overview section. robert@500: # Minimum value: 0, maximum value: 20, default value: 4. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: ENUM_VALUES_PER_LINE = 4 andrewm@47: robert@500: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used robert@500: # to set the initial width (in pixels) of the frame in which the tree is shown. robert@500: # Minimum value: 0, maximum value: 1500, default value: 250. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: TREEVIEW_WIDTH = 250 andrewm@47: robert@500: # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to robert@500: # external symbols imported via tag files in a separate window. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: EXT_LINKS_IN_WINDOW = NO andrewm@47: robert@500: # Use this tag to change the font size of LaTeX formulas included as images in robert@500: # the HTML documentation. When you change the font size after a successful robert@500: # doxygen run you need to manually remove any form_*.png images from the HTML robert@500: # output directory to force them to be regenerated. robert@500: # Minimum value: 8, maximum value: 50, default value: 10. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: FORMULA_FONTSIZE = 10 andrewm@47: andrewm@47: # Use the FORMULA_TRANPARENT tag to determine whether or not the images robert@500: # generated for formulas are transparent PNGs. Transparent PNGs are not robert@500: # supported properly for IE 6.0, but are supported on all modern browsers. robert@500: # robert@500: # Note that when changing this option you need to delete any form_*.png files in robert@500: # the HTML output directory before the changes have effect. robert@500: # The default value is: YES. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: FORMULA_TRANSPARENT = YES andrewm@47: robert@500: # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see robert@500: # http://www.mathjax.org) which uses client side Javascript for the rendering robert@500: # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX robert@500: # installed or if you want to formulas look prettier in the HTML output. When robert@500: # enabled you may also need to install MathJax separately and configure the path robert@500: # to it using the MATHJAX_RELPATH option. robert@500: # The default value is: NO. robert@500: # This tag requires that the tag GENERATE_HTML is set to YES. andrewm@47: andrewm@47: USE_MATHJAX = NO andrewm@47: robert@500: # When MathJax is enabled you can set the default output format to be used for robert@500: # the MathJax output. See the MathJax site (see: robert@500: # http://docs.mathjax.org/en/latest/output.html) for more details. robert@500: # Possible values are: HTML-CSS (which is slower, but has the best robert@500: # compatibility), NativeMML (i.e. MathML) and SVG. robert@500: # The default value is: HTML-CSS. robert@500: # This tag requires that the tag USE_MATHJAX is set to YES. robert@500: robert@500: MATHJAX_FORMAT = HTML-CSS robert@500: robert@500: # When MathJax is enabled you need to specify the location relative to the HTML robert@500: # output directory using the MATHJAX_RELPATH option. The destination directory robert@500: # should contain the MathJax.js script. For instance, if the mathjax directory robert@500: # is located at the same level as the HTML output directory, then robert@500: # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax robert@500: # Content Delivery Network so you can quickly see the result without installing robert@500: # MathJax. However, it is strongly recommended to install a local copy of robert@500: # MathJax from http://www.mathjax.org before deployment. robert@500: # The default value is: http://cdn.mathjax.org/mathjax/latest. robert@500: # This tag requires that the tag USE_MATHJAX is set to YES. andrewm@47: andrewm@47: MATHJAX_RELPATH = http://www.mathjax.org/mathjax andrewm@47: robert@500: # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax robert@500: # extension names that should be enabled during MathJax rendering. For example robert@500: # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols robert@500: # This tag requires that the tag USE_MATHJAX is set to YES. andrewm@47: andrewm@47: MATHJAX_EXTENSIONS = andrewm@47: robert@500: # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces robert@500: # of code that will be used on startup of the MathJax code. See the MathJax site robert@500: # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an robert@500: # example see the documentation. robert@500: # This tag requires that the tag USE_MATHJAX is set to YES. robert@500: robert@500: MATHJAX_CODEFILE = robert@500: robert@500: # When the SEARCHENGINE tag is enabled doxygen will generate a search box for robert@500: # the HTML output. The underlying search engine uses javascript and DHTML and robert@500: # should work on any modern browser. Note that when using HTML help robert@500: # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) robert@500: # there is already a search function so this one should typically be disabled. robert@500: # For large projects the javascript based search engine can be slow, then robert@500: # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to robert@500: # search using the keyboard; to jump to the search box use + S robert@500: # (what the is depends on the OS and browser, but it is typically robert@500: # , /