doc/doxygen.conf.in.in

   1 # Doxyfile 1.9.4
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = libpwmd
   8 PROJECT_NUMBER         = @VER_MAJOR@.@VER_MINOR@.@VER_PATCH@
   9 PROJECT_BRIEF          = "An API for pwmd."
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       =
  12 CREATE_SUBDIRS         = NO
  13 CREATE_SUBDIRS_LEVEL   = 8
  14 ALLOW_UNICODE_NAMES    = NO
  15 OUTPUT_LANGUAGE        = English
  16 BRIEF_MEMBER_DESC      = NO
  17 REPEAT_BRIEF           = YES
  18 ABBREVIATE_BRIEF       = "The $name class" \
  19                          "The $name widget" \
  20                          "The $name file" \
  21                          is \
  22                          provides \
  23                          specifies \
  24                          contains \
  25                          represents \
  26                          a \
  27                          an \
  28                          the
  29 ALWAYS_DETAILED_SEC    = NO
  30 INLINE_INHERITED_MEMB  = NO
  31 FULL_PATH_NAMES        = NO
  32 STRIP_FROM_PATH        =
  33 STRIP_FROM_INC_PATH    =
  34 SHORT_NAMES            = NO
  35 JAVADOC_AUTOBRIEF      = NO
  36 JAVADOC_BANNER         = NO
  37 QT_AUTOBRIEF           = NO
  38 MULTILINE_CPP_IS_BRIEF = NO
  39 PYTHON_DOCSTRING       = YES
  40 INHERIT_DOCS           = YES
  41 SEPARATE_MEMBER_PAGES  = NO
  42 TAB_SIZE               = 4
  43 ALIASES                = "filepath=\note When the first character of a filename parameter is a tilde (~), it will be expanded to the home directory of the current user."
  44 OPTIMIZE_OUTPUT_FOR_C  = YES
  45 OPTIMIZE_OUTPUT_JAVA   = NO
  46 OPTIMIZE_FOR_FORTRAN   = NO
  47 OPTIMIZE_OUTPUT_VHDL   = NO
  48 OPTIMIZE_OUTPUT_SLICE  = NO
  49 EXTENSION_MAPPING      =
  50 MARKDOWN_SUPPORT       = YES
  51 TOC_INCLUDE_HEADINGS   = 5
  52 AUTOLINK_SUPPORT       = YES
  53 BUILTIN_STL_SUPPORT    = NO
  54 CPP_CLI_SUPPORT        = NO
  55 SIP_SUPPORT            = NO
  56 IDL_PROPERTY_SUPPORT   = YES
  57 DISTRIBUTE_GROUP_DOC   = NO
  58 GROUP_NESTED_COMPOUNDS = NO
  59 SUBGROUPING            = YES
  60 INLINE_GROUPED_CLASSES = NO
  61 INLINE_SIMPLE_STRUCTS  = NO
  62 TYPEDEF_HIDES_STRUCT   = NO
  63 LOOKUP_CACHE_SIZE      = 0
  64 NUM_PROC_THREADS       = 1
  65 #---------------------------------------------------------------------------
  66 # Build related configuration options
  67 #---------------------------------------------------------------------------
  68 EXTRACT_ALL            = NO
  69 EXTRACT_PRIVATE        = NO
  70 EXTRACT_PRIV_VIRTUAL   = NO
  71 EXTRACT_PACKAGE        = NO
  72 EXTRACT_STATIC         = NO
  73 EXTRACT_LOCAL_CLASSES  = YES
  74 EXTRACT_LOCAL_METHODS  = NO
  75 EXTRACT_ANON_NSPACES   = NO
  76 RESOLVE_UNNAMED_PARAMS = YES
  77 HIDE_UNDOC_MEMBERS     = NO
  78 HIDE_UNDOC_CLASSES     = NO
  79 HIDE_FRIEND_COMPOUNDS  = NO
  80 HIDE_IN_BODY_DOCS      = NO
  81 INTERNAL_DOCS          = YES
  82 CASE_SENSE_NAMES       = YES
  83 HIDE_SCOPE_NAMES       = NO
  84 HIDE_COMPOUND_REFERENCE= NO
  85 SHOW_HEADERFILE        = NO
  86 SHOW_INCLUDE_FILES     = NO
  87 SHOW_GROUPED_MEMB_INC  = NO
  88 FORCE_LOCAL_INCLUDES   = NO
  89 INLINE_INFO            = YES
  90 SORT_MEMBER_DOCS       = YES
  91 SORT_BRIEF_DOCS        = NO
  92 SORT_MEMBERS_CTORS_1ST = NO
  93 SORT_GROUP_NAMES       = NO
  94 SORT_BY_SCOPE_NAME     = NO
  95 STRICT_PROTO_MATCHING  = NO
  96 GENERATE_TODOLIST      = YES
  97 GENERATE_TESTLIST      = YES
  98 GENERATE_BUGLIST       = YES
  99 GENERATE_DEPRECATEDLIST= YES
 100 ENABLED_SECTIONS       =
 101 MAX_INITIALIZER_LINES  = 30
 102 SHOW_USED_FILES        = YES
 103 SHOW_FILES             = YES
 104 SHOW_NAMESPACES        = YES
 105 FILE_VERSION_FILTER    =
 106 LAYOUT_FILE            =
 107 CITE_BIB_FILES         =
 108 #---------------------------------------------------------------------------
 109 # Configuration options related to warning and progress messages
 110 #---------------------------------------------------------------------------
 111 QUIET                  = NO
 112 WARNINGS               = YES
 113 WARN_IF_UNDOCUMENTED   = YES
 114 WARN_IF_DOC_ERROR      = YES
 115 WARN_IF_INCOMPLETE_DOC = YES
 116 WARN_NO_PARAMDOC       = YES
 117 WARN_AS_ERROR          = NO
 118 WARN_FORMAT            = "$file:$line: $text"
 119 WARN_LINE_FORMAT       = "at line $line of file $file"
 120 WARN_LOGFILE           =
 121 #---------------------------------------------------------------------------
 122 # Configuration options related to the input files
 123 #---------------------------------------------------------------------------
 124 INPUT                  = ^^SRC_DIR^^/libpwmd.h
 125 INPUT_ENCODING         = UTF-8
 126 FILE_PATTERNS          = *.c \
 127                          *.cc \
 128                          *.cxx \
 129                          *.cpp \
 130                          *.c++ \
 131                          *.java \
 132                          *.ii \
 133                          *.ixx \
 134                          *.ipp \
 135                          *.i++ \
 136                          *.inl \
 137                          *.idl \
 138                          *.ddl \
 139                          *.odl \
 140                          *.h \
 141                          *.hh \
 142                          *.hxx \
 143                          *.hpp \
 144                          *.h++ \
 145                          *.l \
 146                          *.cs \
 147                          *.d \
 148                          *.php \
 149                          *.php4 \
 150                          *.php5 \
 151                          *.phtml \
 152                          *.inc \
 153                          *.m \
 154                          *.markdown \
 155                          *.md \
 156                          *.mm \
 157                          *.dox \
 158                          *.py \
 159                          *.pyw \
 160                          *.f90 \
 161                          *.f95 \
 162                          *.f03 \
 163                          *.f08 \
 164                          *.f18 \
 165                          *.f \
 166                          *.for \
 167                          *.vhd \
 168                          *.vhdl \
 169                          *.ucf \
 170                          *.qsf \
 171                          *.ice
 172 RECURSIVE              = NO
 173 EXCLUDE                =
 174 EXCLUDE_SYMLINKS       = NO
 175 EXCLUDE_PATTERNS       =
 176 EXCLUDE_SYMBOLS        =
 177 EXAMPLE_PATH           =
 178 EXAMPLE_PATTERNS       = *
 179 EXAMPLE_RECURSIVE      = NO
 180 IMAGE_PATH             =
 181 INPUT_FILTER           =
 182 FILTER_PATTERNS        =
 183 FILTER_SOURCE_FILES    = NO
 184 FILTER_SOURCE_PATTERNS =
 185 USE_MDFILE_AS_MAINPAGE =
 186 #---------------------------------------------------------------------------
 187 # Configuration options related to source browsing
 188 #---------------------------------------------------------------------------
 189 SOURCE_BROWSER         = NO
 190 INLINE_SOURCES         = NO
 191 STRIP_CODE_COMMENTS    = YES
 192 REFERENCED_BY_RELATION = NO
 193 REFERENCES_RELATION    = NO
 194 REFERENCES_LINK_SOURCE = YES
 195 SOURCE_TOOLTIPS        = YES
 196 USE_HTAGS              = NO
 197 VERBATIM_HEADERS       = YES
 198 CLANG_ASSISTED_PARSING = NO
 199 CLANG_ADD_INC_PATHS    = YES
 200 CLANG_OPTIONS          =
 201 CLANG_DATABASE_PATH    =
 202 #---------------------------------------------------------------------------
 203 # Configuration options related to the alphabetical class index
 204 #---------------------------------------------------------------------------
 205 ALPHABETICAL_INDEX     = NO
 206 IGNORE_PREFIX          =
 207 #---------------------------------------------------------------------------
 208 # Configuration options related to the HTML output
 209 #---------------------------------------------------------------------------
 210 GENERATE_HTML          = NO
 211 HTML_OUTPUT            = html
 212 HTML_FILE_EXTENSION    = .html
 213 HTML_HEADER            =
 214 HTML_FOOTER            =
 215 HTML_STYLESHEET        =
 216 HTML_EXTRA_STYLESHEET  =
 217 HTML_EXTRA_FILES       =
 218 HTML_COLORSTYLE_HUE    = 220
 219 HTML_COLORSTYLE_SAT    = 100
 220 HTML_COLORSTYLE_GAMMA  = 80
 221 HTML_TIMESTAMP         = NO
 222 HTML_DYNAMIC_MENUS     = YES
 223 HTML_DYNAMIC_SECTIONS  = NO
 224 HTML_INDEX_NUM_ENTRIES = 100
 225 GENERATE_DOCSET        = NO
 226 DOCSET_FEEDNAME        = "Doxygen generated docs"
 227 DOCSET_FEEDURL         =
 228 DOCSET_BUNDLE_ID       = org.doxygen.Project
 229 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 230 DOCSET_PUBLISHER_NAME  = Publisher
 231 GENERATE_HTMLHELP      = NO
 232 CHM_FILE               =
 233 HHC_LOCATION           =
 234 GENERATE_CHI           = NO
 235 CHM_INDEX_ENCODING     =
 236 BINARY_TOC             = NO
 237 TOC_EXPAND             = NO
 238 GENERATE_QHP           = NO
 239 QCH_FILE               =
 240 QHP_NAMESPACE          = org.doxygen.Project
 241 QHP_VIRTUAL_FOLDER     = doc
 242 QHP_CUST_FILTER_NAME   =
 243 QHP_CUST_FILTER_ATTRS  =
 244 QHP_SECT_FILTER_ATTRS  =
 245 QHG_LOCATION           =
 246 GENERATE_ECLIPSEHELP   = NO
 247 ECLIPSE_DOC_ID         = org.doxygen.Project
 248 DISABLE_INDEX          = NO
 249 GENERATE_TREEVIEW      = NO
 250 FULL_SIDEBAR           = NO
 251 ENUM_VALUES_PER_LINE   = 4
 252 TREEVIEW_WIDTH         = 250
 253 EXT_LINKS_IN_WINDOW    = NO
 254 OBFUSCATE_EMAILS       = YES
 255 HTML_FORMULA_FORMAT    = png
 256 FORMULA_FONTSIZE       = 10
 257 FORMULA_TRANSPARENT    = YES
 258 FORMULA_MACROFILE      =
 259 USE_MATHJAX            = NO
 260 MATHJAX_VERSION        = MathJax_2
 261 MATHJAX_FORMAT         = HTML-CSS
 262 MATHJAX_RELPATH        =
 263 MATHJAX_EXTENSIONS     =
 264 MATHJAX_CODEFILE       =
 265 SEARCHENGINE           = YES
 266 SERVER_BASED_SEARCH    = NO
 267 EXTERNAL_SEARCH        = NO
 268 SEARCHENGINE_URL       =
 269 SEARCHDATA_FILE        = searchdata.xml
 270 EXTERNAL_SEARCH_ID     =
 271 EXTRA_SEARCH_MAPPINGS  =
 272 #---------------------------------------------------------------------------
 273 # Configuration options related to the LaTeX output
 274 #---------------------------------------------------------------------------
 275 GENERATE_LATEX         = NO
 276 LATEX_OUTPUT           = latex
 277 LATEX_CMD_NAME         =
 278 MAKEINDEX_CMD_NAME     = makeindex
 279 LATEX_MAKEINDEX_CMD    = makeindex
 280 COMPACT_LATEX          = NO
 281 PAPER_TYPE             = a4
 282 EXTRA_PACKAGES         =
 283 LATEX_HEADER           =
 284 LATEX_FOOTER           =
 285 LATEX_EXTRA_STYLESHEET =
 286 LATEX_EXTRA_FILES      =
 287 PDF_HYPERLINKS         = YES
 288 USE_PDFLATEX           = YES
 289 LATEX_BATCHMODE        = NO
 290 LATEX_HIDE_INDICES     = NO
 291 LATEX_BIB_STYLE        = plain
 292 LATEX_TIMESTAMP        = NO
 293 LATEX_EMOJI_DIRECTORY  =
 294 #---------------------------------------------------------------------------
 295 # Configuration options related to the RTF output
 296 #---------------------------------------------------------------------------
 297 GENERATE_RTF           = NO
 298 RTF_OUTPUT             = rtf
 299 COMPACT_RTF            = NO
 300 RTF_HYPERLINKS         = NO
 301 RTF_STYLESHEET_FILE    =
 302 RTF_EXTENSIONS_FILE    =
 303 #---------------------------------------------------------------------------
 304 # Configuration options related to the man page output
 305 #---------------------------------------------------------------------------
 306 GENERATE_MAN           = YES
 307 MAN_OUTPUT             = man
 308 MAN_EXTENSION          = .3
 309 MAN_SUBDIR             =
 310 MAN_LINKS              = NO
 311 #---------------------------------------------------------------------------
 312 # Configuration options related to the XML output
 313 #---------------------------------------------------------------------------
 314 GENERATE_XML           = NO
 315 XML_OUTPUT             = xml
 316 XML_PROGRAMLISTING     = YES
 317 XML_NS_MEMB_FILE_SCOPE = NO
 318 #---------------------------------------------------------------------------
 319 # Configuration options related to the DOCBOOK output
 320 #---------------------------------------------------------------------------
 321 GENERATE_DOCBOOK       = NO
 322 DOCBOOK_OUTPUT         = docbook
 323 #---------------------------------------------------------------------------
 324 # Configuration options for the AutoGen Definitions output
 325 #---------------------------------------------------------------------------
 326 GENERATE_AUTOGEN_DEF   = NO
 327 #---------------------------------------------------------------------------
 328 # Configuration options related to Sqlite3 output
 329 #---------------------------------------------------------------------------
 330 #---------------------------------------------------------------------------
 331 # Configuration options related to the Perl module output
 332 #---------------------------------------------------------------------------
 333 GENERATE_PERLMOD       = NO
 334 PERLMOD_LATEX          = NO
 335 PERLMOD_PRETTY         = YES
 336 PERLMOD_MAKEVAR_PREFIX =
 337 #---------------------------------------------------------------------------
 338 # Configuration options related to the preprocessor
 339 #---------------------------------------------------------------------------
 340 ENABLE_PREPROCESSING   = YES
 341 MACRO_EXPANSION        = NO
 342 EXPAND_ONLY_PREDEF     = NO
 343 SEARCH_INCLUDES        = YES
 344 INCLUDE_PATH           =
 345 INCLUDE_FILE_PATTERNS  =
 346 PREDEFINED             =
 347 EXPAND_AS_DEFINED      =
 348 SKIP_FUNCTION_MACROS   = YES
 349 #---------------------------------------------------------------------------
 350 # Configuration options related to external references
 351 #---------------------------------------------------------------------------
 352 TAGFILES               =
 353 GENERATE_TAGFILE       =
 354 ALLEXTERNALS           = NO
 355 EXTERNAL_GROUPS        = YES
 356 EXTERNAL_PAGES         = YES
 357 #---------------------------------------------------------------------------
 358 # Configuration options related to the dot tool
 359 #---------------------------------------------------------------------------
 360 DIA_PATH               =
 361 HIDE_UNDOC_RELATIONS   = YES
 362 HAVE_DOT               = NO
 363 DOT_NUM_THREADS        = 0
 364 DOT_FONTNAME           = Helvetica
 365 DOT_FONTSIZE           = 10
 366 DOT_FONTPATH           =
 367 CLASS_GRAPH            = NO
 368 COLLABORATION_GRAPH    = YES
 369 GROUP_GRAPHS           = YES
 370 UML_LOOK               = NO
 371 UML_LIMIT_NUM_FIELDS   = 10
 372 DOT_UML_DETAILS        = NO
 373 DOT_WRAP_THRESHOLD     = 17
 374 TEMPLATE_RELATIONS     = NO
 375 INCLUDE_GRAPH          = YES
 376 INCLUDED_BY_GRAPH      = YES
 377 CALL_GRAPH             = NO
 378 CALLER_GRAPH           = NO
 379 GRAPHICAL_HIERARCHY    = YES
 380 DIRECTORY_GRAPH        = YES
 381 DIR_GRAPH_MAX_DEPTH    = 1
 382 DOT_IMAGE_FORMAT       = png
 383 INTERACTIVE_SVG        = NO
 384 DOT_PATH               =
 385 DOTFILE_DIRS           =
 386 MSCFILE_DIRS           =
 387 DIAFILE_DIRS           =
 388 PLANTUML_JAR_PATH      =
 389 PLANTUML_CFG_FILE      =
 390 PLANTUML_INCLUDE_PATH  =
 391 DOT_GRAPH_MAX_NODES    = 50
 392 MAX_DOT_GRAPH_DEPTH    = 0
 393 DOT_TRANSPARENT        = NO
 394 DOT_MULTI_TARGETS      = NO
 395 GENERATE_LEGEND        = YES
 396 DOT_CLEANUP            = YES