doc/Doxyfile

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