From nobody Sat Nov 30 00:00:01 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=fail(p=none dis=none) header.from=arm.com ARC-Seal: i=1; a=rsa-sha256; t=1620636110; cv=none; d=zohomail.com; s=zohoarc; b=TqL0F1M8vfeFfftOoJ7rU7KzicW85DAkVrn4WnGRa30N/5zwzcD+1eHLGy+kfVq4izD6tFtnmb80ZsMf2suRsQWGgURKgDHu2UETdybs1ARoLDFKpBjBq3bIkK2qwPygb9Z/6eQkNrXW5/KwiCQiBP5NxfwDtqG3DfzsP5AOTOE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1620636110; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=FXa7Rv5Qqesg3LimCSkQjw4lT4Ja1UztTykWUIvganc=; b=Ax9xO7e6h9virbHbWJxVfvrArEeuC/j3P+9dOC+TZLpX7bkLBrbPpNo3thjRpiumYN/S3+5Jo+MHPqmxTaicr1p669mpLIC+KXEp2Ly/NPgG9w8HL9/7EzRDlutR0mirB3llFHucH6pBVBfqx2NYhR6ZjNd8esWJTVLng2HxItk= ARC-Authentication-Results: i=1; mx.zohomail.com; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1620636110516421.4439744400353; Mon, 10 May 2021 01:41:50 -0700 (PDT) Received: from list by lists.xenproject.org with outflank-mailman.124960.235257 (Exim 4.92) (envelope-from ) id 1lg1Ti-0000fN-D2; Mon, 10 May 2021 08:41:26 +0000 Received: by outflank-mailman (output) from mailman id 124960.235257; Mon, 10 May 2021 08:41:26 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lg1Ti-0000fG-9w; Mon, 10 May 2021 08:41:26 +0000 Received: by outflank-mailman (input) for mailman id 124960; Mon, 10 May 2021 08:41:25 +0000 Received: from all-amaz-eas1.inumbo.com ([34.197.232.57] helo=us1-amaz-eas2.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lg1Tg-0000ei-St for xen-devel@lists.xenproject.org; Mon, 10 May 2021 08:41:24 +0000 Received: from foss.arm.com (unknown [217.140.110.172]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTP id 194a8c48-74f5-4635-8726-284aab90a316; Mon, 10 May 2021 08:41:16 +0000 (UTC) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 93B83113E; Mon, 10 May 2021 01:41:16 -0700 (PDT) Received: from e125770.cambridge.arm.com (e125770.cambridge.arm.com [10.1.197.16]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id C6AB93F719; Mon, 10 May 2021 01:41:14 -0700 (PDT) X-Outflank-Mailman: Message body and most headers restored to incoming version X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 194a8c48-74f5-4635-8726-284aab90a316 From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: bertrand.marquis@arm.com, wei.chen@arm.com, Andrew Cooper , George Dunlap , Ian Jackson , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu Subject: [PATCH v6 1/9] docs: add doxygen configuration file Date: Mon, 10 May 2021 09:40:57 +0100 Message-Id: <20210510084105.17108-2-luca.fancellu@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210510084105.17108-1-luca.fancellu@arm.com> References: <20210510084105.17108-1-luca.fancellu@arm.com> Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Add xen.doxyfile.in as template for the doxygen configuration file, it will be used to generate the doxygen documentation. Signed-off-by: Luca Fancellu Acked-by: Stefano Stabellini --- docs/xen.doxyfile.in | 2316 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2316 insertions(+) create mode 100644 docs/xen.doxyfile.in diff --git a/docs/xen.doxyfile.in b/docs/xen.doxyfile.in new file mode 100644 index 0000000000..00969d9b78 --- /dev/null +++ b/docs/xen.doxyfile.in @@ -0,0 +1,2316 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed = in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ign= ored. +# The format is: +# TAG =3D value [value, ...] +# For lists, items can also be appended using: +# TAG +=3D value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# This file is base on doc/zephyr.doxyfile.in zephry 2.3 + +#-------------------------------------------------------------------------= -- +# Project related configuration options +#-------------------------------------------------------------------------= -- + +# This tag specifies the encoding used for all characters in the config fi= le +# that follow. The default is UTF-8 which is also the encoding used for al= l text +# before the first occurrence of this tag. Doxygen uses libiconv (or the i= conv +# built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encoding= s. +# The default value is: UTF-8. + +DOXYFILE_ENCODING =3D UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded= by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in t= he +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME =3D "Xen Project" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number= . This +# could be handy for archiving the generated documentation or if some vers= ion +# control system is used. + +PROJECT_NUMBER =3D + +# Using the PROJECT_BRIEF tag one can provide an optional one line descrip= tion +# for a project that appears at the top of each page and should give viewe= r a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF =3D "An Open Source Type 1 Hypervisor" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is incl= uded +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will = copy +# the logo to the output directory. + +PROJECT_LOGO =3D "xen-doxygen/xen_project_logo_165x67.png" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) p= ath +# into which the generated documentation will be written. If a relative pa= th is +# entered, it will be relative to the location where doxygen was started. = If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY =3D @DOXY_OUT@ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 su= b- +# directories (in 2 levels) under the output directory of each output form= at and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files,= where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS =3D NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Ch= inese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United Sta= tes), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messag= es), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Ru= ssian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE =3D English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief m= ember +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC =3D YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF =3D YES + +# This tag implements a quasi-intelligent brief description abbreviator th= at is +# used to form the text in various listings. Each string in this list, if = found +# as the leading text of the brief description, will be stripped from the = text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name= of +# the entity):The $name class, The $name widget, The $name file, is, provi= des, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF =3D YES + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC =3D YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if th= ose +# members were ordinary class members. Constructors, destructors and assig= nment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB =3D YES + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full = path +# before files name in the file list and in the header files. If set to NO= the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES =3D YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the = path. +# Stripping is only done if one of the specified strings matches the left-= hand +# part of the path. The tag can be used to show relative paths in the file= list. +# If left blank the directory from which doxygen is run is used as the pat= h to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, = which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH =3D @XEN_BASE@ + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of = the +# path mentioned in the documentation of a class, which tells the reader w= hich +# header file to include in order to use a class. If left blank only the n= ame of +# the header file containing the class definition is used. Otherwise one s= hould +# specify the list of include paths that are normally passed to the compil= er +# using the -I flag. + +STRIP_FROM_INC_PATH =3D + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter= (but +# less readable) file names. This can be useful is your file systems doesn= 't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES =3D NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret t= he +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regul= ar Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF =3D NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the fi= rst +# line (until the first dot) of a Qt-style comment as the brief descriptio= n. If +# set to NO, the Qt-style will behave just like regular Qt-style comments = (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF =3D NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comment= s) as +# a brief description. This used to be the default behavior. The new defau= lt is +# to treat a multi-line C++ comment block as a detailed description. Set t= his +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments= are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF =3D NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inheri= ts the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS =3D YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce= a new +# page for each member. If set to NO, the documentation of a member will b= e part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES =3D YES + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxyg= en +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE =3D 8 + +# This tag can be used to specify a number of aliases that act as commands= in +# the documentation. An alias has the form: +# name=3Dvalue +# For example adding +# "sideeffect=3D@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES =3D "rst=3D\verbatim embed:rst:leading-asterisk" \ + "endrst=3D\endverbatim" \ + "keepindent=3D\code" \ + "endkeepindent=3D\endcode" + +ALIASES +=3D req{1}=3D"\ref XEN_\1 \"XEN-\1\" " +ALIASES +=3D satisfy{1}=3D"\xrefitem satisfy \"Satisfies requirement\" \"R= equirement Implementation\" \1" +ALIASES +=3D verify{1}=3D"\xrefitem verify \"Verifies requirement\" \"Requ= irement Verification\" \1" + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C s= ources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of= all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C =3D YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java= or +# Python sources only. Doxygen will then generate output that is more tail= ored +# for that language. For instance, namespaces will be presented as package= s, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA =3D NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fort= ran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN =3D NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL =3D NO + +# Doxygen selects the parser to use depending on the extension of the file= s it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or exten= d it +# using this tag. The format is ext=3Dlanguage, where ext is a file extens= ion, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascri= pt, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted For= tran: +# Fortran. In the later case the parser tries to guess whether the code is= fixed +# or free formatted code, this is the default for Fortran type files), VHD= L. For +# instance to make doxygen treat .inc files as Fortran files (default is P= HP), +# and .f files as C (default is Fortran), use: inc=3DFortran f=3DC. +# +# Note: For files without extension you can use no_extension as a placehol= der. +# +# Note that for custom extensions you also need to set FILE_PATTERNS other= wise +# the files are not read by doxygen. + +EXTENSION_MAPPING =3D + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all co= mments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for deta= ils. +# The output of markdown processing is further processed by doxygen, so yo= u can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable on= ly in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT =3D YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link= can +# be prevented in individual cases by putting a % sign in front of the wor= d or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT =3D YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not = want +# to include (a tag file for) the STL sources as input, then you should se= t this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collabo= ration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT =3D NO + +# If you use Microsoft's C++/CLI language, you should set this option to Y= ES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT =3D YES + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Dox= ygen +# will parse them like normal C++ but will assume all classes use public i= nstead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT =3D NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES wil= l make +# doxygen to replace the get and set methods by a property in the document= ation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, y= ou +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT =3D YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP= _DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By defa= ult +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC =3D NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same = type +# (for instance a group of public functions) to be put as a subgroup of th= at +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING =3D YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and = unions +# are shown inside the group in which they are included (e.g. using \ingro= up) +# instead of on a separate page (for HTML and Man pages) or section (for L= aTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES =3D NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and = unions +# with only public data fields or simple typedef fields will be shown inli= ne in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. I= f set +# to NO, structs, classes, and unions are shown on a separate page (for HT= ML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS =3D YES + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, = or +# enum is documented as struct, union, or enum with the name of the typede= f. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a str= uct +# with name TypeT. When disabled the typedef will appear as a member of a = file, +# namespace, or class. And the struct will be named TypeS. This can typica= lly be +# useful for C code in case the coding convention dictates that all compou= nd +# types are typedef'ed and only the typedef is referenced, never the tag n= ame. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT =3D NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. = This +# cache is used to resolve symbols given their name and scope. Since this = can be +# an expensive process and often the same symbol appears multiple times in= the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too= small +# doxygen will become slower. If the cache is too large, memory is wasted.= The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid= range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=3D65536 +# symbols. At the end of a run doxygen will report the cache usage and sug= gest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE =3D 9 + +#-------------------------------------------------------------------------= -- +# Build related configuration options +#-------------------------------------------------------------------------= -- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Pr= ivate +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members tha= t are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL =3D YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class= will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE =3D NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or in= ternal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE =3D YES + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file wi= ll be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC =3D YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) de= fined +# locally in source files will be included in the documentation. If set to= NO, +# only classes defined in header files are included. Does not have any eff= ect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES =3D YES + +# This flag is only useful for Objective-C code. If set to YES, local meth= ods, +# which are defined in the implementation section but not in the interface= are +# included in the documentation. If set to NO, only methods in the interfa= ce are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS =3D YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base n= ame of +# the file that contains the anonymous namespace. By default anonymous nam= espace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES =3D NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO th= ese +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enable= d. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS =3D NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. I= f set +# to NO, these classes will be included in the various overviews. This opt= ion +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES =3D NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all fr= iend +# (class|struct|union) declarations. If set to NO, these declarations will= be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS =3D NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, = these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS =3D NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the document= ation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS =3D NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate= file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only di= ffer +# in case and if your file system supports case sensitive file names. Wind= ows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES =3D YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members = with +# their full class and namespace scopes in the documentation. If set to YE= S, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES =3D NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list= of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES =3D YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for= each +# grouped member an include statement to the documentation, telling the re= ader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC =3D YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list inc= lude +# files with double quotes in the documentation rather than with sharp bra= ckets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES =3D NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in = the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO =3D YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by mem= ber +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS =3D YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by memb= er +# name. If set to NO, the members will appear in declaration order. Note t= hat +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS =3D NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort t= he +# (brief and detailed) documentation of class members so that constructors= and +# destructors are listed first. If set to NO the constructors will appear = in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting= brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST =3D NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hie= rarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES =3D YES + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sort= ed by +# fully-qualified names, including namespaces. If set to NO, the class lis= t will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME =3D YES + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do p= roper +# type resolution of all parameters of a function it will reject a match b= etween +# the prototype and the implementation of a member function even if there = is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will sti= ll +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING =3D YES + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) th= e todo +# list. This list is created by putting \todo commands in the documentatio= n. +# The default value is: YES. + +GENERATE_TODOLIST =3D NO + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) th= e test +# list. This list is created by putting \test commands in the documentatio= n. +# The default value is: YES. + +GENERATE_TESTLIST =3D NO + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the= bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST =3D NO + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (= NO) +# the deprecated list. This list is created by putting \deprecated command= s in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST=3D YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS =3D YES + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines tha= t the +# initial value of a variable or macro / define can have for it to appear = in the +# documentation. If the initializer consists of more lines than specified = here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can= be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES =3D 300 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated= at +# the bottom of the documentation of classes and structs. If set to YES, t= he +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES =3D YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page= . This +# will remove the Files entry from the Quick Index and from the Folder Tre= e View +# (if specified). +# The default value is: YES. + +SHOW_FILES =3D YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Names= paces +# page. This will remove the Namespaces entry from the Quick Index and fro= m the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES =3D YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script t= hat +# doxygen should invoke to get the current version for each file (typicall= y from +# the version control system). Doxygen will invoke the program by executin= g (via +# popen()) the command command input-file, where command is the value of t= he +# FILE_VERSION_FILTER tag, and input-file is the name of an input file pro= vided +# by doxygen. Whatever the program writes to standard output is used as th= e file +# version. For an example see the documentation. + +FILE_VERSION_FILTER =3D + +# The LAYOUT_FILE tag can be used to specify a layout file which will be p= arsed +# by doxygen. The layout file controls the global structure of the generat= ed +# output files in an output format independent way. To create the layout f= ile +# that represents doxygen's defaults, run doxygen with the -l option. You = can +# optionally specify a file name after the option, if omitted DoxygenLayou= t.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOU= T_FILE +# tag is left empty. + +LAYOUT_FILE =3D + +# The CITE_BIB_FILES tag can be used to specify one or more bib files cont= aining +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex= tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more = info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available = in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES =3D + +#-------------------------------------------------------------------------= -- +# Configuration options related to warning and progress messages +#-------------------------------------------------------------------------= -- + +# The QUIET tag can be used to turn on/off the messages that are generated= to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET =3D YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to Y= ES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS =3D YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then thi= s flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED =3D YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnin= gs for +# potential errors in the documentation, such as not documenting some para= meters +# in a documented function, or documenting parameters that don't exist or = using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR =3D YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for function= s that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC =3D NO + +# The WARN_FORMAT tag determines the format of the warning messages that d= oxygen +# can produce. The string should contain the $file, $line, and $text tags,= which +# will be replaced by the file and line number from which the warning orig= inated +# and the warning text. Optionally the format may contain $version, which = will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT =3D "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and = error +# messages should be written. If left blank the output is written to stand= ard +# error (stderr). + +WARN_LOGFILE =3D + +#-------------------------------------------------------------------------= -- +# Configuration options related to the input files +#-------------------------------------------------------------------------= -- + +# The INPUT tag is used to specify the files and/or directories that conta= in +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories w= ith +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT =3D "@XEN_BASE@/docs/xen-doxygen/mainpage.md" + +# This tag can be used to specify the character encoding of the source fil= es +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen= uses +# libiconv (or the iconv built into libc) for the transcoding. See the lib= iconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list= of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING =3D UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp a= nd +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you= also +# need to set EXTENSION_MAPPING for the extension otherwise the files are = not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.= h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.= inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.= f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +# This MUST be kept in sync with DOXY_SOURCES in doc/CMakeLists.txt +# for incremental (and faster) builds to work correctly. +FILE_PATTERNS =3D "*.c" \ + "*.h" \ + "*.S" \ + "*.md" + +# The RECURSIVE tag can be used to specify whether or not subdirectories s= hould +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE =3D YES + +# The EXCLUDE tag can be used to specify files and/or directories that sho= uld be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPU= T tag. +# +# Note that relative paths are relative to the directory from which doxyge= n is +# run. + +EXCLUDE =3D @XEN_BASE@/include/nothing.h + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are exc= luded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS =3D NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path,= so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS =3D + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path,= so to +# exclude all test directories use the pattern */test/* + +# Hide internal names (starting with an underscore, and doxygen-generated = names +# for nested unnamed unions that don't generate meaningful sphinx output a= nyway. +EXCLUDE_SYMBOLS =3D +# _* *.__unnamed__ z_* Z_* + +# The EXAMPLE_PATH tag can be used to specify one or more files or directo= ries +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH =3D + +# If the value of the EXAMPLE_PATH tag contains directories, you can use t= he +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp= and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS =3D + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude co= mmands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE =3D YES + +# The IMAGE_PATH tag can be used to specify one or more files or directori= es +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH =3D + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter pro= gram +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is= the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this= tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before = the +# code is scanned, but not when the output code is generated. If lines are= added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you= also +# need to set EXTENSION_MAPPING for the extension otherwise the files are = not +# properly processed by doxygen. + +INPUT_FILTER =3D + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pat= tern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern= =3Dfilter +# (like *.cpp=3Dmy_cpp_filter). See INPUT_FILTER for further information o= n how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you= also +# need to set EXTENSION_MAPPING for the extension otherwise the files are = not +# properly processed by doxygen. + +FILTER_PATTERNS =3D *.h=3D"\"@XEN_BASE@/docs/xen-doxygen/doxy-preproce= ssor.py\"" + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set u= sing +# INPUT_FILTER) will also be used to filter the input files that are used = for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to= YES). +# The default value is: NO. + +FILTER_SOURCE_FILES =3D NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per= file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any)= and +# it is also possible to disable source filtering for a specific pattern u= sing +# *.ext=3D (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS =3D + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file = that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance G= itHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE =3D "mainpage.md" + +#-------------------------------------------------------------------------= -- +# Configuration options related to source browsing +#-------------------------------------------------------------------------= -- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will= be +# generated. Documented entities will be cross-referenced with these sourc= es. +# +# Note: To get rid of all source code in the generated output, make sure t= hat +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER =3D NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES =3D NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide= any +# special comment blocks from generated source code fragments. Normal C, C= ++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS =3D YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION =3D NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented fu= nction +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION =3D NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag i= s set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise the= y will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE =3D YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in= the +# source code will show a tooltip with additional information such as prot= otype, +# brief description and links to the definition and documentation. Since t= his +# will make the HTML file larger and loading of large files a bit slower, = you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS =3D YES + +# If the USE_HTAGS tag is set to YES then the references to source code wi= ll +# point to the HTML generated by the htags(1) tool instead of doxygen buil= t-in +# source browser. The htags tool is part of GNU's global source tagging sy= stem +# (see https://www.gnu.org/software/global/global.html). You will need ver= sion +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the link= s to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS =3D NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS =3D YES + +#-------------------------------------------------------------------------= -- +# Configuration options related to the alphabetical class index +#-------------------------------------------------------------------------= -- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX =3D YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns= in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX =3D 2 + +# In case all classes in a project start with a common prefix, all classes= will +# be put under the same header in the alphabetical index. The IGNORE_PREFI= X tag +# can be used to specify a prefix (or a list of prefixes) that should be i= gnored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX =3D + +#-------------------------------------------------------------------------= -- +# Configuration options related to the HTML output +#-------------------------------------------------------------------------= -- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML =3D YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. = If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in fr= ont of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT =3D html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension fo= r each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION =3D .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header fi= le for +# each generated HTML page. If the tag is left blank doxygen will generate= a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sh= eets +# that doxygen needs, which is dependent on the configuration options used= (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usag= e" +# for information on how to generate the default header that doxygen norma= lly +# uses. +# Note: The header is subject to change so you typically have to regenerat= e the +# default header when upgrading to a newer version of doxygen. For a descr= iption +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER =3D xen-doxygen/header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer fo= r each +# generated HTML page. If the tag is left blank doxygen will generate a st= andard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default f= ooter +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER =3D + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading = style +# sheet that is used by each HTML page. It can be used to fine-tune the lo= ok of +# the HTML output. If left blank doxygen will generate a default style she= et. +# See also section "Doxygen usage" for information on how to generate the = style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag= , as +# it is more robust and this tag (HTML_STYLESHEET) will in the future beco= me +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET =3D + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-def= ined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style asp= ects. +# This is preferred over using HTML_STYLESHEET since it does not replace t= he +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. th= e last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET =3D xen-doxygen/customdoxygen.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images= or +# other source files which should be copied to the HTML output directory. = Note +# that these files will be copied to the base HTML output directory. Use t= he +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load the= se +# files. In the HTML_STYLESHEET file, use the file name only. Also note th= at the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES =3D + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxyg= en +# will adjust the colors in the style sheet and background images accordin= g to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the= value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, = 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE =3D + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the c= olors +# in the HTML output. For a value of 0 the output will use grayscales only= . A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT =3D + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to t= he +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the out= put +# darker. The value divided by 100 is the actual gamma applied, so 80 repr= esents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA =3D + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generate= d HTML +# page will contain the date and time when the page was generated. Setting= this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP =3D YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after t= he +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS =3D YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entr= ies +# shown in the various tree structured indices initially; the user can exp= and +# and collapse entries dynamically later on. Doxygen will expand the tree = to +# such a level that at most the specified number of entries are visible (u= nless +# a fully collapsed tree already exceeds this amount). So setting the numb= er of +# entries 1 will produce a full collapsed tree by default. 0 is a special = value +# representing an infinite number of entries and will result in a full exp= anded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES =3D 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated devel= opment +# environment (see: https://developer.apple.com/tools/xcode/), introduced = with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate= a +# Makefile in the HTML output directory. Running make will produce the doc= set in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find= it at +# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxyge= n.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET =3D YES + +# This tag determines the name of the docset feed. A documentation feed pr= ovides +# an umbrella under which multiple documentation sets from a single provid= er +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME =3D "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentat= ion +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID =3D org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely iden= tify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID =3D org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME =3D Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Wo= rkshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=3D21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML out= put +# generated by doxygen into a single compiled HTML file (.chm). Compiled H= TML +# files are now used as the Windows 98 help format, and will replace the o= ld +# Windows help format (.hlp) on all Windows platforms in the future. Compr= essed +# HTML files also contain an index, a table of contents, and you can searc= h for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP =3D NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .= chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE =3D NO + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hh= p. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION =3D + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI =3D NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (= hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING =3D + +# The BINARY_TOC flag controls whether a binary table of contents is gener= ated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC =3D YES + +# The TOC_EXPAND flag can be set to YES to add extra items for group membe= rs to +# the table of contents of the HTML help documentation and to the tree vie= w. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND =3D NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated t= hat +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed= Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP =3D NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to sp= ecify +# the file name of the resulting .qch file. The path specified is relative= to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE =3D + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt = Help +# Project output. For more information please see Qt Help Project / Namesp= ace +# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE =3D org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generatin= g Qt +# Help Project output. For more information please see Qt Help Project / V= irtual +# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders= ). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER =3D doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME =3D + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / = Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS =3D + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (s= ee: +# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS =3D + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on t= he +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION =3D + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files wi= ll be +# generated, together with the HTML files, they form an Eclipse help plugi= n. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files= needs +# to be copied into the plugins directory of eclipse. The name of the dire= ctory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID va= lue. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP =3D NO + +# A unique identifier for the Eclipse help plugin. When installing the plu= gin +# the directory name containing the HTML and XML files should also have th= is +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID =3D org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it = might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) = at top +# of each HTML page. A value of NO enables the index and the value YES dis= ables +# it. Since the tabs in the index contain the same information as the navi= gation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW t= o YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX =3D NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If th= e tag +# value is set to YES, a side panel will be generated containing a tree-li= ke +# index structure (just like the one that is generated for HTML Help). For= this +# to work a browser that supports JavaScript, DHTML, CSS and frames is req= uired +# (i.e. any modern browser). Windows users are probably better off using t= he +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) o= ne can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image= at +# the root of the tree instead of the PROJECT_NAME. Since the tree basical= ly has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW =3D YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum value= s that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from app= earing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE =3D 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be = used +# to set the initial width (in pixels) of the frame in which the tree is s= hown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH =3D 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links= to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW =3D NO + +# Use this tag to change the font size of LaTeX formulas included as image= s in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the H= TML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE =3D 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png fi= les in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT =3D YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rende= ring +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. W= hen +# enabled you may also need to install MathJax separately and configure th= e path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX =3D NO + +# When MathJax is enabled you can set the default output format to be used= for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT =3D HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the= HTML +# output directory using the MATHJAX_RELPATH option. The destination direc= tory +# should contain the MathJax.js script. For instance, if the mathjax direc= tory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the Ma= thJax +# Content Delivery Network so you can quickly see the result without insta= lling +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH =3D http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For exa= mple +# MATHJAX_EXTENSIONS =3D TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS =3D + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript p= ieces +# of code that will be used on startup of the MathJax code. See the MathJa= x site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. F= or an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE =3D + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box = for +# the HTML output. The underlying search engine uses javascript and DHTML = and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disab= led. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possib= le to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typic= ally +# , /