yading@10: # Doxyfile 1.7.1 yading@10: yading@10: # This file describes the settings to be used by the documentation system yading@10: # doxygen (www.doxygen.org) for a project yading@10: # yading@10: # All text after a hash (#) is considered a comment and will be ignored yading@10: # The format is: yading@10: # TAG = value [value, ...] yading@10: # For lists items can also be appended using: yading@10: # TAG += value [value, ...] yading@10: # Values that contain spaces should be placed between quotes (" ") yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # Project related configuration options yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # This tag specifies the encoding used for all characters in the config file yading@10: # that follow. The default is UTF-8 which is also the encoding used for all yading@10: # text before the first occurrence of this tag. Doxygen uses libiconv (or the yading@10: # iconv built into libc) for the transcoding. See yading@10: # http://www.gnu.org/software/libiconv for the list of possible encodings. yading@10: yading@10: DOXYFILE_ENCODING = UTF-8 yading@10: yading@10: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded yading@10: # by quotes) that should identify the project. yading@10: yading@10: PROJECT_NAME = FFmpeg yading@10: yading@10: # The PROJECT_NUMBER tag can be used to enter a project or revision number. yading@10: # This could be handy for archiving the generated documentation or yading@10: # if some version control system is used. yading@10: yading@10: PROJECT_NUMBER = yading@10: yading@10: # With the PROJECT_LOGO tag one can specify an logo or icon that is included yading@10: # in the documentation. The maximum height of the logo should not exceed 55 yading@10: # pixels and the maximum width should not exceed 200 pixels. Doxygen will yading@10: # copy the logo to the output directory. yading@10: PROJECT_LOGO = yading@10: yading@10: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) yading@10: # base path where the generated documentation will be put. yading@10: # If a relative path is entered, it will be relative to the location yading@10: # where doxygen was started. If left blank the current directory will be used. yading@10: yading@10: OUTPUT_DIRECTORY = doc/doxy yading@10: yading@10: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create yading@10: # 4096 sub-directories (in 2 levels) under the output directory of each output yading@10: # format and will distribute the generated files over these directories. yading@10: # Enabling this option can be useful when feeding doxygen a huge amount of yading@10: # source files, where putting all generated files in the same directory would yading@10: # otherwise cause performance problems for the file system. yading@10: yading@10: CREATE_SUBDIRS = NO yading@10: yading@10: # The OUTPUT_LANGUAGE tag is used to specify the language in which all yading@10: # documentation generated by doxygen is written. Doxygen will use this yading@10: # information to generate all constant output in the proper language. yading@10: # The default language is English, other supported languages are: yading@10: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, yading@10: # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, yading@10: # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English yading@10: # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, yading@10: # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, yading@10: # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. yading@10: yading@10: OUTPUT_LANGUAGE = English yading@10: yading@10: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will yading@10: # include brief member descriptions after the members that are listed in yading@10: # the file and class documentation (similar to JavaDoc). yading@10: # Set to NO to disable this. yading@10: yading@10: BRIEF_MEMBER_DESC = YES yading@10: yading@10: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend yading@10: # the brief description of a member or function before the detailed description. yading@10: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the yading@10: # brief descriptions will be completely suppressed. yading@10: yading@10: REPEAT_BRIEF = YES yading@10: yading@10: # This tag implements a quasi-intelligent brief description abbreviator yading@10: # that is used to form the text in various listings. Each string yading@10: # in this list, if found as the leading text of the brief description, will be yading@10: # stripped from the text and the result after processing the whole list, is yading@10: # used as the annotated text. Otherwise, the brief description is used as-is. yading@10: # If left blank, the following values are used ("$name" is automatically yading@10: # replaced with the name of the entity): "The $name class" "The $name widget" yading@10: # "The $name file" "is" "provides" "specifies" "contains" yading@10: # "represents" "a" "an" "the" yading@10: yading@10: ABBREVIATE_BRIEF = yading@10: yading@10: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then yading@10: # Doxygen will generate a detailed section even if there is only a brief yading@10: # description. yading@10: yading@10: ALWAYS_DETAILED_SEC = NO yading@10: yading@10: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all yading@10: # inherited members of a class in the documentation of that class as if those yading@10: # members were ordinary class members. Constructors, destructors and assignment yading@10: # operators of the base classes will not be shown. yading@10: yading@10: INLINE_INHERITED_MEMB = NO yading@10: yading@10: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full yading@10: # path before files name in the file list and in the header files. If set yading@10: # to NO the shortest path that makes the file name unique will be used. yading@10: yading@10: FULL_PATH_NAMES = YES yading@10: yading@10: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag yading@10: # can be used to strip a user-defined part of the path. Stripping is yading@10: # only done if one of the specified strings matches the left-hand part of yading@10: # the path. The tag can be used to show relative paths in the file list. yading@10: # If left blank the directory from which doxygen is run is used as the yading@10: # path to strip. yading@10: yading@10: STRIP_FROM_PATH = . yading@10: yading@10: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of yading@10: # the path mentioned in the documentation of a class, which tells yading@10: # the reader which header file to include in order to use a class. yading@10: # If left blank only the name of the header file containing the class yading@10: # definition is used. Otherwise one should specify the include paths that yading@10: # are normally passed to the compiler using the -I flag. yading@10: yading@10: STRIP_FROM_INC_PATH = yading@10: yading@10: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter yading@10: # (but less readable) file names. This can be useful is your file systems yading@10: # doesn't support long names like on DOS, Mac, or CD-ROM. yading@10: yading@10: SHORT_NAMES = NO yading@10: yading@10: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen yading@10: # will interpret the first line (until the first dot) of a JavaDoc-style yading@10: # comment as the brief description. If set to NO, the JavaDoc yading@10: # comments will behave just like regular Qt-style comments yading@10: # (thus requiring an explicit @brief command for a brief description.) yading@10: yading@10: JAVADOC_AUTOBRIEF = YES yading@10: yading@10: # If the QT_AUTOBRIEF tag is set to YES then Doxygen will yading@10: # interpret the first line (until the first dot) of a Qt-style yading@10: # comment as the brief description. If set to NO, the comments yading@10: # will behave just like regular Qt-style comments (thus requiring yading@10: # an explicit \brief command for a brief description.) yading@10: yading@10: QT_AUTOBRIEF = NO yading@10: yading@10: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen yading@10: # treat a multi-line C++ special comment block (i.e. a block of //! or /// yading@10: # comments) as a brief description. This used to be the default behaviour. yading@10: # The new default is to treat a multi-line C++ comment block as a detailed yading@10: # description. Set this tag to YES if you prefer the old behaviour instead. yading@10: yading@10: MULTILINE_CPP_IS_BRIEF = NO yading@10: yading@10: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented yading@10: # member inherits the documentation from any documented member that it yading@10: # re-implements. yading@10: yading@10: INHERIT_DOCS = YES yading@10: yading@10: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce yading@10: # a new page for each member. If set to NO, the documentation of a member will yading@10: # be part of the file/class/namespace that contains it. yading@10: yading@10: SEPARATE_MEMBER_PAGES = NO yading@10: yading@10: # The TAB_SIZE tag can be used to set the number of spaces in a tab. yading@10: # Doxygen uses this value to replace tabs by spaces in code fragments. yading@10: yading@10: TAB_SIZE = 8 yading@10: yading@10: # This tag can be used to specify a number of aliases that acts yading@10: # as commands in the documentation. An alias has the form "name=value". yading@10: # For example adding "sideeffect=\par Side Effects:\n" will allow you to yading@10: # put the command \sideeffect (or @sideeffect) in the documentation, which yading@10: # will result in a user-defined paragraph with heading "Side Effects:". yading@10: # You can put \n's in the value part of an alias to insert newlines. yading@10: yading@10: ALIASES = yading@10: yading@10: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C yading@10: # sources only. Doxygen will then generate output that is more tailored for C. yading@10: # For instance, some of the names that are used will be different. The list yading@10: # of all members will be omitted, etc. yading@10: yading@10: OPTIMIZE_OUTPUT_FOR_C = YES yading@10: yading@10: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java yading@10: # sources only. Doxygen will then generate output that is more tailored for yading@10: # Java. For instance, namespaces will be presented as packages, qualified yading@10: # scopes will look different, etc. yading@10: yading@10: OPTIMIZE_OUTPUT_JAVA = NO yading@10: yading@10: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran yading@10: # sources only. Doxygen will then generate output that is more tailored for yading@10: # Fortran. yading@10: yading@10: OPTIMIZE_FOR_FORTRAN = NO yading@10: yading@10: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL yading@10: # sources. Doxygen will then generate output that is tailored for yading@10: # VHDL. yading@10: yading@10: OPTIMIZE_OUTPUT_VHDL = NO yading@10: yading@10: # Doxygen selects the parser to use depending on the extension of the files it yading@10: # parses. With this tag you can assign which parser to use for a given extension. yading@10: # Doxygen has a built-in mapping, but you can override or extend it using this yading@10: # tag. The format is ext=language, where ext is a file extension, and language yading@10: # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, yading@10: # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make yading@10: # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C yading@10: # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions yading@10: # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. yading@10: yading@10: EXTENSION_MAPPING = yading@10: yading@10: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want yading@10: # to include (a tag file for) the STL sources as input, then you should yading@10: # set this tag to YES in order to let doxygen match functions declarations and yading@10: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. yading@10: # func(std::string) {}). This also make the inheritance and collaboration yading@10: # diagrams that involve STL classes more complete and accurate. yading@10: yading@10: BUILTIN_STL_SUPPORT = NO yading@10: yading@10: # If you use Microsoft's C++/CLI language, you should set this option to YES to yading@10: # enable parsing support. yading@10: yading@10: CPP_CLI_SUPPORT = NO yading@10: yading@10: # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. yading@10: # Doxygen will parse them like normal C++ but will assume all classes use public yading@10: # instead of private inheritance when no explicit protection keyword is present. yading@10: yading@10: SIP_SUPPORT = NO yading@10: yading@10: # For Microsoft's IDL there are propget and propput attributes to indicate getter yading@10: # and setter methods for a property. Setting this option to YES (the default) yading@10: # will make doxygen to replace the get and set methods by a property in the yading@10: # documentation. This will only work if the methods are indeed getting or yading@10: # setting a simple type. If this is not the case, or you want to show the yading@10: # methods anyway, you should set this option to NO. yading@10: yading@10: IDL_PROPERTY_SUPPORT = YES yading@10: yading@10: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC yading@10: # tag is set to YES, then doxygen will reuse the documentation of the first yading@10: # member in the group (if any) for the other members of the group. By default yading@10: # all members of a group must be documented explicitly. yading@10: yading@10: DISTRIBUTE_GROUP_DOC = NO yading@10: yading@10: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of yading@10: # the same type (for instance a group of public functions) to be put as a yading@10: # subgroup of that type (e.g. under the Public Functions section). Set it to yading@10: # NO to prevent subgrouping. Alternatively, this can be done per class using yading@10: # the \nosubgrouping command. yading@10: yading@10: SUBGROUPING = YES yading@10: yading@10: # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum yading@10: # is documented as struct, union, or enum with the name of the typedef. So yading@10: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct yading@10: # with name TypeT. When disabled the typedef will appear as a member of a file, yading@10: # namespace, or class. And the struct will be named TypeS. This can typically yading@10: # be useful for C code in case the coding convention dictates that all compound yading@10: # types are typedef'ed and only the typedef is referenced, never the tag name. yading@10: yading@10: TYPEDEF_HIDES_STRUCT = NO yading@10: yading@10: # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to yading@10: # determine which symbols to keep in memory and which to flush to disk. yading@10: # When the cache is full, less often used symbols will be written to disk. yading@10: # For small to medium size projects (<1000 input files) the default value is yading@10: # probably good enough. For larger projects a too small cache size can cause yading@10: # doxygen to be busy swapping symbols to and from disk most of the time yading@10: # causing a significant performance penality. yading@10: # If the system has enough physical memory increasing the cache will improve the yading@10: # performance by keeping more symbols in memory. Note that the value works on yading@10: # a logarithmic scale so increasing the size by one will roughly double the yading@10: # memory usage. The cache size is given by this formula: yading@10: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, yading@10: # corresponding to a cache size of 2^16 = 65536 symbols yading@10: yading@10: SYMBOL_CACHE_SIZE = 0 yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # Build related configuration options yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in yading@10: # documentation are documented, even if no documentation was available. yading@10: # Private class members and static file members will be hidden unless yading@10: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES yading@10: yading@10: EXTRACT_ALL = YES yading@10: yading@10: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class yading@10: # will be included in the documentation. yading@10: yading@10: EXTRACT_PRIVATE = YES yading@10: yading@10: # If the EXTRACT_STATIC tag is set to YES all static members of a file yading@10: # will be included in the documentation. yading@10: yading@10: EXTRACT_STATIC = YES yading@10: yading@10: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) yading@10: # defined locally in source files will be included in the documentation. yading@10: # If set to NO only classes defined in header files are included. yading@10: yading@10: EXTRACT_LOCAL_CLASSES = YES yading@10: yading@10: # This flag is only useful for Objective-C code. When set to YES local yading@10: # methods, which are defined in the implementation section but not in yading@10: # the interface are included in the documentation. yading@10: # If set to NO (the default) only methods in the interface are included. yading@10: yading@10: EXTRACT_LOCAL_METHODS = NO yading@10: yading@10: # If this flag is set to YES, the members of anonymous namespaces will be yading@10: # extracted and appear in the documentation as a namespace called yading@10: # 'anonymous_namespace{file}', where file will be replaced with the base yading@10: # name of the file that contains the anonymous namespace. By default yading@10: # anonymous namespace are hidden. yading@10: yading@10: EXTRACT_ANON_NSPACES = NO yading@10: yading@10: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all yading@10: # undocumented members of documented classes, files or namespaces. yading@10: # If set to NO (the default) these members will be included in the yading@10: # various overviews, but no documentation section is generated. yading@10: # This option has no effect if EXTRACT_ALL is enabled. yading@10: yading@10: HIDE_UNDOC_MEMBERS = NO yading@10: yading@10: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all yading@10: # undocumented classes that are normally visible in the class hierarchy. yading@10: # If set to NO (the default) these classes will be included in the various yading@10: # overviews. This option has no effect if EXTRACT_ALL is enabled. yading@10: yading@10: HIDE_UNDOC_CLASSES = NO yading@10: yading@10: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all yading@10: # friend (class|struct|union) declarations. yading@10: # If set to NO (the default) these declarations will be included in the yading@10: # documentation. yading@10: yading@10: HIDE_FRIEND_COMPOUNDS = NO yading@10: yading@10: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any yading@10: # documentation blocks found inside the body of a function. yading@10: # If set to NO (the default) these blocks will be appended to the yading@10: # function's detailed documentation block. yading@10: yading@10: HIDE_IN_BODY_DOCS = NO yading@10: yading@10: # The INTERNAL_DOCS tag determines if documentation yading@10: # that is typed after a \internal command is included. If the tag is set yading@10: # to NO (the default) then the documentation will be excluded. yading@10: # Set it to YES to include the internal documentation. yading@10: yading@10: INTERNAL_DOCS = NO yading@10: yading@10: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate yading@10: # file names in lower-case letters. If set to YES upper-case letters are also yading@10: # allowed. This is useful if you have classes or files whose names only differ yading@10: # in case and if your file system supports case sensitive file names. Windows yading@10: # and Mac users are advised to set this option to NO. yading@10: yading@10: CASE_SENSE_NAMES = YES yading@10: yading@10: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen yading@10: # will show members with their full class and namespace scopes in the yading@10: # documentation. If set to YES the scope will be hidden. yading@10: yading@10: HIDE_SCOPE_NAMES = NO yading@10: yading@10: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen yading@10: # will put a list of the files that are included by a file in the documentation yading@10: # of that file. yading@10: yading@10: SHOW_INCLUDE_FILES = YES yading@10: yading@10: # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen yading@10: # will list include files with double quotes in the documentation yading@10: # rather than with sharp brackets. yading@10: yading@10: FORCE_LOCAL_INCLUDES = NO yading@10: yading@10: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] yading@10: # is inserted in the documentation for inline members. yading@10: yading@10: INLINE_INFO = YES yading@10: yading@10: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen yading@10: # will sort the (detailed) documentation of file and class members yading@10: # alphabetically by member name. If set to NO the members will appear in yading@10: # declaration order. yading@10: yading@10: SORT_MEMBER_DOCS = YES yading@10: yading@10: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the yading@10: # brief documentation of file, namespace and class members alphabetically yading@10: # by member name. If set to NO (the default) the members will appear in yading@10: # declaration order. yading@10: yading@10: SORT_BRIEF_DOCS = NO yading@10: yading@10: # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen yading@10: # will sort the (brief and detailed) documentation of class members so that yading@10: # constructors and destructors are listed first. If set to NO (the default) yading@10: # the constructors will appear in the respective orders defined by yading@10: # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. yading@10: # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO yading@10: # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. yading@10: yading@10: SORT_MEMBERS_CTORS_1ST = NO yading@10: yading@10: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the yading@10: # hierarchy of group names into alphabetical order. If set to NO (the default) yading@10: # the group names will appear in their defined order. yading@10: yading@10: SORT_GROUP_NAMES = NO yading@10: yading@10: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be yading@10: # sorted by fully-qualified names, including namespaces. If set to yading@10: # NO (the default), the class list will be sorted only by class name, yading@10: # not including the namespace part. yading@10: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. yading@10: # Note: This option applies only to the class list, not to the yading@10: # alphabetical list. yading@10: yading@10: SORT_BY_SCOPE_NAME = NO yading@10: yading@10: # The GENERATE_TODOLIST tag can be used to enable (YES) or yading@10: # disable (NO) the todo list. This list is created by putting \todo yading@10: # commands in the documentation. yading@10: yading@10: GENERATE_TODOLIST = YES yading@10: yading@10: # The GENERATE_TESTLIST tag can be used to enable (YES) or yading@10: # disable (NO) the test list. This list is created by putting \test yading@10: # commands in the documentation. yading@10: yading@10: GENERATE_TESTLIST = YES yading@10: yading@10: # The GENERATE_BUGLIST tag can be used to enable (YES) or yading@10: # disable (NO) the bug list. This list is created by putting \bug yading@10: # commands in the documentation. yading@10: yading@10: GENERATE_BUGLIST = YES yading@10: yading@10: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or yading@10: # disable (NO) the deprecated list. This list is created by putting yading@10: # \deprecated commands in the documentation. yading@10: yading@10: GENERATE_DEPRECATEDLIST= YES yading@10: yading@10: # The ENABLED_SECTIONS tag can be used to enable conditional yading@10: # documentation sections, marked by \if sectionname ... \endif. yading@10: yading@10: ENABLED_SECTIONS = yading@10: yading@10: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines yading@10: # the initial value of a variable or define consists of for it to appear in yading@10: # the documentation. If the initializer consists of more lines than specified yading@10: # here it will be hidden. Use a value of 0 to hide initializers completely. yading@10: # The appearance of the initializer of individual variables and defines in the yading@10: # documentation can be controlled using \showinitializer or \hideinitializer yading@10: # command in the documentation regardless of this setting. yading@10: yading@10: MAX_INITIALIZER_LINES = 30 yading@10: yading@10: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated yading@10: # at the bottom of the documentation of classes and structs. If set to YES the yading@10: # list will mention the files that were used to generate the documentation. yading@10: yading@10: SHOW_USED_FILES = YES yading@10: yading@10: # Set the SHOW_FILES tag to NO to disable the generation of the Files page. yading@10: # This will remove the Files entry from the Quick Index and from the yading@10: # Folder Tree View (if specified). The default is YES. yading@10: yading@10: SHOW_FILES = YES yading@10: yading@10: # Set the SHOW_NAMESPACES tag to NO to disable the generation of the yading@10: # Namespaces page. yading@10: # This will remove the Namespaces entry from the Quick Index yading@10: # and from the Folder Tree View (if specified). The default is YES. yading@10: yading@10: SHOW_NAMESPACES = YES yading@10: yading@10: # The FILE_VERSION_FILTER tag can be used to specify a program or script that yading@10: # doxygen should invoke to get the current version for each file (typically from yading@10: # the version control system). Doxygen will invoke the program by executing (via yading@10: # popen()) the command , where is the value of yading@10: # the FILE_VERSION_FILTER tag, and is the name of an input file yading@10: # provided by doxygen. Whatever the program writes to standard output yading@10: # is used as the file version. See the manual for examples. yading@10: yading@10: FILE_VERSION_FILTER = yading@10: yading@10: # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed yading@10: # by doxygen. The layout file controls the global structure of the generated yading@10: # output files in an output format independent way. The create the layout file yading@10: # that represents doxygen's defaults, run doxygen with the -l option. yading@10: # You can optionally specify a file name after the option, if omitted yading@10: # DoxygenLayout.xml will be used as the name of the layout file. yading@10: yading@10: LAYOUT_FILE = yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to warning and progress messages yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # The QUIET tag can be used to turn on/off the messages that are generated yading@10: # by doxygen. Possible values are YES and NO. If left blank NO is used. yading@10: yading@10: QUIET = YES yading@10: yading@10: # The WARNINGS tag can be used to turn on/off the warning messages that are yading@10: # generated by doxygen. Possible values are YES and NO. If left blank yading@10: # NO is used. yading@10: yading@10: WARNINGS = YES yading@10: yading@10: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings yading@10: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will yading@10: # automatically be disabled. yading@10: yading@10: WARN_IF_UNDOCUMENTED = YES yading@10: yading@10: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for yading@10: # potential errors in the documentation, such as not documenting some yading@10: # parameters in a documented function, or documenting parameters that yading@10: # don't exist or using markup commands wrongly. yading@10: yading@10: WARN_IF_DOC_ERROR = YES yading@10: yading@10: # This WARN_NO_PARAMDOC option can be abled to get warnings for yading@10: # functions that are documented, but have no documentation for their parameters yading@10: # or return value. If set to NO (the default) doxygen will only warn about yading@10: # wrong or incomplete parameter documentation, but not about the absence of yading@10: # documentation. yading@10: yading@10: WARN_NO_PARAMDOC = NO yading@10: yading@10: # The WARN_FORMAT tag determines the format of the warning messages that yading@10: # doxygen can produce. The string should contain the $file, $line, and $text yading@10: # tags, which will be replaced by the file and line number from which the yading@10: # warning originated and the warning text. Optionally the format may contain yading@10: # $version, which will be replaced by the version of the file (if it could yading@10: # be obtained via FILE_VERSION_FILTER) yading@10: yading@10: WARN_FORMAT = "$file:$line: $text" yading@10: yading@10: # The WARN_LOGFILE tag can be used to specify a file to which warning yading@10: # and error messages should be written. If left blank the output is written yading@10: # to stderr. yading@10: yading@10: WARN_LOGFILE = yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the input files yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # The INPUT tag can be used to specify the files and/or directories that contain yading@10: # documented source files. You may enter file names like "myfile.cpp" or yading@10: # directories like "/usr/src/myproject". Separate the files or directories yading@10: # with spaces. yading@10: yading@10: INPUT = yading@10: yading@10: # This tag can be used to specify the character encoding of the source files yading@10: # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is yading@10: # also the default input encoding. Doxygen uses libiconv (or the iconv built yading@10: # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for yading@10: # the list of possible encodings. yading@10: yading@10: INPUT_ENCODING = UTF-8 yading@10: yading@10: # If the value of the INPUT tag contains directories, you can use the yading@10: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp yading@10: # and *.h) to filter out the source-files in the directories. If left yading@10: # blank the following patterns are tested: yading@10: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx yading@10: # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 yading@10: yading@10: FILE_PATTERNS = yading@10: yading@10: # The RECURSIVE tag can be used to turn specify whether or not subdirectories yading@10: # should be searched for input files as well. Possible values are YES and NO. yading@10: # If left blank NO is used. yading@10: yading@10: RECURSIVE = YES yading@10: yading@10: # The EXCLUDE tag can be used to specify files and/or directories that should yading@10: # excluded from the INPUT source files. This way you can easily exclude a yading@10: # subdirectory from a directory tree whose root is specified with the INPUT tag. yading@10: yading@10: EXCLUDE = yading@10: yading@10: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or yading@10: # directories that are symbolic links (a Unix filesystem feature) are excluded yading@10: # from the input. yading@10: yading@10: EXCLUDE_SYMLINKS = NO yading@10: yading@10: # If the value of the INPUT tag contains directories, you can use the yading@10: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude yading@10: # certain files from those directories. Note that the wildcards are matched yading@10: # against the file with absolute path, so to exclude all test directories yading@10: # for example use the pattern */test/* yading@10: yading@10: EXCLUDE_PATTERNS = *.git \ yading@10: *.d yading@10: yading@10: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names yading@10: # (namespaces, classes, functions, etc.) that should be excluded from the yading@10: # output. The symbol name can be a fully qualified name, a word, or if the yading@10: # wildcard * is used, a substring. Examples: ANamespace, AClass, yading@10: # AClass::ANamespace, ANamespace::*Test yading@10: yading@10: EXCLUDE_SYMBOLS = yading@10: yading@10: # The EXAMPLE_PATH tag can be used to specify one or more files or yading@10: # directories that contain example code fragments that are included (see yading@10: # the \include command). yading@10: yading@10: EXAMPLE_PATH = doc/examples/ yading@10: yading@10: # If the value of the EXAMPLE_PATH tag contains directories, you can use the yading@10: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp yading@10: # and *.h) to filter out the source-files in the directories. If left yading@10: # blank all files are included. yading@10: yading@10: EXAMPLE_PATTERNS = *.c yading@10: yading@10: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be yading@10: # searched for input files to be used with the \include or \dontinclude yading@10: # commands irrespective of the value of the RECURSIVE tag. yading@10: # Possible values are YES and NO. If left blank NO is used. yading@10: yading@10: EXAMPLE_RECURSIVE = NO yading@10: yading@10: # The IMAGE_PATH tag can be used to specify one or more files or yading@10: # directories that contain image that are included in the documentation (see yading@10: # the \image command). yading@10: yading@10: IMAGE_PATH = yading@10: yading@10: # The INPUT_FILTER tag can be used to specify a program that doxygen should yading@10: # invoke to filter for each input file. Doxygen will invoke the filter program yading@10: # by executing (via popen()) the command , where yading@10: # is the value of the INPUT_FILTER tag, and is the name of an yading@10: # input file. Doxygen will then use the output that the filter program writes yading@10: # to standard output. yading@10: # If FILTER_PATTERNS is specified, this tag will be yading@10: # ignored. yading@10: yading@10: INPUT_FILTER = yading@10: yading@10: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern yading@10: # basis. yading@10: # Doxygen will compare the file name with each pattern and apply the yading@10: # filter if there is a match. yading@10: # The filters are a list of the form: yading@10: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further yading@10: # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER yading@10: # is applied to all files. yading@10: yading@10: FILTER_PATTERNS = yading@10: yading@10: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using yading@10: # INPUT_FILTER) will be used to filter the input files when producing source yading@10: # files to browse (i.e. when SOURCE_BROWSER is set to YES). yading@10: yading@10: FILTER_SOURCE_FILES = NO yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to source browsing yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the SOURCE_BROWSER tag is set to YES then a list of source files will yading@10: # be generated. Documented entities will be cross-referenced with these sources. yading@10: # Note: To get rid of all source code in the generated output, make sure also yading@10: # VERBATIM_HEADERS is set to NO. yading@10: yading@10: SOURCE_BROWSER = YES yading@10: yading@10: # Setting the INLINE_SOURCES tag to YES will include the body yading@10: # of functions and classes directly in the documentation. yading@10: yading@10: INLINE_SOURCES = NO yading@10: yading@10: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct yading@10: # doxygen to hide any special comment blocks from generated source code yading@10: # fragments. Normal C and C++ comments will always remain visible. yading@10: yading@10: STRIP_CODE_COMMENTS = NO yading@10: yading@10: # If the REFERENCED_BY_RELATION tag is set to YES yading@10: # then for each documented function all documented yading@10: # functions referencing it will be listed. yading@10: yading@10: REFERENCED_BY_RELATION = YES yading@10: yading@10: # If the REFERENCES_RELATION tag is set to YES yading@10: # then for each documented function all documented entities yading@10: # called/used by that function will be listed. yading@10: yading@10: REFERENCES_RELATION = NO yading@10: yading@10: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) yading@10: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from yading@10: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will yading@10: # link to the source code. yading@10: # Otherwise they will link to the documentation. yading@10: yading@10: REFERENCES_LINK_SOURCE = YES yading@10: yading@10: # If the USE_HTAGS tag is set to YES then the references to source code yading@10: # will point to the HTML generated by the htags(1) tool instead of doxygen yading@10: # built-in source browser. The htags tool is part of GNU's global source yading@10: # tagging system (see http://www.gnu.org/software/global/global.html). You yading@10: # will need version 4.8.6 or higher. yading@10: yading@10: USE_HTAGS = NO yading@10: yading@10: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen yading@10: # will generate a verbatim copy of the header file for each class for yading@10: # which an include is specified. Set to NO to disable this. yading@10: yading@10: VERBATIM_HEADERS = YES yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the alphabetical class index yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index yading@10: # of all compounds will be generated. Enable this if the project yading@10: # contains a lot of classes, structs, unions or interfaces. yading@10: yading@10: ALPHABETICAL_INDEX = YES yading@10: yading@10: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then yading@10: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns yading@10: # in which this list will be split (can be a number in the range [1..20]) yading@10: yading@10: COLS_IN_ALPHA_INDEX = 2 yading@10: yading@10: # In case all classes in a project start with a common prefix, all yading@10: # classes will be put under the same header in the alphabetical index. yading@10: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that yading@10: # should be ignored while generating the index headers. yading@10: yading@10: IGNORE_PREFIX = yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the HTML output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will yading@10: # generate HTML output. yading@10: yading@10: GENERATE_HTML = YES yading@10: yading@10: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. yading@10: # If a relative path is entered the value of OUTPUT_DIRECTORY will be yading@10: # put in front of it. If left blank `html' will be used as the default path. yading@10: yading@10: HTML_OUTPUT = html yading@10: yading@10: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for yading@10: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank yading@10: # doxygen will generate files with .html extension. yading@10: yading@10: HTML_FILE_EXTENSION = .html yading@10: yading@10: # The HTML_HEADER tag can be used to specify a personal HTML header for yading@10: # each generated HTML page. If it is left blank doxygen will generate a yading@10: # standard header. yading@10: yading@10: #HTML_HEADER = doc/doxy/header.html yading@10: yading@10: # The HTML_FOOTER tag can be used to specify a personal HTML footer for yading@10: # each generated HTML page. If it is left blank doxygen will generate a yading@10: # standard footer. yading@10: yading@10: #HTML_FOOTER = doc/doxy/footer.html yading@10: yading@10: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading yading@10: # style sheet that is used by each HTML page. It can be used to yading@10: # fine-tune the look of the HTML output. If the tag is left blank doxygen yading@10: # will generate a default style sheet. Note that doxygen will try to copy yading@10: # the style sheet file to the HTML output directory, so don't put your own yading@10: # stylesheet in the HTML output directory as well, or it will be erased! yading@10: yading@10: #HTML_STYLESHEET = doc/doxy/doxy_stylesheet.css yading@10: yading@10: # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. yading@10: # Doxygen will adjust the colors in the stylesheet and background images yading@10: # according to this color. Hue is specified as an angle on a colorwheel, yading@10: # see http://en.wikipedia.org/wiki/Hue for more information. yading@10: # For instance the value 0 represents red, 60 is yellow, 120 is green, yading@10: # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. yading@10: # The allowed range is 0 to 359. yading@10: yading@10: #HTML_COLORSTYLE_HUE = 120 yading@10: yading@10: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of yading@10: # the colors in the HTML output. For a value of 0 the output will use yading@10: # grayscales only. A value of 255 will produce the most vivid colors. yading@10: yading@10: HTML_COLORSTYLE_SAT = 100 yading@10: yading@10: # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to yading@10: # the luminance component of the colors in the HTML output. Values below yading@10: # 100 gradually make the output lighter, whereas values above 100 make yading@10: # the output darker. The value divided by 100 is the actual gamma applied, yading@10: # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, yading@10: # and 100 does not change the gamma. yading@10: yading@10: HTML_COLORSTYLE_GAMMA = 80 yading@10: yading@10: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML yading@10: # page will contain the date and time when the page was generated. Setting yading@10: # this to NO can help when comparing the output of multiple runs. yading@10: yading@10: HTML_TIMESTAMP = YES yading@10: yading@10: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML yading@10: # documentation will contain sections that can be hidden and shown after the yading@10: # page has loaded. For this to work a browser that supports yading@10: # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox yading@10: # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). yading@10: yading@10: HTML_DYNAMIC_SECTIONS = NO yading@10: yading@10: # If the GENERATE_DOCSET tag is set to YES, additional index files yading@10: # will be generated that can be used as input for Apple's Xcode 3 yading@10: # integrated development environment, introduced with OS X 10.5 (Leopard). yading@10: # To create a documentation set, doxygen will generate a Makefile in the yading@10: # HTML output directory. Running make will produce the docset in that yading@10: # directory and running "make install" will install the docset in yading@10: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find yading@10: # it at startup. yading@10: # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html yading@10: # for more information. yading@10: yading@10: GENERATE_DOCSET = NO yading@10: yading@10: # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the yading@10: # feed. A documentation feed provides an umbrella under which multiple yading@10: # documentation sets from a single provider (such as a company or product suite) yading@10: # can be grouped. yading@10: yading@10: DOCSET_FEEDNAME = "Doxygen generated docs" yading@10: yading@10: # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that yading@10: # should uniquely identify the documentation set bundle. This should be a yading@10: # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen yading@10: # will append .docset to the name. yading@10: yading@10: DOCSET_BUNDLE_ID = org.doxygen.Project yading@10: yading@10: # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify yading@10: # the documentation publisher. This should be a reverse domain-name style yading@10: # string, e.g. com.mycompany.MyDocSet.documentation. yading@10: yading@10: DOCSET_PUBLISHER_ID = org.doxygen.Publisher yading@10: yading@10: # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. yading@10: yading@10: DOCSET_PUBLISHER_NAME = Publisher yading@10: yading@10: # If the GENERATE_HTMLHELP tag is set to YES, additional index files yading@10: # will be generated that can be used as input for tools like the yading@10: # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) yading@10: # of the generated HTML documentation. yading@10: yading@10: GENERATE_HTMLHELP = NO yading@10: yading@10: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can yading@10: # be used to specify the file name of the resulting .chm file. You yading@10: # can add a path in front of the file if the result should not be yading@10: # written to the html output directory. yading@10: yading@10: CHM_FILE = yading@10: yading@10: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can yading@10: # be used to specify the location (absolute path including file name) of yading@10: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run yading@10: # the HTML help compiler on the generated index.hhp. yading@10: yading@10: HHC_LOCATION = yading@10: yading@10: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag yading@10: # controls if a separate .chi index file is generated (YES) or that yading@10: # it should be included in the master .chm file (NO). yading@10: yading@10: GENERATE_CHI = NO yading@10: yading@10: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING yading@10: # is used to encode HtmlHelp index (hhk), content (hhc) and project file yading@10: # content. yading@10: yading@10: CHM_INDEX_ENCODING = yading@10: yading@10: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag yading@10: # controls whether a binary table of contents is generated (YES) or a yading@10: # normal table of contents (NO) in the .chm file. yading@10: yading@10: BINARY_TOC = NO yading@10: yading@10: # The TOC_EXPAND flag can be set to YES to add extra items for group members yading@10: # to the contents of the HTML help documentation and to the tree view. yading@10: yading@10: TOC_EXPAND = NO yading@10: yading@10: # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and yading@10: # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated yading@10: # that can be used as input for Qt's qhelpgenerator to generate a yading@10: # Qt Compressed Help (.qch) of the generated HTML documentation. yading@10: yading@10: GENERATE_QHP = NO yading@10: yading@10: # If the QHG_LOCATION tag is specified, the QCH_FILE tag can yading@10: # be used to specify the file name of the resulting .qch file. yading@10: # The path specified is relative to the HTML output folder. yading@10: yading@10: QCH_FILE = yading@10: yading@10: # The QHP_NAMESPACE tag specifies the namespace to use when generating yading@10: # Qt Help Project output. For more information please see yading@10: # http://doc.trolltech.com/qthelpproject.html#namespace yading@10: yading@10: QHP_NAMESPACE = org.doxygen.Project yading@10: yading@10: # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating yading@10: # Qt Help Project output. For more information please see yading@10: # http://doc.trolltech.com/qthelpproject.html#virtual-folders yading@10: yading@10: QHP_VIRTUAL_FOLDER = doc yading@10: yading@10: # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to yading@10: # add. For more information please see yading@10: # http://doc.trolltech.com/qthelpproject.html#custom-filters yading@10: yading@10: QHP_CUST_FILTER_NAME = yading@10: yading@10: # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the yading@10: # custom filter to add. For more information please see yading@10: # yading@10: # Qt Help Project / Custom Filters. yading@10: yading@10: QHP_CUST_FILTER_ATTRS = yading@10: yading@10: # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this yading@10: # project's yading@10: # filter section matches. yading@10: # yading@10: # Qt Help Project / Filter Attributes. yading@10: yading@10: QHP_SECT_FILTER_ATTRS = yading@10: yading@10: # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can yading@10: # be used to specify the location of Qt's qhelpgenerator. yading@10: # If non-empty doxygen will try to run qhelpgenerator on the generated yading@10: # .qhp file. yading@10: yading@10: QHG_LOCATION = yading@10: yading@10: # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files yading@10: # will be generated, which together with the HTML files, form an Eclipse help yading@10: # plugin. To install this plugin and make it available under the help contents yading@10: # menu in Eclipse, the contents of the directory containing the HTML and XML yading@10: # files needs to be copied into the plugins directory of eclipse. The name of yading@10: # the directory within the plugins directory should be the same as yading@10: # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before yading@10: # the help appears. yading@10: yading@10: GENERATE_ECLIPSEHELP = NO yading@10: yading@10: # A unique identifier for the eclipse help plugin. When installing the plugin yading@10: # the directory name containing the HTML and XML files should also have yading@10: # this name. yading@10: yading@10: ECLIPSE_DOC_ID = org.doxygen.Project yading@10: yading@10: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at yading@10: # top of each HTML page. The value NO (the default) enables the index and yading@10: # the value YES disables it. yading@10: yading@10: DISABLE_INDEX = NO yading@10: yading@10: # This tag can be used to set the number of enum values (range [1..20]) yading@10: # that doxygen will group on one line in the generated HTML documentation. yading@10: yading@10: ENUM_VALUES_PER_LINE = 4 yading@10: yading@10: # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index yading@10: # structure should be generated to display hierarchical information. yading@10: # If the tag value is set to YES, a side panel will be generated yading@10: # containing a tree-like index structure (just like the one that yading@10: # is generated for HTML Help). For this to work a browser that supports yading@10: # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). yading@10: # Windows users are probably better off using the HTML help feature. yading@10: yading@10: GENERATE_TREEVIEW = NO yading@10: yading@10: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be yading@10: # used to set the initial width (in pixels) of the frame in which the tree yading@10: # is shown. yading@10: yading@10: TREEVIEW_WIDTH = 250 yading@10: yading@10: # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open yading@10: # links to external symbols imported via tag files in a separate window. yading@10: yading@10: EXT_LINKS_IN_WINDOW = NO yading@10: yading@10: # Use this tag to change the font size of Latex formulas included yading@10: # as images in the HTML documentation. The default is 10. Note that yading@10: # when you change the font size after a successful doxygen run you need yading@10: # to manually remove any form_*.png images from the HTML output directory yading@10: # to force them to be regenerated. yading@10: yading@10: FORMULA_FONTSIZE = 10 yading@10: yading@10: # Use the FORMULA_TRANPARENT tag to determine whether or not the images yading@10: # generated for formulas are transparent PNGs. Transparent PNGs are yading@10: # not supported properly for IE 6.0, but are supported on all modern browsers. yading@10: # Note that when changing this option you need to delete any form_*.png files yading@10: # in the HTML output before the changes have effect. yading@10: yading@10: FORMULA_TRANSPARENT = YES yading@10: yading@10: # When the SEARCHENGINE tag is enabled doxygen will generate a search box yading@10: # for the HTML output. The underlying search engine uses javascript yading@10: # and DHTML and should work on any modern browser. Note that when using yading@10: # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets yading@10: # (GENERATE_DOCSET) there is already a search function so this one should yading@10: # typically be disabled. For large projects the javascript based search engine yading@10: # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. yading@10: yading@10: SEARCHENGINE = NO yading@10: yading@10: # When the SERVER_BASED_SEARCH tag is enabled the search engine will be yading@10: # implemented using a PHP enabled web server instead of at the web client yading@10: # using Javascript. Doxygen will generate the search PHP script and index yading@10: # file to put on the web server. The advantage of the server yading@10: # based approach is that it scales better to large projects and allows yading@10: # full text search. The disadvances is that it is more difficult to setup yading@10: # and does not have live searching capabilities. yading@10: yading@10: SERVER_BASED_SEARCH = NO yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the LaTeX output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will yading@10: # generate Latex output. yading@10: yading@10: GENERATE_LATEX = NO yading@10: yading@10: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. yading@10: # If a relative path is entered the value of OUTPUT_DIRECTORY will be yading@10: # put in front of it. If left blank `latex' will be used as the default path. yading@10: yading@10: LATEX_OUTPUT = latex yading@10: yading@10: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be yading@10: # invoked. If left blank `latex' will be used as the default command name. yading@10: # Note that when enabling USE_PDFLATEX this option is only used for yading@10: # generating bitmaps for formulas in the HTML output, but not in the yading@10: # Makefile that is written to the output directory. yading@10: yading@10: LATEX_CMD_NAME = latex yading@10: yading@10: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to yading@10: # generate index for LaTeX. If left blank `makeindex' will be used as the yading@10: # default command name. yading@10: yading@10: MAKEINDEX_CMD_NAME = makeindex yading@10: yading@10: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact yading@10: # LaTeX documents. This may be useful for small projects and may help to yading@10: # save some trees in general. yading@10: yading@10: COMPACT_LATEX = NO yading@10: yading@10: # The PAPER_TYPE tag can be used to set the paper type that is used yading@10: # by the printer. Possible values are: a4, a4wide, letter, legal and yading@10: # executive. If left blank a4wide will be used. yading@10: yading@10: PAPER_TYPE = a4wide yading@10: yading@10: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX yading@10: # packages that should be included in the LaTeX output. yading@10: yading@10: EXTRA_PACKAGES = yading@10: yading@10: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for yading@10: # the generated latex document. The header should contain everything until yading@10: # the first chapter. If it is left blank doxygen will generate a yading@10: # standard header. Notice: only use this tag if you know what you are doing! yading@10: yading@10: LATEX_HEADER = yading@10: yading@10: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated yading@10: # is prepared for conversion to pdf (using ps2pdf). The pdf file will yading@10: # contain links (just like the HTML output) instead of page references yading@10: # This makes the output suitable for online browsing using a pdf viewer. yading@10: yading@10: PDF_HYPERLINKS = NO yading@10: yading@10: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of yading@10: # plain latex in the generated Makefile. Set this option to YES to get a yading@10: # higher quality PDF documentation. yading@10: yading@10: USE_PDFLATEX = NO yading@10: yading@10: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. yading@10: # command to the generated LaTeX files. This will instruct LaTeX to keep yading@10: # running if errors occur, instead of asking the user for help. yading@10: # This option is also used when generating formulas in HTML. yading@10: yading@10: LATEX_BATCHMODE = NO yading@10: yading@10: # If LATEX_HIDE_INDICES is set to YES then doxygen will not yading@10: # include the index chapters (such as File Index, Compound Index, etc.) yading@10: # in the output. yading@10: yading@10: LATEX_HIDE_INDICES = NO yading@10: yading@10: # If LATEX_SOURCE_CODE is set to YES then doxygen will include yading@10: # source code with syntax highlighting in the LaTeX output. yading@10: # Note that which sources are shown also depends on other settings yading@10: # such as SOURCE_BROWSER. yading@10: yading@10: LATEX_SOURCE_CODE = NO yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the RTF output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output yading@10: # The RTF output is optimized for Word 97 and may not look very pretty with yading@10: # other RTF readers or editors. yading@10: yading@10: GENERATE_RTF = NO yading@10: yading@10: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. yading@10: # If a relative path is entered the value of OUTPUT_DIRECTORY will be yading@10: # put in front of it. If left blank `rtf' will be used as the default path. yading@10: yading@10: RTF_OUTPUT = rtf yading@10: yading@10: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact yading@10: # RTF documents. This may be useful for small projects and may help to yading@10: # save some trees in general. yading@10: yading@10: COMPACT_RTF = NO yading@10: yading@10: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated yading@10: # will contain hyperlink fields. The RTF file will yading@10: # contain links (just like the HTML output) instead of page references. yading@10: # This makes the output suitable for online browsing using WORD or other yading@10: # programs which support those fields. yading@10: # Note: wordpad (write) and others do not support links. yading@10: yading@10: RTF_HYPERLINKS = NO yading@10: yading@10: # Load stylesheet definitions from file. Syntax is similar to doxygen's yading@10: # config file, i.e. a series of assignments. You only have to provide yading@10: # replacements, missing definitions are set to their default value. yading@10: yading@10: RTF_STYLESHEET_FILE = yading@10: yading@10: # Set optional variables used in the generation of an rtf document. yading@10: # Syntax is similar to doxygen's config file. yading@10: yading@10: RTF_EXTENSIONS_FILE = yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the man page output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will yading@10: # generate man pages yading@10: yading@10: GENERATE_MAN = NO yading@10: yading@10: # The MAN_OUTPUT tag is used to specify where the man pages will be put. yading@10: # If a relative path is entered the value of OUTPUT_DIRECTORY will be yading@10: # put in front of it. If left blank `man' will be used as the default path. yading@10: yading@10: MAN_OUTPUT = man yading@10: yading@10: # The MAN_EXTENSION tag determines the extension that is added to yading@10: # the generated man pages (default is the subroutine's section .3) yading@10: yading@10: MAN_EXTENSION = .3 yading@10: yading@10: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, yading@10: # then it will generate one additional man file for each entity yading@10: # documented in the real man page(s). These additional files yading@10: # only source the real man page, but without them the man command yading@10: # would be unable to find the correct page. The default is NO. yading@10: yading@10: MAN_LINKS = NO yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the XML output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_XML tag is set to YES Doxygen will yading@10: # generate an XML file that captures the structure of yading@10: # the code including all documentation. yading@10: yading@10: GENERATE_XML = NO yading@10: yading@10: # The XML_OUTPUT tag is used to specify where the XML pages will be put. yading@10: # If a relative path is entered the value of OUTPUT_DIRECTORY will be yading@10: # put in front of it. If left blank `xml' will be used as the default path. yading@10: yading@10: XML_OUTPUT = xml yading@10: yading@10: # The XML_SCHEMA tag can be used to specify an XML schema, yading@10: # which can be used by a validating XML parser to check the yading@10: # syntax of the XML files. yading@10: yading@10: XML_SCHEMA = yading@10: yading@10: # The XML_DTD tag can be used to specify an XML DTD, yading@10: # which can be used by a validating XML parser to check the yading@10: # syntax of the XML files. yading@10: yading@10: XML_DTD = yading@10: yading@10: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will yading@10: # dump the program listings (including syntax highlighting yading@10: # and cross-referencing information) to the XML output. Note that yading@10: # enabling this will significantly increase the size of the XML output. yading@10: yading@10: XML_PROGRAMLISTING = YES yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options for the AutoGen Definitions output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will yading@10: # generate an AutoGen Definitions (see autogen.sf.net) file yading@10: # that captures the structure of the code including all yading@10: # documentation. Note that this feature is still experimental yading@10: # and incomplete at the moment. yading@10: yading@10: GENERATE_AUTOGEN_DEF = NO yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # configuration options related to the Perl module output yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the GENERATE_PERLMOD tag is set to YES Doxygen will yading@10: # generate a Perl module file that captures the structure of yading@10: # the code including all documentation. Note that this yading@10: # feature is still experimental and incomplete at the yading@10: # moment. yading@10: yading@10: GENERATE_PERLMOD = NO yading@10: yading@10: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate yading@10: # the necessary Makefile rules, Perl scripts and LaTeX code to be able yading@10: # to generate PDF and DVI output from the Perl module output. yading@10: yading@10: PERLMOD_LATEX = NO yading@10: yading@10: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be yading@10: # nicely formatted so it can be parsed by a human reader. yading@10: # This is useful yading@10: # if you want to understand what is going on. yading@10: # On the other hand, if this yading@10: # tag is set to NO the size of the Perl module output will be much smaller yading@10: # and Perl will parse it just the same. yading@10: yading@10: PERLMOD_PRETTY = YES yading@10: yading@10: # The names of the make variables in the generated doxyrules.make file yading@10: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. yading@10: # This is useful so different doxyrules.make files included by the same yading@10: # Makefile don't overwrite each other's variables. yading@10: yading@10: PERLMOD_MAKEVAR_PREFIX = yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # Configuration options related to the preprocessor yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will yading@10: # evaluate all C-preprocessor directives found in the sources and include yading@10: # files. yading@10: yading@10: ENABLE_PREPROCESSING = YES yading@10: yading@10: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro yading@10: # names in the source code. If set to NO (the default) only conditional yading@10: # compilation will be performed. Macro expansion can be done in a controlled yading@10: # way by setting EXPAND_ONLY_PREDEF to YES. yading@10: yading@10: MACRO_EXPANSION = YES yading@10: yading@10: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES yading@10: # then the macro expansion is limited to the macros specified with the yading@10: # PREDEFINED and EXPAND_AS_DEFINED tags. yading@10: yading@10: EXPAND_ONLY_PREDEF = YES yading@10: yading@10: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files yading@10: # in the INCLUDE_PATH (see below) will be search if a #include is found. yading@10: yading@10: SEARCH_INCLUDES = YES yading@10: yading@10: # The INCLUDE_PATH tag can be used to specify one or more directories that yading@10: # contain include files that are not input files but should be processed by yading@10: # the preprocessor. yading@10: yading@10: INCLUDE_PATH = yading@10: yading@10: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard yading@10: # patterns (like *.h and *.hpp) to filter out the header-files in the yading@10: # directories. If left blank, the patterns specified with FILE_PATTERNS will yading@10: # be used. yading@10: yading@10: INCLUDE_FILE_PATTERNS = yading@10: yading@10: # The PREDEFINED tag can be used to specify one or more macro names that yading@10: # are defined before the preprocessor is started (similar to the -D option of yading@10: # gcc). The argument of the tag is a list of macros of the form: name yading@10: # or name=definition (no spaces). If the definition and the = are yading@10: # omitted =1 is assumed. To prevent a macro definition from being yading@10: # undefined via #undef or recursively expanded use the := operator yading@10: # instead of the = operator. yading@10: yading@10: PREDEFINED = "__attribute__(x)=" \ yading@10: "DECLARE_ALIGNED(a,t,n)=t n" \ yading@10: "offsetof(x,y)=0x42" \ yading@10: av_alloc_size \ yading@10: yading@10: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then yading@10: # this tag can be used to specify a list of macro names that should be expanded. yading@10: # The macro definition that is found in the sources will be used. yading@10: # Use the PREDEFINED tag if you want to use a different macro definition. yading@10: yading@10: EXPAND_AS_DEFINED = declare_idct \ yading@10: READ_PAR_DATA \ yading@10: yading@10: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then yading@10: # doxygen's preprocessor will remove all function-like macros that are alone yading@10: # on a line, have an all uppercase name, and do not end with a semicolon. Such yading@10: # function macros are typically used for boiler-plate code, and will confuse yading@10: # the parser if not removed. yading@10: yading@10: SKIP_FUNCTION_MACROS = YES yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # Configuration::additions related to external references yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # The TAGFILES option can be used to specify one or more tagfiles. yading@10: # Optionally an initial location of the external documentation yading@10: # can be added for each tagfile. The format of a tag file without yading@10: # this location is as follows: yading@10: # yading@10: # TAGFILES = file1 file2 ... yading@10: # Adding location for the tag files is done as follows: yading@10: # yading@10: # TAGFILES = file1=loc1 "file2 = loc2" ... yading@10: # where "loc1" and "loc2" can be relative or absolute paths or yading@10: # URLs. If a location is present for each tag, the installdox tool yading@10: # does not have to be run to correct the links. yading@10: # Note that each tag file must have a unique name yading@10: # (where the name does NOT include the path) yading@10: # If a tag file is not located in the directory in which doxygen yading@10: # is run, you must also specify the path to the tagfile here. yading@10: yading@10: TAGFILES = yading@10: yading@10: # When a file name is specified after GENERATE_TAGFILE, doxygen will create yading@10: # a tag file that is based on the input files it reads. yading@10: yading@10: GENERATE_TAGFILE = yading@10: yading@10: # If the ALLEXTERNALS tag is set to YES all external classes will be listed yading@10: # in the class index. If set to NO only the inherited external classes yading@10: # will be listed. yading@10: yading@10: ALLEXTERNALS = NO yading@10: yading@10: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed yading@10: # in the modules index. If set to NO, only the current project's groups will yading@10: # be listed. yading@10: yading@10: EXTERNAL_GROUPS = YES yading@10: yading@10: # The PERL_PATH should be the absolute path and name of the perl script yading@10: # interpreter (i.e. the result of `which perl'). yading@10: yading@10: PERL_PATH = /usr/bin/perl yading@10: yading@10: #--------------------------------------------------------------------------- yading@10: # Configuration options related to the dot tool yading@10: #--------------------------------------------------------------------------- yading@10: yading@10: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will yading@10: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base yading@10: # or super classes. Setting the tag to NO turns the diagrams off. Note that yading@10: # this option is superseded by the HAVE_DOT option below. This is only a yading@10: # fallback. It is recommended to install and use dot, since it yields more yading@10: # powerful graphs. yading@10: yading@10: CLASS_DIAGRAMS = YES yading@10: yading@10: # You can define message sequence charts within doxygen comments using the \msc yading@10: # command. Doxygen will then run the mscgen tool (see yading@10: # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the yading@10: # documentation. The MSCGEN_PATH tag allows you to specify the directory where yading@10: # the mscgen tool resides. If left empty the tool is assumed to be found in the yading@10: # default search path. yading@10: yading@10: MSCGEN_PATH = yading@10: yading@10: # If set to YES, the inheritance and collaboration graphs will hide yading@10: # inheritance and usage relations if the target is undocumented yading@10: # or is not a class. yading@10: yading@10: HIDE_UNDOC_RELATIONS = YES yading@10: yading@10: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is yading@10: # available from the path. This tool is part of Graphviz, a graph visualization yading@10: # toolkit from AT&T and Lucent Bell Labs. The other options in this section yading@10: # have no effect if this option is set to NO (the default) yading@10: yading@10: HAVE_DOT = NO yading@10: yading@10: # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is yading@10: # allowed to run in parallel. When set to 0 (the default) doxygen will yading@10: # base this on the number of processors available in the system. You can set it yading@10: # explicitly to a value larger than 0 to get control over the balance yading@10: # between CPU load and processing speed. yading@10: yading@10: DOT_NUM_THREADS = 0 yading@10: yading@10: # By default doxygen will write a font called FreeSans.ttf to the output yading@10: # directory and reference it in all dot files that doxygen generates. This yading@10: # font does not include all possible unicode characters however, so when you need yading@10: # these (or just want a differently looking font) you can specify the font name yading@10: # using DOT_FONTNAME. You need need to make sure dot is able to find the font, yading@10: # which can be done by putting it in a standard location or by setting the yading@10: # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory yading@10: # containing the font. yading@10: yading@10: DOT_FONTNAME = FreeSans yading@10: yading@10: # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. yading@10: # The default size is 10pt. yading@10: yading@10: DOT_FONTSIZE = 10 yading@10: yading@10: # By default doxygen will tell dot to use the output directory to look for the yading@10: # FreeSans.ttf font (which doxygen will put there itself). If you specify a yading@10: # different font using DOT_FONTNAME you can set the path where dot yading@10: # can find it using this tag. yading@10: yading@10: DOT_FONTPATH = yading@10: yading@10: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen yading@10: # will generate a graph for each documented class showing the direct and yading@10: # indirect inheritance relations. Setting this tag to YES will force the yading@10: # the CLASS_DIAGRAMS tag to NO. yading@10: yading@10: CLASS_GRAPH = YES yading@10: yading@10: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen yading@10: # will generate a graph for each documented class showing the direct and yading@10: # indirect implementation dependencies (inheritance, containment, and yading@10: # class references variables) of the class with other documented classes. yading@10: yading@10: COLLABORATION_GRAPH = YES yading@10: yading@10: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen yading@10: # will generate a graph for groups, showing the direct groups dependencies yading@10: yading@10: GROUP_GRAPHS = YES yading@10: yading@10: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and yading@10: # collaboration diagrams in a style similar to the OMG's Unified Modeling yading@10: # Language. yading@10: yading@10: UML_LOOK = NO yading@10: yading@10: # If set to YES, the inheritance and collaboration graphs will show the yading@10: # relations between templates and their instances. yading@10: yading@10: TEMPLATE_RELATIONS = YES yading@10: yading@10: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT yading@10: # tags are set to YES then doxygen will generate a graph for each documented yading@10: # file showing the direct and indirect include dependencies of the file with yading@10: # other documented files. yading@10: yading@10: INCLUDE_GRAPH = YES yading@10: yading@10: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and yading@10: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each yading@10: # documented header file showing the documented files that directly or yading@10: # indirectly include this file. yading@10: yading@10: INCLUDED_BY_GRAPH = YES yading@10: yading@10: # If the CALL_GRAPH and HAVE_DOT options are set to YES then yading@10: # doxygen will generate a call dependency graph for every global function yading@10: # or class method. Note that enabling this option will significantly increase yading@10: # the time of a run. So in most cases it will be better to enable call graphs yading@10: # for selected functions only using the \callgraph command. yading@10: yading@10: CALL_GRAPH = NO yading@10: yading@10: # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then yading@10: # doxygen will generate a caller dependency graph for every global function yading@10: # or class method. Note that enabling this option will significantly increase yading@10: # the time of a run. So in most cases it will be better to enable caller yading@10: # graphs for selected functions only using the \callergraph command. yading@10: yading@10: CALLER_GRAPH = NO yading@10: yading@10: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen yading@10: # will graphical hierarchy of all classes instead of a textual one. yading@10: yading@10: GRAPHICAL_HIERARCHY = YES yading@10: yading@10: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES yading@10: # then doxygen will show the dependencies a directory has on other directories yading@10: # in a graphical way. The dependency relations are determined by the #include yading@10: # relations between the files in the directories. yading@10: yading@10: DIRECTORY_GRAPH = YES yading@10: yading@10: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images yading@10: # generated by dot. Possible values are png, jpg, or gif yading@10: # If left blank png will be used. yading@10: yading@10: DOT_IMAGE_FORMAT = png yading@10: yading@10: # The tag DOT_PATH can be used to specify the path where the dot tool can be yading@10: # found. If left blank, it is assumed the dot tool can be found in the path. yading@10: yading@10: DOT_PATH = yading@10: yading@10: # The DOTFILE_DIRS tag can be used to specify one or more directories that yading@10: # contain dot files that are included in the documentation (see the yading@10: # \dotfile command). yading@10: yading@10: DOTFILE_DIRS = yading@10: yading@10: # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of yading@10: # nodes that will be shown in the graph. If the number of nodes in a graph yading@10: # becomes larger than this value, doxygen will truncate the graph, which is yading@10: # visualized by representing a node as a red box. Note that doxygen if the yading@10: # number of direct children of the root node in a graph is already larger than yading@10: # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note yading@10: # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. yading@10: yading@10: DOT_GRAPH_MAX_NODES = 50 yading@10: yading@10: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the yading@10: # graphs generated by dot. A depth value of 3 means that only nodes reachable yading@10: # from the root by following a path via at most 3 edges will be shown. Nodes yading@10: # that lay further from the root node will be omitted. Note that setting this yading@10: # option to 1 or 2 may greatly reduce the computation time needed for large yading@10: # code bases. Also note that the size of a graph can be further restricted by yading@10: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. yading@10: yading@10: MAX_DOT_GRAPH_DEPTH = 0 yading@10: yading@10: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent yading@10: # background. This is disabled by default, because dot on Windows does not yading@10: # seem to support this out of the box. Warning: Depending on the platform used, yading@10: # enabling this option may lead to badly anti-aliased labels on the edges of yading@10: # a graph (i.e. they become hard to read). yading@10: yading@10: DOT_TRANSPARENT = YES yading@10: yading@10: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output yading@10: # files in one run (i.e. multiple -o and -T options on the command line). This yading@10: # makes dot run faster, but since only newer versions of dot (>1.8.10) yading@10: # support this, this feature is disabled by default. yading@10: yading@10: DOT_MULTI_TARGETS = NO yading@10: yading@10: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will yading@10: # generate a legend page explaining the meaning of the various boxes and yading@10: # arrows in the dot generated graphs. yading@10: yading@10: GENERATE_LEGEND = YES yading@10: yading@10: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will yading@10: # remove the intermediate dot files that are used to generate yading@10: # the various graphs. yading@10: yading@10: DOT_CLEANUP = YES