git.cworth.org Git - notmuch/blob - doc/doxygen.cfg

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