Documentation/Doxyfile

   1 # Doxygen 1.8 or newer
   2
   3 DOXYFILE_ENCODING      = UTF-8
   4 PROJECT_NAME           = Jailhouse
   5 PROJECT_NUMBER         =
   6 PROJECT_BRIEF          = "Linux-based partitioning hypervisor"
   7 PROJECT_LOGO           =
   8 OUTPUT_DIRECTORY       = Documentation/generated
   9 CREATE_SUBDIRS         = NO
  10 OUTPUT_LANGUAGE        = English
  11 BRIEF_MEMBER_DESC      = YES
  12 REPEAT_BRIEF           = YES
  13 ABBREVIATE_BRIEF       = "The $name class" \
  14                          "The $name widget" \
  15                          "The $name file" \
  16                          is \
  17                          provides \
  18                          specifies \
  19                          contains \
  20                          represents \
  21                          a \
  22                          an \
  23                          the
  24 ALWAYS_DETAILED_SEC    = NO
  25 INLINE_INHERITED_MEMB  = NO
  26 FULL_PATH_NAMES        = YES
  27 STRIP_FROM_PATH        =
  28 STRIP_FROM_INC_PATH    =
  29 SHORT_NAMES            = NO
  30 JAVADOC_AUTOBRIEF      = NO
  31 QT_AUTOBRIEF           = NO
  32 MULTILINE_CPP_IS_BRIEF = NO
  33 INHERIT_DOCS           = YES
  34 SEPARATE_MEMBER_PAGES  = NO
  35 TAB_SIZE               = 8
  36 ALIASES                =
  37 TCL_SUBST              =
  38 OPTIMIZE_OUTPUT_FOR_C  = YES
  39 OPTIMIZE_OUTPUT_JAVA   = NO
  40 OPTIMIZE_FOR_FORTRAN   = NO
  41 OPTIMIZE_OUTPUT_VHDL   = NO
  42 EXTENSION_MAPPING      =
  43 MARKDOWN_SUPPORT       = YES
  44 AUTOLINK_SUPPORT       = YES
  45 BUILTIN_STL_SUPPORT    = NO
  46 CPP_CLI_SUPPORT        = NO
  47 SIP_SUPPORT            = NO
  48 IDL_PROPERTY_SUPPORT   = YES
  49 DISTRIBUTE_GROUP_DOC   = YES
  50 SUBGROUPING            = YES
  51 INLINE_GROUPED_CLASSES = NO
  52 INLINE_SIMPLE_STRUCTS  = NO
  53 TYPEDEF_HIDES_STRUCT   = NO
  54 LOOKUP_CACHE_SIZE      = 0
  55 EXTRACT_ALL            = NO
  56 EXTRACT_PRIVATE        = NO
  57 EXTRACT_PACKAGE        = NO
  58 EXTRACT_STATIC         = YES
  59 EXTRACT_LOCAL_CLASSES  = YES
  60 EXTRACT_LOCAL_METHODS  = NO
  61 EXTRACT_ANON_NSPACES   = NO
  62 HIDE_UNDOC_MEMBERS     = NO
  63 HIDE_UNDOC_CLASSES     = YES
  64 HIDE_FRIEND_COMPOUNDS  = NO
  65 HIDE_IN_BODY_DOCS      = NO
  66 INTERNAL_DOCS          = NO
  67 CASE_SENSE_NAMES       = NO
  68 HIDE_SCOPE_NAMES       = YES
  69 SHOW_INCLUDE_FILES     = YES
  70 FORCE_LOCAL_INCLUDES   = NO
  71 INLINE_INFO            = YES
  72 SORT_MEMBER_DOCS       = YES
  73 SORT_BRIEF_DOCS        = NO
  74 SORT_MEMBERS_CTORS_1ST = NO
  75 SORT_GROUP_NAMES       = NO
  76 SORT_BY_SCOPE_NAME     = NO
  77 STRICT_PROTO_MATCHING  = NO
  78 GENERATE_TODOLIST      = YES
  79 GENERATE_TESTLIST      = YES
  80 GENERATE_BUGLIST       = YES
  81 GENERATE_DEPRECATEDLIST= YES
  82 ENABLED_SECTIONS       =
  83 MAX_INITIALIZER_LINES  = 30
  84 SHOW_USED_FILES        = YES
  85 SHOW_FILES             = YES
  86 SHOW_NAMESPACES        = YES
  87 FILE_VERSION_FILTER    =
  88 LAYOUT_FILE            =
  89 CITE_BIB_FILES         =
  90 QUIET                  = YES
  91 WARNINGS               = YES
  92 WARN_IF_UNDOCUMENTED   = YES
  93 WARN_IF_DOC_ERROR      = YES
  94 WARN_NO_PARAMDOC       = YES
  95 WARN_FORMAT            = "$file:$line: $text"
  96 WARN_LOGFILE           =
  97 INPUT                  = hypervisor
  98 INPUT_ENCODING         = UTF-8
  99 FILE_PATTERNS          = *.c \
 100                          *.cc \
 101                          *.cxx \
 102                          *.cpp \
 103                          *.c++ \
 104                          *.java \
 105                          *.ii \
 106                          *.ixx \
 107                          *.ipp \
 108                          *.i++ \
 109                          *.inl \
 110                          *.idl \
 111                          *.ddl \
 112                          *.odl \
 113                          *.h \
 114                          *.hh \
 115                          *.hxx \
 116                          *.hpp \
 117                          *.h++ \
 118                          *.cs \
 119                          *.d \
 120                          *.php \
 121                          *.php4 \
 122                          *.php5 \
 123                          *.phtml \
 124                          *.inc \
 125                          *.m \
 126                          *.markdown \
 127                          *.md \
 128                          *.mm \
 129                          *.dox \
 130                          *.py \
 131                          *.f90 \
 132                          *.f \
 133                          *.for \
 134                          *.tcl \
 135                          *.vhd \
 136                          *.vhdl \
 137                          *.ucf \
 138                          *.qsf \
 139                          *.as \
 140                          *.js
 141 RECURSIVE              = YES
 142 EXCLUDE                = hypervisor/arch/arm
 143 EXCLUDE_SYMLINKS       = NO
 144 EXCLUDE_PATTERNS       =
 145 EXCLUDE_SYMBOLS        =
 146 EXAMPLE_PATH           =
 147 EXAMPLE_PATTERNS       = *
 148 EXAMPLE_RECURSIVE      = NO
 149 IMAGE_PATH             =
 150 INPUT_FILTER           =
 151 FILTER_PATTERNS        =
 152 FILTER_SOURCE_FILES    = NO
 153 FILTER_SOURCE_PATTERNS =
 154 USE_MDFILE_AS_MAINPAGE =
 155 SOURCE_BROWSER         = YES
 156 INLINE_SOURCES         = NO
 157 STRIP_CODE_COMMENTS    = YES
 158 REFERENCED_BY_RELATION = NO
 159 REFERENCES_RELATION    = NO
 160 REFERENCES_LINK_SOURCE = YES
 161 SOURCE_TOOLTIPS        = YES
 162 USE_HTAGS              = NO
 163 VERBATIM_HEADERS       = YES
 164 ALPHABETICAL_INDEX     = YES
 165 COLS_IN_ALPHA_INDEX    = 5
 166 IGNORE_PREFIX          =
 167 GENERATE_HTML          = YES
 168 HTML_OUTPUT            = html
 169 HTML_FILE_EXTENSION    = .html
 170 HTML_HEADER            =
 171 HTML_FOOTER            =
 172 HTML_STYLESHEET        =
 173 HTML_EXTRA_STYLESHEET  =
 174 HTML_EXTRA_FILES       =
 175 HTML_COLORSTYLE_HUE    = 220
 176 HTML_COLORSTYLE_SAT    = 100
 177 HTML_COLORSTYLE_GAMMA  = 80
 178 HTML_TIMESTAMP         = YES
 179 HTML_DYNAMIC_SECTIONS  = NO
 180 HTML_INDEX_NUM_ENTRIES = 100
 181 GENERATE_DOCSET        = NO
 182 DOCSET_FEEDNAME        = "Doxygen generated docs"
 183 DOCSET_BUNDLE_ID       = org.doxygen.Project
 184 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 185 DOCSET_PUBLISHER_NAME  = Publisher
 186 GENERATE_HTMLHELP      = NO
 187 CHM_FILE               =
 188 HHC_LOCATION           =
 189 GENERATE_CHI           = NO
 190 CHM_INDEX_ENCODING     =
 191 BINARY_TOC             = NO
 192 TOC_EXPAND             = NO
 193 GENERATE_QHP           = NO
 194 QCH_FILE               =
 195 QHP_NAMESPACE          = org.doxygen.Project
 196 QHP_VIRTUAL_FOLDER     = doc
 197 QHP_CUST_FILTER_NAME   =
 198 QHP_CUST_FILTER_ATTRS  =
 199 QHP_SECT_FILTER_ATTRS  =
 200 QHG_LOCATION           =
 201 GENERATE_ECLIPSEHELP   = NO
 202 ECLIPSE_DOC_ID         = org.doxygen.Project
 203 DISABLE_INDEX          = NO
 204 GENERATE_TREEVIEW      = YES
 205 ENUM_VALUES_PER_LINE   = 4
 206 TREEVIEW_WIDTH         = 250
 207 EXT_LINKS_IN_WINDOW    = NO
 208 FORMULA_FONTSIZE       = 10
 209 FORMULA_TRANSPARENT    = YES
 210 USE_MATHJAX            = NO
 211 MATHJAX_FORMAT         = HTML-CSS
 212 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 213 MATHJAX_EXTENSIONS     =
 214 MATHJAX_CODEFILE       =
 215 SEARCHENGINE           = YES
 216 SERVER_BASED_SEARCH    = NO
 217 EXTERNAL_SEARCH        = NO
 218 SEARCHENGINE_URL       =
 219 SEARCHDATA_FILE        = searchdata.xml
 220 EXTERNAL_SEARCH_ID     =
 221 EXTRA_SEARCH_MAPPINGS  =
 222 GENERATE_LATEX         = YES
 223 LATEX_OUTPUT           = latex
 224 LATEX_CMD_NAME         = latex
 225 MAKEINDEX_CMD_NAME     = makeindex
 226 COMPACT_LATEX          = NO
 227 PAPER_TYPE             = a4
 228 EXTRA_PACKAGES         =
 229 LATEX_HEADER           =
 230 LATEX_FOOTER           =
 231 LATEX_EXTRA_FILES      =
 232 PDF_HYPERLINKS         = YES
 233 USE_PDFLATEX           = YES
 234 LATEX_BATCHMODE        = NO
 235 LATEX_HIDE_INDICES     = NO
 236 LATEX_SOURCE_CODE      = NO
 237 LATEX_BIB_STYLE        = plain
 238 GENERATE_RTF           = NO
 239 RTF_OUTPUT             = rtf
 240 COMPACT_RTF            = NO
 241 RTF_HYPERLINKS         = NO
 242 RTF_STYLESHEET_FILE    =
 243 RTF_EXTENSIONS_FILE    =
 244 GENERATE_MAN           = NO
 245 MAN_OUTPUT             = man
 246 MAN_EXTENSION          = .3
 247 MAN_LINKS              = NO
 248 GENERATE_XML           = NO
 249 XML_OUTPUT             = xml
 250 XML_PROGRAMLISTING     = YES
 251 GENERATE_DOCBOOK       = NO
 252 DOCBOOK_OUTPUT         = docbook
 253 GENERATE_AUTOGEN_DEF   = NO
 254 GENERATE_PERLMOD       = NO
 255 PERLMOD_LATEX          = NO
 256 PERLMOD_PRETTY         = YES
 257 PERLMOD_MAKEVAR_PREFIX =
 258 ENABLE_PREPROCESSING   = YES
 259 MACRO_EXPANSION        = YES
 260 EXPAND_ONLY_PREDEF     = YES
 261 SEARCH_INCLUDES        = YES
 262 INCLUDE_PATH           =
 263 INCLUDE_FILE_PATTERNS  =
 264 PREDEFINED             = \
 265         __attribute__(x)= \
 266         DEFINE_SPINLOCK(s)="spinlock_t s" \
 267         DEFINE_MMIO_READ(s)="static inline u##s mmio_read##s(void *address);" \
 268         DEFINE_MMIO_WRITE(s)="static inline void mmio_write##s(void *address, u##s value);"
 269 EXPAND_AS_DEFINED      =
 270 SKIP_FUNCTION_MACROS   = YES
 271 TAGFILES               =
 272 GENERATE_TAGFILE       =
 273 ALLEXTERNALS           = NO
 274 EXTERNAL_GROUPS        = YES
 275 EXTERNAL_PAGES         = YES
 276 PERL_PATH              = /usr/bin/perl
 277 CLASS_DIAGRAMS         = YES
 278 MSCGEN_PATH            =
 279 HIDE_UNDOC_RELATIONS   = YES
 280 HAVE_DOT               = NO
 281 DOT_NUM_THREADS        = 0
 282 DOT_FONTNAME           = Helvetica
 283 DOT_FONTSIZE           = 10
 284 DOT_FONTPATH           =
 285 CLASS_GRAPH            = YES
 286 COLLABORATION_GRAPH    = YES
 287 GROUP_GRAPHS           = YES
 288 UML_LOOK               = NO
 289 UML_LIMIT_NUM_FIELDS   = 10
 290 TEMPLATE_RELATIONS     = NO
 291 INCLUDE_GRAPH          = YES
 292 INCLUDED_BY_GRAPH      = YES
 293 CALL_GRAPH             = NO
 294 CALLER_GRAPH           = NO
 295 GRAPHICAL_HIERARCHY    = YES
 296 DIRECTORY_GRAPH        = YES
 297 DOT_IMAGE_FORMAT       = png
 298 INTERACTIVE_SVG        = NO
 299 DOT_PATH               =
 300 DOTFILE_DIRS           =
 301 MSCFILE_DIRS           =
 302 DOT_GRAPH_MAX_NODES    = 50
 303 MAX_DOT_GRAPH_DEPTH    = 0
 304 DOT_TRANSPARENT        = NO
 305 DOT_MULTI_TARGETS      = NO
 306 GENERATE_LEGEND        = YES
 307 DOT_CLEANUP            = YES