doc/doxygen.cfg

   1 # Doxyfile 1.5.7.1
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = $(PROJECT)-$(VERSION)
   8 PROJECT_NUMBER         =
   9 OUTPUT_DIRECTORY       = $(DOCDIR)
  10 CREATE_SUBDIRS         = YES
  11 OUTPUT_LANGUAGE        = English
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       =
  15 ALWAYS_DETAILED_SEC    = YES
  16 INLINE_INHERITED_MEMB  = NO
  17 FULL_PATH_NAMES        = YES
  18 STRIP_FROM_PATH        = $(SRCDIR)
  19 STRIP_FROM_INC_PATH    = $(SRCDIR)
  20 SHORT_NAMES            = NO
  21 JAVADOC_AUTOBRIEF      = YES
  22 QT_AUTOBRIEF           = NO
  23 MULTILINE_CPP_IS_BRIEF = NO
  24 INHERIT_DOCS           = YES
  25 SEPARATE_MEMBER_PAGES  = YES
  26 TAB_SIZE               = 8
  27 ALIASES                =
  28 OPTIMIZE_OUTPUT_FOR_C  = YES
  29 OPTIMIZE_OUTPUT_JAVA   = NO
  30 OPTIMIZE_FOR_FORTRAN   = NO
  31 OPTIMIZE_OUTPUT_VHDL   = NO
  32 BUILTIN_STL_SUPPORT    = NO
  33 CPP_CLI_SUPPORT        = NO
  34 SIP_SUPPORT            = NO
  35 IDL_PROPERTY_SUPPORT   = YES
  36 DISTRIBUTE_GROUP_DOC   = NO
  37 SUBGROUPING            = YES
  38 TYPEDEF_HIDES_STRUCT   = NO
  39 SYMBOL_CACHE_SIZE      = 0
  40 #---------------------------------------------------------------------------
  41 # Build related configuration options
  42 #---------------------------------------------------------------------------
  43 EXTRACT_ALL            = YES
  44 EXTRACT_PRIVATE        = NO
  45 EXTRACT_STATIC         = NO
  46 EXTRACT_LOCAL_CLASSES  = YES
  47 EXTRACT_LOCAL_METHODS  = NO
  48 EXTRACT_ANON_NSPACES   = NO
  49 HIDE_UNDOC_MEMBERS     = NO
  50 HIDE_UNDOC_CLASSES     = NO
  51 HIDE_FRIEND_COMPOUNDS  = NO
  52 HIDE_IN_BODY_DOCS      = NO
  53 INTERNAL_DOCS          = NO
  54 CASE_SENSE_NAMES       = NO
  55 HIDE_SCOPE_NAMES       = NO
  56 SHOW_INCLUDE_FILES     = YES
  57 INLINE_INFO            = YES
  58 SORT_MEMBER_DOCS       = YES
  59 SORT_BRIEF_DOCS        = NO
  60 SORT_GROUP_NAMES       = NO
  61 SORT_BY_SCOPE_NAME     = NO
  62 GENERATE_TODOLIST      = YES
  63 GENERATE_TESTLIST      = YES
  64 GENERATE_BUGLIST       = YES
  65 GENERATE_DEPRECATEDLIST= YES
  66 ENABLED_SECTIONS       =
  67 MAX_INITIALIZER_LINES  = 30
  68 SHOW_USED_FILES        = YES
  69 SHOW_DIRECTORIES       = NO
  70 SHOW_FILES             = YES
  71 SHOW_NAMESPACES        = YES
  72 FILE_VERSION_FILTER    =
  73 LAYOUT_FILE            =
  74 #---------------------------------------------------------------------------
  75 # configuration options related to warning and progress messages
  76 #---------------------------------------------------------------------------
  77 QUIET                  = YES
  78 WARNINGS               = YES
  79 WARN_IF_UNDOCUMENTED   = YES
  80 WARN_IF_DOC_ERROR      = YES
  81 WARN_NO_PARAMDOC       = NO
  82 WARN_FORMAT            = "$file:$line: $text"
  83 WARN_LOGFILE           =
  84 #---------------------------------------------------------------------------
  85 # configuration options related to the input files
  86 #---------------------------------------------------------------------------
  87 INPUT                  = $(SRCDIR)
  88 INPUT_ENCODING         = UTF-8
  89 FILE_PATTERNS          = *.c \
  90                          *.h
  91 RECURSIVE              = YES
  92 EXCLUDE                =
  93 EXCLUDE_SYMLINKS       = NO
  94 EXCLUDE_PATTERNS       = */intl/* */tests/* */.git/*
  95 EXCLUDE_SYMBOLS        =
  96 EXAMPLE_PATH           = $(SRCDIR)
  97 EXAMPLE_PATTERNS       =
  98 EXAMPLE_RECURSIVE      = NO
  99 IMAGE_PATH             =
 100 INPUT_FILTER           =
 101 FILTER_PATTERNS        =
 102 FILTER_SOURCE_FILES    = NO
 103 #---------------------------------------------------------------------------
 104 # configuration options related to source browsing
 105 #---------------------------------------------------------------------------
 106 SOURCE_BROWSER         = YES
 107 INLINE_SOURCES         = NO
 108 STRIP_CODE_COMMENTS    = YES
 109 REFERENCED_BY_RELATION = YES
 110 REFERENCES_RELATION    = YES
 111 REFERENCES_LINK_SOURCE = YES
 112 USE_HTAGS              = NO
 113 VERBATIM_HEADERS       = NO
 114 #---------------------------------------------------------------------------
 115 # configuration options related to the alphabetical class index
 116 #---------------------------------------------------------------------------
 117 ALPHABETICAL_INDEX     = YES
 118 COLS_IN_ALPHA_INDEX    = 5
 119 IGNORE_PREFIX          =
 120 #---------------------------------------------------------------------------
 121 # configuration options related to the HTML output
 122 #---------------------------------------------------------------------------
 123 GENERATE_HTML          = YES
 124 HTML_OUTPUT            = html
 125 HTML_FILE_EXTENSION    = .html
 126 HTML_HEADER            =
 127 HTML_FOOTER            =
 128 HTML_STYLESHEET        =
 129 HTML_ALIGN_MEMBERS     = YES
 130 HTML_DYNAMIC_SECTIONS  = NO
 131 GENERATE_DOCSET        = NO
 132 DOCSET_FEEDNAME        = "Doxygen generated docs"
 133 DOCSET_BUNDLE_ID       = org.doxygen.Project
 134 GENERATE_HTMLHELP      = NO
 135 CHM_FILE               = ../$(PROJECT).chm
 136 HHC_LOCATION           = $(HHC_PATH)
 137 GENERATE_CHI           = NO
 138 CHM_INDEX_ENCODING     =
 139 BINARY_TOC             = NO
 140 TOC_EXPAND             = NO
 141 GENERATE_QHP           = NO
 142 QCH_FILE               =
 143 QHP_NAMESPACE          = org.doxygen.Project
 144 QHP_VIRTUAL_FOLDER     = doc
 145 QHG_LOCATION           =
 146 DISABLE_INDEX          = NO
 147 ENUM_VALUES_PER_LINE   = 4
 148 GENERATE_TREEVIEW      = YES
 149 TREEVIEW_WIDTH         = 250
 150 FORMULA_FONTSIZE       = 10
 151 #---------------------------------------------------------------------------
 152 # configuration options related to the LaTeX output
 153 #---------------------------------------------------------------------------
 154 GENERATE_LATEX         = NO
 155 LATEX_OUTPUT           = latex
 156 LATEX_CMD_NAME         = latex
 157 MAKEINDEX_CMD_NAME     = makeindex
 158 COMPACT_LATEX          = NO
 159 PAPER_TYPE             = $(PAPER_SIZE)
 160 EXTRA_PACKAGES         =
 161 LATEX_HEADER           =
 162 PDF_HYPERLINKS         = NO
 163 USE_PDFLATEX           = NO
 164 LATEX_BATCHMODE        = YES
 165 LATEX_HIDE_INDICES     = NO
 166 #---------------------------------------------------------------------------
 167 # configuration options related to the RTF output
 168 #---------------------------------------------------------------------------
 169 GENERATE_RTF           = NO
 170 RTF_OUTPUT             = rtf
 171 COMPACT_RTF            = NO
 172 RTF_HYPERLINKS         = NO
 173 RTF_STYLESHEET_FILE    =
 174 RTF_EXTENSIONS_FILE    =
 175 #---------------------------------------------------------------------------
 176 # configuration options related to the man page output
 177 #---------------------------------------------------------------------------
 178 GENERATE_MAN           = NO
 179 MAN_OUTPUT             = man
 180 MAN_EXTENSION          = .1
 181 MAN_LINKS              = NO
 182 #---------------------------------------------------------------------------
 183 # configuration options related to the XML output
 184 #---------------------------------------------------------------------------
 185 GENERATE_XML           = NO
 186 XML_OUTPUT             = xml
 187 XML_SCHEMA             =
 188 XML_DTD                =
 189 XML_PROGRAMLISTING     = YES
 190 #---------------------------------------------------------------------------
 191 # configuration options for the AutoGen Definitions output
 192 #---------------------------------------------------------------------------
 193 GENERATE_AUTOGEN_DEF   = NO
 194 #---------------------------------------------------------------------------
 195 # configuration options related to the Perl module output
 196 #---------------------------------------------------------------------------
 197 GENERATE_PERLMOD       = NO
 198 PERLMOD_LATEX          = NO
 199 PERLMOD_PRETTY         = YES
 200 PERLMOD_MAKEVAR_PREFIX =
 201 #---------------------------------------------------------------------------
 202 # Configuration options related to the preprocessor
 203 #---------------------------------------------------------------------------
 204 ENABLE_PREPROCESSING   = YES
 205 MACRO_EXPANSION        = NO
 206 EXPAND_ONLY_PREDEF     = NO
 207 SEARCH_INCLUDES        = YES
 208 INCLUDE_PATH           =
 209 INCLUDE_FILE_PATTERNS  =
 210 PREDEFINED             =
 211 EXPAND_AS_DEFINED      =
 212 SKIP_FUNCTION_MACROS   = YES
 213 #---------------------------------------------------------------------------
 214 # Configuration::additions related to external references
 215 #---------------------------------------------------------------------------
 216 TAGFILES               =
 217 GENERATE_TAGFILE       = $(DOCDIR)/$(PROJECT).tag
 218 ALLEXTERNALS           = NO
 219 EXTERNAL_GROUPS        = YES
 220 PERL_PATH              = $(PERL_PATH)
 221 #---------------------------------------------------------------------------
 222 # Configuration options related to the dot tool
 223 #---------------------------------------------------------------------------
 224 CLASS_DIAGRAMS         = YES
 225 MSCGEN_PATH            =
 226 HIDE_UNDOC_RELATIONS   = YES
 227 HAVE_DOT               = YES
 228 DOT_FONTNAME           = FreeSans
 229 DOT_FONTSIZE           = 10
 230 DOT_FONTPATH           =
 231 CLASS_GRAPH            = YES
 232 COLLABORATION_GRAPH    = YES
 233 GROUP_GRAPHS           = YES
 234 UML_LOOK               = NO
 235 TEMPLATE_RELATIONS     = NO
 236 INCLUDE_GRAPH          = YES
 237 INCLUDED_BY_GRAPH      = YES
 238 CALL_GRAPH             = NO
 239 CALLER_GRAPH           = NO
 240 GRAPHICAL_HIERARCHY    = YES
 241 DIRECTORY_GRAPH        = YES
 242 DOT_IMAGE_FORMAT       = png
 243 DOT_PATH               = $(DOT_PATH)
 244 DOTFILE_DIRS           =
 245 DOT_GRAPH_MAX_NODES    = 550
 246 MAX_DOT_GRAPH_DEPTH    = 0
 247 DOT_TRANSPARENT        = NO
 248 DOT_MULTI_TARGETS      = NO
 249 GENERATE_LEGEND        = YES
 250 DOT_CLEANUP            = YES
 251 #---------------------------------------------------------------------------
 252 # Configuration::additions related to the search engine
 253 #---------------------------------------------------------------------------
 254 SEARCHENGINE           = NO