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_helper.h \
 105     include/tdm_list.h \
 106     include/tdm_log.h \
 107     include/tdm_types.h
 108 INPUT_ENCODING         = UTF-8
 109 FILE_PATTERNS          =
 110 RECURSIVE              = NO
 111 EXCLUDE                =
 112 EXCLUDE_SYMLINKS       = NO
 113 EXCLUDE_PATTERNS       =
 114 EXCLUDE_SYMBOLS        =
 115 EXAMPLE_PATH           =
 116 EXAMPLE_PATTERNS       =
 117 EXAMPLE_RECURSIVE      = NO
 118 IMAGE_PATH             =
 119 INPUT_FILTER           =
 120 FILTER_PATTERNS        =
 121 FILTER_SOURCE_FILES    = NO
 122 FILTER_SOURCE_PATTERNS =
 123 USE_MDFILE_AS_MAINPAGE =
 124 #---------------------------------------------------------------------------
 125 # Configuration options related to source browsing
 126 #---------------------------------------------------------------------------
 127 SOURCE_BROWSER         = NO
 128 INLINE_SOURCES         = NO
 129 STRIP_CODE_COMMENTS    = YES
 130 REFERENCED_BY_RELATION = NO
 131 REFERENCES_RELATION    = NO
 132 REFERENCES_LINK_SOURCE = YES
 133 SOURCE_TOOLTIPS        = YES
 134 USE_HTAGS              = NO
 135 VERBATIM_HEADERS       = YES
 136 #---------------------------------------------------------------------------
 137 # Configuration options related to the alphabetical class index
 138 #---------------------------------------------------------------------------
 139 ALPHABETICAL_INDEX     = YES
 140 COLS_IN_ALPHA_INDEX    = 5
 141 IGNORE_PREFIX          =
 142 #---------------------------------------------------------------------------
 143 # Configuration options related to the HTML output
 144 #---------------------------------------------------------------------------
 145 GENERATE_HTML          = YES
 146 HTML_OUTPUT            = html
 147 HTML_FILE_EXTENSION    = .html
 148 HTML_HEADER            =
 149 HTML_FOOTER            =
 150 HTML_STYLESHEET        =
 151 HTML_EXTRA_STYLESHEET  =
 152 HTML_EXTRA_FILES       =
 153 HTML_COLORSTYLE_HUE    = 220
 154 HTML_COLORSTYLE_SAT    = 100
 155 HTML_COLORSTYLE_GAMMA  = 80
 156 HTML_TIMESTAMP         = YES
 157 HTML_DYNAMIC_SECTIONS  = NO
 158 HTML_INDEX_NUM_ENTRIES = 100
 159 GENERATE_DOCSET        = NO
 160 DOCSET_FEEDNAME        = "Doxygen generated docs"
 161 DOCSET_BUNDLE_ID       = org.doxygen.Project
 162 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 163 DOCSET_PUBLISHER_NAME  = Publisher
 164 GENERATE_HTMLHELP      = NO
 165 CHM_FILE               =
 166 HHC_LOCATION           =
 167 GENERATE_CHI           = NO
 168 CHM_INDEX_ENCODING     =
 169 BINARY_TOC             = NO
 170 TOC_EXPAND             = NO
 171 GENERATE_QHP           = NO
 172 QCH_FILE               =
 173 QHP_NAMESPACE          = org.doxygen.Project
 174 QHP_VIRTUAL_FOLDER     = doc
 175 QHP_CUST_FILTER_NAME   =
 176 QHP_CUST_FILTER_ATTRS  =
 177 QHP_SECT_FILTER_ATTRS  =
 178 QHG_LOCATION           =
 179 GENERATE_ECLIPSEHELP   = NO
 180 ECLIPSE_DOC_ID         = org.doxygen.Project
 181 DISABLE_INDEX          = NO
 182 GENERATE_TREEVIEW      = NO
 183 ENUM_VALUES_PER_LINE   = 4
 184 TREEVIEW_WIDTH         = 250
 185 EXT_LINKS_IN_WINDOW    = NO
 186 FORMULA_FONTSIZE       = 10
 187 FORMULA_TRANSPARENT    = YES
 188 USE_MATHJAX            = NO
 189 MATHJAX_FORMAT         = HTML-CSS
 190 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 191 MATHJAX_EXTENSIONS     =
 192 MATHJAX_CODEFILE       =
 193 SEARCHENGINE           = YES
 194 SERVER_BASED_SEARCH    = NO
 195 EXTERNAL_SEARCH        = NO
 196 SEARCHENGINE_URL       =
 197 SEARCHDATA_FILE        = searchdata.xml
 198 EXTERNAL_SEARCH_ID     =
 199 EXTRA_SEARCH_MAPPINGS  =
 200 #---------------------------------------------------------------------------
 201 # Configuration options related to the LaTeX output
 202 #---------------------------------------------------------------------------
 203 GENERATE_LATEX         = NO
 204 LATEX_OUTPUT           = latex
 205 LATEX_CMD_NAME         = latex
 206 MAKEINDEX_CMD_NAME     = makeindex
 207 COMPACT_LATEX          = NO
 208 PAPER_TYPE             = a4
 209 EXTRA_PACKAGES         =
 210 LATEX_HEADER           =
 211 LATEX_FOOTER           =
 212 LATEX_EXTRA_FILES      =
 213 PDF_HYPERLINKS         = YES
 214 USE_PDFLATEX           = YES
 215 LATEX_BATCHMODE        = NO
 216 LATEX_HIDE_INDICES     = NO
 217 LATEX_SOURCE_CODE      = NO
 218 LATEX_BIB_STYLE        = plain
 219 #---------------------------------------------------------------------------
 220 # Configuration options related to the RTF output
 221 #---------------------------------------------------------------------------
 222 GENERATE_RTF           = NO
 223 RTF_OUTPUT             = rtf
 224 COMPACT_RTF            = NO
 225 RTF_HYPERLINKS         = NO
 226 RTF_STYLESHEET_FILE    =
 227 RTF_EXTENSIONS_FILE    =
 228 #---------------------------------------------------------------------------
 229 # Configuration options related to the man page output
 230 #---------------------------------------------------------------------------
 231 GENERATE_MAN           = NO
 232 MAN_OUTPUT             = man
 233 MAN_EXTENSION          = .3
 234 MAN_LINKS              = NO
 235 #---------------------------------------------------------------------------
 236 # Configuration options related to the XML output
 237 #---------------------------------------------------------------------------
 238 GENERATE_XML           = NO
 239 XML_OUTPUT             = xml
 240 XML_SCHEMA             =
 241 XML_DTD                =
 242 XML_PROGRAMLISTING     = YES
 243 #---------------------------------------------------------------------------
 244 # Configuration options related to the DOCBOOK output
 245 #---------------------------------------------------------------------------
 246 GENERATE_DOCBOOK       = NO
 247 DOCBOOK_OUTPUT         = docbook
 248 #---------------------------------------------------------------------------
 249 # Configuration options for the AutoGen Definitions output
 250 #---------------------------------------------------------------------------
 251 GENERATE_AUTOGEN_DEF   = NO
 252 #---------------------------------------------------------------------------
 253 # Configuration options related to the Perl module output
 254 #---------------------------------------------------------------------------
 255 GENERATE_PERLMOD       = NO
 256 PERLMOD_LATEX          = NO
 257 PERLMOD_PRETTY         = YES
 258 PERLMOD_MAKEVAR_PREFIX =
 259 #---------------------------------------------------------------------------
 260 # Configuration options related to the preprocessor
 261 #---------------------------------------------------------------------------
 262 ENABLE_PREPROCESSING   = YES
 263 MACRO_EXPANSION        = NO
 264 EXPAND_ONLY_PREDEF     = NO
 265 SEARCH_INCLUDES        = YES
 266 INCLUDE_PATH           =
 267 INCLUDE_FILE_PATTERNS  =
 268 PREDEFINED             =
 269 EXPAND_AS_DEFINED      =
 270 SKIP_FUNCTION_MACROS   = YES
 271 #---------------------------------------------------------------------------
 272 # Configuration options related to external references
 273 #---------------------------------------------------------------------------
 274 TAGFILES               =
 275 GENERATE_TAGFILE       =
 276 ALLEXTERNALS           = NO
 277 EXTERNAL_GROUPS        = YES
 278 EXTERNAL_PAGES         = YES
 279 PERL_PATH              = /usr/bin/perl
 280 #---------------------------------------------------------------------------
 281 # Configuration options related to the dot tool
 282 #---------------------------------------------------------------------------
 283 CLASS_DIAGRAMS         = YES
 284 MSCGEN_PATH            =
 285 DIA_PATH               =
 286 HIDE_UNDOC_RELATIONS   = YES
 287 HAVE_DOT               = NO
 288 DOT_NUM_THREADS        = 0
 289 DOT_FONTNAME           = Helvetica
 290 DOT_FONTSIZE           = 10
 291 DOT_FONTPATH           =
 292 CLASS_GRAPH            = YES
 293 COLLABORATION_GRAPH    = YES
 294 GROUP_GRAPHS           = YES
 295 UML_LOOK               = NO
 296 UML_LIMIT_NUM_FIELDS   = 10
 297 TEMPLATE_RELATIONS     = NO
 298 INCLUDE_GRAPH          = YES
 299 INCLUDED_BY_GRAPH      = YES
 300 CALL_GRAPH             = NO
 301 CALLER_GRAPH           = NO
 302 GRAPHICAL_HIERARCHY    = YES
 303 DIRECTORY_GRAPH        = YES
 304 DOT_IMAGE_FORMAT       = png
 305 INTERACTIVE_SVG        = NO
 306 DOT_PATH               =
 307 DOTFILE_DIRS           =
 308 MSCFILE_DIRS           =
 309 DIAFILE_DIRS           =
 310 DOT_GRAPH_MAX_NODES    = 50
 311 MAX_DOT_GRAPH_DEPTH    = 0
 312 DOT_TRANSPARENT        = NO
 313 DOT_MULTI_TARGETS      = YES
 314 GENERATE_LEGEND        = YES
 315 DOT_CLEANUP            = YES