Lines Matching +full:- +full:no +full:- +full:doxygen

4 # doxygen (www.doxygen.org) for a project.
13 #---------------------------------------------------------------------------
15 #---------------------------------------------------------------------------
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 DOXYFILE_ENCODING = UTF-8
46 # Doxygen will copy the logo to the output directory.
53 # where doxygen was started. If left blank the current directory will be used.
55 OUTPUT_DIRECTORY = doc/doxygen/generated
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58 # 4096 sub-directories (in 2 levels) under the output directory of each output
60 # Enabling this option can be useful when feeding doxygen a huge amount of
64 CREATE_SUBDIRS = NO
67 # documentation generated by doxygen is written. Doxygen will use this
70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
82 # Set to NO to disable this.
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93 # This tag implements a quasi-intelligent brief description abbreviator
97 # used as the annotated text. Otherwise, the brief description is used as-is.
106 # Doxygen will generate a detailed section even if there is only a brief
109 ALWAYS_DETAILED_SEC = NO
111 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
116 INLINE_INHERITED_MEMB = NO
118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
120 # to NO the shortest path that makes the file name unique will be used.
122 FULL_PATH_NAMES = NO
125 # can be used to strip a user-defined part of the path. Stripping is
126 # only done if one of the specified strings matches the left-hand part of
128 # If left blank the directory from which doxygen is run is used as the
130 # relative paths, which will be relative from the directory where doxygen is
135 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
140 # are normally passed to the compiler using the -I flag.
144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
146 # doesn't support long names like on DOS, Mac, or CD-ROM.
148 SHORT_NAMES = NO
150 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
151 # will interpret the first line (until the first dot) of a JavaDoc-style
152 # comment as the brief description. If set to NO, the JavaDoc
153 # comments will behave just like regular Qt-style comments
156 JAVADOC_AUTOBRIEF = NO
158 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159 # interpret the first line (until the first dot) of a Qt-style
160 # comment as the brief description. If set to NO, the comments
161 # will behave just like regular Qt-style comments (thus requiring
164 QT_AUTOBRIEF = NO
166 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
169 # The new default is to treat a multi-line C++ comment block as a detailed
172 MULTILINE_CPP_IS_BRIEF = NO
176 # re-implements.
180 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181 # a new page for each member. If set to NO, the documentation of a member will
184 SEPARATE_MEMBER_PAGES = NO
187 # Doxygen uses this value to replace tabs by spaces in code fragments.
195 # will result in a user-defined paragraph with heading "Side Effects:".
200 # This tag can be used to specify a number of word-keyword mappings (TCL only).
208 # sources only. Doxygen will then generate output that is more tailored for C.
212 OPTIMIZE_OUTPUT_FOR_C = NO
215 # sources only. Doxygen will then generate output that is more tailored for
219 OPTIMIZE_OUTPUT_JAVA = NO
222 # sources only. Doxygen will then generate output that is more tailored for
225 OPTIMIZE_FOR_FORTRAN = NO
228 # sources. Doxygen will then generate output that is tailored for
231 OPTIMIZE_OUTPUT_VHDL = NO
233 # Doxygen selects the parser to use depending on the extension of the files it
235 # extension. Doxygen has a built-in mapping, but you can override or extend it
237 # and language is one of the parsers supported by doxygen: IDL, Java,
238 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
239 # C++. For instance to make doxygen treat .inc files as Fortran files (default
242 # files are not read by doxygen.
246 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
249 # The output of markdown processing is further processed by doxygen, so you
250 # can mix doxygen, HTML, and XML commands with Markdown formatting.
255 # When enabled doxygen tries to link words that correspond to documented classes,
258 # globally by setting AUTOLINK_SUPPORT to NO.
264 # set this tag to YES in order to let doxygen match functions declarations and
269 BUILTIN_STL_SUPPORT = NO
274 CPP_CLI_SUPPORT = NO
277 # Doxygen will parse them like normal C++ but will assume all classes use public
278 # instead of private inheritance when no explicit protection keyword is present.
280 SIP_SUPPORT = NO
284 # option to YES (the default) will make doxygen replace the get and
288 # set this option to NO.
293 # tag is set to YES, then doxygen will reuse the documentation of the first
297 DISTRIBUTE_GROUP_DOC = NO
302 # NO to prevent subgrouping. Alternatively, this can be done per class using
312 INLINE_GROUPED_CLASSES = NO
317 # documentation), provided this scope is documented. If set to NO (the default),
321 INLINE_SIMPLE_STRUCTS = NO
331 TYPEDEF_HIDES_STRUCT = NO
338 # doxygen to be busy swapping symbols to and from disk most of the time
352 # same symbol appear multiple times in the code, doxygen keeps a cache of
353 # pre-resolved symbols. If the cache is too small doxygen will become slower.
360 #---------------------------------------------------------------------------
362 #---------------------------------------------------------------------------
364 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
365 # documentation are documented, even if no documentation was available.
369 EXTRACT_ALL = NO
379 EXTRACT_PACKAGE = NO
388 # If set to NO only classes defined in header files are included.
392 # This flag is only useful for Objective-C code. When set to YES local
395 # If set to NO (the default) only methods in the interface are included.
397 EXTRACT_LOCAL_METHODS = NO
405 EXTRACT_ANON_NSPACES = NO
407 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
409 # If set to NO (the default) these members will be included in the
410 # various overviews, but no documentation section is generated.
411 # This option has no effect if EXTRACT_ALL is enabled.
415 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
417 # If set to NO (the default) these classes will be included in the various
418 # overviews. This option has no effect if EXTRACT_ALL is enabled.
422 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
424 # If set to NO (the default) these declarations will be included in the
427 HIDE_FRIEND_COMPOUNDS = NO
429 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
431 # If set to NO (the default) these blocks will be appended to the
434 HIDE_IN_BODY_DOCS = NO
438 # to NO (the default) then the documentation will be excluded.
441 INTERNAL_DOCS = NO
443 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
444 # file names in lower-case letters. If set to YES upper-case letters are also
447 # and Mac users are advised to set this option to NO.
451 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
455 HIDE_SCOPE_NAMES = NO
457 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
463 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
467 FORCE_LOCAL_INCLUDES = NO
474 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
476 # alphabetically by member name. If set to NO the members will appear in
481 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
483 # by member name. If set to NO (the default) the members will appear in
486 SORT_BRIEF_DOCS = NO
488 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
490 # constructors and destructors are listed first. If set to NO (the default)
493 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
494 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
496 SORT_MEMBERS_CTORS_1ST = NO
498 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
499 # hierarchy of group names into alphabetical order. If set to NO (the default)
502 SORT_GROUP_NAMES = NO
505 # sorted by fully-qualified names, including namespaces. If set to
506 # NO (the default), the class list will be sorted only by class name,
512 SORT_BY_SCOPE_NAME = NO
514 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
518 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
521 STRICT_PROTO_MATCHING = NO
524 # disable (NO) the todo list. This list is created by putting \todo
530 # disable (NO) the test list. This list is created by putting \test
536 # disable (NO) the bug list. This list is created by putting \bug
542 # disable (NO) the deprecated list. This list is created by putting
562 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
568 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
572 # We probably will want this, but we have no file documentation yet so it's simpler to remove
574 SHOW_FILES = NO
576 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
584 # doxygen should invoke to get the current version for each file (typically from
585 # the version control system). Doxygen will invoke the program by executing (via
586 # popen()) the command <command> <input-file>, where <command> is the value of
587 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
588 # provided by doxygen. Whatever the program writes to standard output
594 # by doxygen. The layout file controls the global structure of the generated
596 # that represents doxygen's defaults, run doxygen with the -l option.
612 #---------------------------------------------------------------------------
614 #---------------------------------------------------------------------------
617 # by doxygen. Possible values are YES and NO. If left blank NO is used.
619 QUIET = NO
622 # generated by doxygen. Possible values are YES and NO. If left blank
623 # NO is used.
627 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
633 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
641 # functions that are documented, but have no documentation for their parameters
642 # or return value. If set to NO (the default) doxygen will only warn about
646 WARN_NO_PARAMDOC = NO
649 # doxygen can produce. The string should contain the $file, $line, and $text
663 #---------------------------------------------------------------------------
665 #---------------------------------------------------------------------------
672 INPUT = src doc/doxygen/libomp_interface.h
673 # The ittnotify code also has doxygen documentation, but if we include it here
678 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
679 # also the default input encoding. Doxygen uses libiconv (or the iconv built
683 INPUT_ENCODING = UTF-8
687 # and *.h) to filter out the source-files in the directories. If left
695 # doxygen doesn't see the content, just the documentation...
698 # should be searched for input files as well. Possible values are YES and NO.
699 # If left blank NO is used.
702 RECURSIVE = NO
707 # Note that relative paths are relative to the directory from which doxygen is
710 EXCLUDE = src/test-touch.c
716 EXCLUDE_SYMLINKS = NO
742 # and *.h) to filter out the source-files in the directories. If left
750 # Possible values are YES and NO. If left blank NO is used.
752 EXAMPLE_RECURSIVE = NO
760 # The INPUT_FILTER tag can be used to specify a program that doxygen should
761 # invoke to filter for each input file. Doxygen will invoke the filter program
762 # by executing (via popen()) the command <filter> <input-file>, where <filter>
763 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
764 # input file. Doxygen will then use the output that the filter program writes
773 # Doxygen will compare the file name with each pattern and apply the
786 FILTER_SOURCE_FILES = NO
796 #---------------------------------------------------------------------------
798 #---------------------------------------------------------------------------
801 # be generated. Documented entities will be cross-referenced with these sources.
803 # VERBATIM_HEADERS is set to NO.
810 INLINE_SOURCES = NO
813 # doxygen to hide any special comment blocks from generated source code
828 REFERENCES_RELATION = NO
839 # will point to the HTML generated by the htags(1) tool instead of doxygen
840 # built-in source browser. The htags tool is part of GNU's global source
844 USE_HTAGS = NO
846 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
848 # which an include is specified. Set to NO to disable this.
852 #---------------------------------------------------------------------------
854 #---------------------------------------------------------------------------
875 #---------------------------------------------------------------------------
877 #---------------------------------------------------------------------------
879 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
892 # doxygen will generate files with .html extension.
897 # each generated HTML page. If it is left blank doxygen will generate a
899 # for the proper inclusion of any scripts and style sheets that doxygen
901 # It is advised to generate a default header using "doxygen -w html
904 # have to redo this when upgrading to a newer version of doxygen or when
910 # each generated HTML page. If it is left blank doxygen will generate a
915 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
917 # fine-tune the look of the HTML output. If left blank doxygen will
925 # user-defined cascading style sheet that is included after the standard
926 # style sheets created by doxygen. Using this option one can overrule
929 # robust against future updates. Doxygen will copy the style sheet file to
939 # the files will be copied as-is; there are no commands or markers available.
944 # Doxygen will adjust the colors in the style sheet and background images
970 # this to NO can help when comparing the output of multiple runs.
972 HTML_TIMESTAMP = NO
978 HTML_DYNAMIC_SECTIONS = NO
982 # can expand and collapse entries dynamically later on. Doxygen will expand
994 # To create a documentation set, doxygen will generate a Makefile in the
1002 GENERATE_DOCSET = NO
1009 DOCSET_FEEDNAME = "Doxygen generated docs"
1013 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1016 DOCSET_BUNDLE_ID = org.doxygen.Project
1019 # identify the documentation publisher. This should be a reverse domain-name
1022 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1033 GENERATE_HTMLHELP = NO
1044 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1051 # it should be included in the main .chm file (NO).
1053 GENERATE_CHI = NO
1063 # normal table of contents (NO) in the .chm file.
1065 BINARY_TOC = NO
1070 TOC_EXPAND = NO
1077 GENERATE_QHP = NO
1089 QHP_NAMESPACE = org.doxygen.Project
1093 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1099 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1105 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1113 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1120 # If non-empty doxygen will try to run qhelpgenerator on the generated
1134 GENERATE_ECLIPSEHELP = NO
1140 ECLIPSE_DOC_ID = org.doxygen.Project
1143 # at top of each HTML page. The value NO (the default) enables the index and
1145 # navigation tree you can set this option to NO if you already set
1148 DISABLE_INDEX = NO
1150 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1153 # containing a tree-like index structure (just like the one that
1158 # could consider to set DISABLE_INDEX to NO when enabling this option.
1160 GENERATE_TREEVIEW = NO
1163 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1175 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1178 EXT_LINKS_IN_WINDOW = NO
1182 # when you change the font size after a successful doxygen run you need
1203 USE_MATHJAX = NO
1222 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1234 # using Javascript. Doxygen will generate the search PHP script and index
1240 SERVER_BASED_SEARCH = NO
1242 #---------------------------------------------------------------------------
1244 #---------------------------------------------------------------------------
1246 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1271 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1275 COMPACT_LATEX = NO
1290 # the first chapter. If it is left blank doxygen will generate a
1293 LATEX_HEADER = doc/doxygen/header.tex
1297 # the last chapter. If it is left blank doxygen will generate a
1315 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1320 LATEX_BATCHMODE = NO
1322 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1326 LATEX_HIDE_INDICES = NO
1328 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1333 LATEX_SOURCE_CODE = NO
1341 #---------------------------------------------------------------------------
1343 #---------------------------------------------------------------------------
1345 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1349 GENERATE_RTF = NO
1357 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1361 COMPACT_RTF = NO
1370 RTF_HYPERLINKS = NO
1372 # Load style sheet definitions from file. Syntax is similar to doxygen's
1379 # Syntax is similar to doxygen's config file.
1383 #---------------------------------------------------------------------------
1385 #---------------------------------------------------------------------------
1387 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1390 GENERATE_MAN = NO
1403 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1407 # would be unable to find the correct page. The default is NO.
1409 MAN_LINKS = NO
1411 #---------------------------------------------------------------------------
1413 #---------------------------------------------------------------------------
1415 # If the GENERATE_XML tag is set to YES Doxygen will
1419 GENERATE_XML = NO
1439 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1441 # and cross-referencing information) to the XML output. Note that
1446 #---------------------------------------------------------------------------
1448 #---------------------------------------------------------------------------
1450 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1456 GENERATE_AUTOGEN_DEF = NO
1458 #---------------------------------------------------------------------------
1460 #---------------------------------------------------------------------------
1462 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1468 GENERATE_PERLMOD = NO
1470 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1474 PERLMOD_LATEX = NO
1481 # tag is set to NO the size of the Perl module output will be much smaller
1493 #---------------------------------------------------------------------------
1495 #---------------------------------------------------------------------------
1497 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1498 # evaluate all C-preprocessor directives found in the sources and include
1503 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1504 # names in the source code. If set to NO (the default) only conditional
1528 # patterns (like *.h and *.hpp) to filter out the header-files in the
1535 # are defined before the preprocessor is started (similar to the -D option of
1537 # or name=definition (no spaces). If the definition and the = are
1553 # doxygen's preprocessor will remove all references to function-like macros
1559 #---------------------------------------------------------------------------
1561 #---------------------------------------------------------------------------
1574 # doxygen is run, you must also specify the path to the tagfile here.
1578 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1584 # in the class index. If set to NO only the inherited external classes
1587 ALLEXTERNALS = NO
1590 # in the modules index. If set to NO, only the current project's groups will
1600 #---------------------------------------------------------------------------
1602 #---------------------------------------------------------------------------
1604 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1606 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1612 # You can define message sequence charts within doxygen comments using the \msc
1613 # command. Doxygen will then run the mscgen tool (see
1627 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1630 # have no effect if this option is set to NO (the default)
1632 HAVE_DOT = NO
1634 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1635 # allowed to run in parallel. When set to 0 (the default) doxygen will
1642 # By default doxygen will use the Helvetica font for all dot files that
1643 # doxygen generates. When you want a differently looking font you can specify
1656 # By default doxygen will tell dot to use the Helvetica font.
1662 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1665 # CLASS_DIAGRAMS tag to NO.
1669 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1674 COLLABORATION_GRAPH = NO
1676 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1681 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1685 UML_LOOK = NO
1691 # manageable. Set this to 0 for no limit. Note that the threshold may be
1702 # tags are set to YES then doxygen will generate a graph for each documented
1706 INCLUDE_GRAPH = NO
1709 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1713 INCLUDED_BY_GRAPH = NO
1716 # doxygen will generate a call dependency graph for every global function
1721 CALL_GRAPH = NO
1724 # doxygen will generate a caller dependency graph for every global function
1729 CALLER_GRAPH = NO
1731 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1737 # then doxygen will show the dependencies a directory has on other directories
1758 INTERACTIVE_SVG = NO
1779 # becomes larger than this value, doxygen will truncate the graph, which is
1780 # visualized by representing a node as a red box. Note that doxygen if the
1793 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1800 # enabling this option may lead to badly anti-aliased labels on the edges of
1803 DOT_TRANSPARENT = NO
1806 # files in one run (i.e. multiple -o and -T options on the command line). This
1810 DOT_MULTI_TARGETS = NO
1812 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1818 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will