Doxyfile - OpenGrok cross reference for /openbmc/entity-manager/Doxyfile

9 # All text after a single hash (#) is considered a comment and will be ignored.
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
65 # will distribute the generated files over these directories. Enabling this
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
82 # documentation generated by doxygen is written. Doxygen will use this
97 # documentation generated by doxygen is written. Doxygen will use this
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
115 # brief descriptions will be completely suppressed.
122 # as the leading text of the brief description, will be stripped from the text
142 # doxygen will generate a detailed section even if there is only a brief
148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
151 # operators of the base classes will not be shown.
156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
158 # shortest path that makes the file name unique will be used
170 # will be relative from the directory where doxygen is started.
184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
193 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
200 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
204 # Javadoc-style will behave just like regular comments and it will not be
210 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
212 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
236 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237 # page for each member. If set to NO, the documentation of a member will be part
254 # will allow you to put the command \sideeffect (or @sideeffect) in the
255 # documentation, which will result in a user-defined paragraph with heading
267 # only. Doxygen will then generate output that is more tailored for C. For
268 # instance, some of the names that are used will be different. The list of all
269 # members will be omitted, etc.
275 # Python sources only. Doxygen will then generate output that is more tailored
276 # for that language. For instance, namespaces will be presented as packages,
277 # qualified scopes will look different, etc.
283 # sources. Doxygen will then generate output that is tailored for Fortran.
289 # sources. Doxygen will then generate output that is tailored for VHDL.
295 # sources only. Doxygen will then generate output that is more tailored for that
296 # language. For instance, namespaces will be presented as modules, types will be
367 # will parse them like normal C++ but will assume all classes use public instead
374 # getter and setter methods for a property. Setting this option to YES will make
376 # This will only work if the methods are indeed getting or setting a simple
384 # tag is set to YES then doxygen will reuse the documentation of the first
419 # with only public data fields or simple typedef fields will be shown inline in
430 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
431 # with name TypeT. When disabled the typedef will appear as a member of a file,
432 # namespace, or class. And the struct will be named TypeS. This can typically be
443 # doxygen will become slower. If the cache is too large, memory is wasted. The
446 # symbols. At the end of a run doxygen will report the cache usage and suggest
456 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
458 # class members and static file members will be hidden unless the
460 # Note: This will also disable the warnings about undocumented members that are
466 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
473 # methods of a class will be included in the documentation.
479 # scope will be included in the documentation.
484 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
491 # locally in source files will be included in the documentation. If set to NO,
506 # If this flag is set to YES, the members of anonymous namespaces will be
508 # 'anonymous_namespace{file}', where file will be replaced with the base name of
515 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
517 # members will be included in the various overviews, but no documentation
523 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
525 # to NO, these classes will be included in the various overviews. This option
531 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
532 # declarations. If set to NO, these declarations will be included in the
538 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
540 # blocks will be appended to the function's detailed documentation block.
547 # will be excluded. Set it to YES to include the internal documentation.
552 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
561 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
563 # scope will be hidden.
568 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
570 # YES the compound reference will be hidden.
575 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
581 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
588 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
600 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
602 # name. If set to NO, the members will appear in declaration order.
607 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
609 # name. If set to NO, the members will appear in declaration order. Note that
610 # this will also influence the order of the classes in the class list.
615 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
617 # destructors are listed first. If set to NO the constructors will appear in the
627 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
628 # of group names into alphabetical order. If set to NO the group names will
634 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
635 # fully-qualified names, including namespaces. If set to NO, the class list will
645 # type resolution of all parameters of a function it will reject a match between
648 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
688 # it will be hidden. Use a value of 0 to hide initializers completely. The
698 # list will mention the files that were used to generate the documentation.
704 # will remove the Files entry from the Quick Index and from the Folder Tree View
711 # page. This will remove the Namespaces entry from the Quick Index and from the
719 # the version control system). Doxygen will invoke the program by executing (via
727 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
732 # will be used as the name of the layout file.
735 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
770 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
772 # will automatically be disabled.
777 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
787 # value. If set to NO, doxygen will only warn about wrong or incomplete
789 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
794 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
802 # will be replaced by the file and line number from which the warning originated
803 # and the warning text. Optionally the format may contain $version, which will
956 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
970 # invoke to filter for each input file. Doxygen will invoke the filter program
976 # name of an input file. Doxygen will then use the output that the filter
978 # will be ignored.
982 # or removed, the anchors will not be placed correctly.
991 # basis. Doxygen will compare the file name with each pattern and apply the
1004 # INPUT_FILTER) will also be used to filter the input files that are used for
1011 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1019 # is part of the input, its contents will be placed on the main page
1029 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1030 # generated. Documented entities will be cross-referenced with these sources.
1038 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1044 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1046 # Fortran comments will always remain visible.
1052 # entity all documented functions referencing it will be listed.
1058 # all documented entities called/used by that function will be listed.
1065 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1072 # source code will show a tooltip with additional information such as prototype,
1074 # will make the HTML file larger and loading of large files a bit slower, you
1081 # If the USE_HTAGS tag is set to YES then the references to source code will
1084 # (see https://www.gnu.org/software/global/global.html). You will need version
1093 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1097 # source code will now point to the output of htags.
1103 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1111 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1124 # the include paths will already be set by doxygen for the files and directories
1134 # such as clang-check. These options will then be passed to the parser.
1145 # compounds will be generated. Enable this if the project contains a lot of
1152 # which the alphabetical index list will be split.
1158 # In case all classes in a project start with a common prefix, all classes will
1170 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1175 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1176 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1191 # each generated HTML page. If the tag is left blank doxygen will generate a
1211 # generated HTML page. If the tag is left blank doxygen will generate a standard
1222 # the HTML output. If left blank doxygen will generate a default style sheet.
1226 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1237 # Doxygen will copy the style sheet files to the output directory.
1247 # that these files will be copied to the base HTML output directory. Use the
1250 # files will be copied as-is; there are no commands or markers available.
1256 # will adjust the colors in the style sheet and background images according to
1267 # in the HTML output. For a value of 0 the output will use grayscales only. A
1268 # value of 255 will produce the most vivid colors.
1286 # page will contain the date and time when the page was generated. Setting this
1295 # documentation will contain a main index with vertical navigation menus that
1296 # are dynamically created via JavaScript. If disabled, the navigation index will
1306 # documentation will contain sections that can be hidden and shown after the
1315 # and collapse entries dynamically later on. Doxygen will expand the tree to
1318 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1319 # representing an infinite number of entries and will result in a full expanded
1326 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1329 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1330 # Makefile in the HTML output directory. Running make will produce the docset in
1331 # that directory and running make install will install the docset in
1332 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1350 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1378 # files are now used as the Windows 98 help format, and will replace the old
1397 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1432 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1488 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1494 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1527 # value is set to YES, a side panel will be generated containing a tree-like
1543 # doxygen will group on one line in the generated HTML documentation.
1545 # Note that a value of 0 will completely suppress the enum values from appearing
1559 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1566 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1569 # the HTML output. These images will generally look nicer at scaled resolutions.
1645 # of code that will be used on startup of the MathJax code. See the MathJax site
1652 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1673 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1676 # setting. When disabled, doxygen will generate a PHP script for searching and
1685 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1687 # which needs to be processed by an external indexer. Doxygen will invoke an
1702 # which will return the search results when EXTERNAL_SEARCH is enabled.
1742 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1747 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1748 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1779 # it will be automatically added in the LaTeX code.
1811 # If left blank no extra packages will be included.
1818 # chapter. If it is left blank doxygen will generate a standard header. See
1825 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1834 # chapter. If it is left blank doxygen will generate a standard footer. See
1846 # will copy the style sheet files to the output directory.
1856 # directory. Note that the files will be copied as-is; there are no commands or
1863 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1871 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1879 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1880 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1888 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1895 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1914 # page will contain the date and time when the page was generated. Setting this
1922 # path from which the emoji images will be read. If a relative path is entered,
1923 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1924 # LATEX_OUTPUT directory will be used.
1933 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1940 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1941 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1956 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1957 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1985 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1999 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2005 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2006 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2007 # it. A directory man3 will be created inside the directory specified by
2031 # will generate one additional man file for each entity documented in the real
2043 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2049 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2050 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2057 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2059 # the XML output. Note that enabling this will significantly increase the size
2066 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2077 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2083 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2084 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2091 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2093 # information) to the DOCBOOK output. Note that enabling this will significantly
2104 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2116 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2124 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2132 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2135 # size of the Perl module output will be much smaller and Perl will parse it
2154 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2160 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2161 # in the source code. If set to NO, only conditional compilation will be
2178 # INCLUDE_PATH will be searched if a #include is found.
2193 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2211 # macro definition that is found in the sources will be used. Use the PREDEFINED
2218 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2221 # are typically used for boiler-plate code, and will confuse the parser if not
2247 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2253 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2254 # the class index. If set to NO, only the inherited external classes will be
2260 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2261 # in the modules index. If set to NO, only the current project's groups will be
2267 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2268 # the related pages index. If set to NO, only the current project's pages will
2278 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2287 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2294 # If set to YES the inheritance and collaboration graphs will hide inheritance
2300 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2310 # to run in parallel. When set to 0 doxygen will base this on the number of
2336 # By default doxygen will tell dot to use the default font as specified with
2343 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2345 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2351 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2360 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2367 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2389 # collaboration graphs will show the relations between templates and their
2397 # YES then doxygen will generate a graph for each documented file showing the
2406 # set to YES then doxygen will generate a graph for each documented file showing
2414 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2417 # Note that enabling this option will significantly increase the time of a run.
2418 # So in most cases it will be better to enable call graphs for selected
2426 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2429 # Note that enabling this option will significantly increase the time of a run.
2430 # So in most cases it will be better to enable caller graphs for selected
2438 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2445 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2508 # PlantUML is not used or called during a preprocessing step. Doxygen will
2510 # will not generate output for the diagram.
2525 # that will be shown in the graph. If the number of nodes in a graph becomes
2526 # larger than this value, doxygen will truncate the graph, which is visualized
2529 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2538 # root by following a path via at most 3 edges will be shown. Nodes that lay
2539 # further from the root node will be omitted. Note that setting this option to 1
2569 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2577 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot