doxygen.cfg

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