Doxyfile

   1 # Doxyfile 1.8.6
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6
   7 DOXYFILE_ENCODING      = UTF-8
   8 PROJECT_NAME           = "PulseView"
   9 PROJECT_NUMBER         = "unreleased development snapshot"
  10 PROJECT_BRIEF          = "A Qt-based sigrok GUI"
  11 PROJECT_LOGO           = icons/pulseview.png
  12 OUTPUT_DIRECTORY       = doxy
  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        =
  22 STRIP_FROM_INC_PATH    =
  23 SHORT_NAMES            = NO
  24 JAVADOC_AUTOBRIEF      = NO
  25 QT_AUTOBRIEF           = NO
  26 MULTILINE_CPP_IS_BRIEF = NO
  27 INHERIT_DOCS           = YES
  28 SEPARATE_MEMBER_PAGES  = NO
  29 TAB_SIZE               = 4
  30 ALIASES                =
  31 MARKDOWN_SUPPORT       = YES
  32 AUTOLINK_SUPPORT       = YES
  33 BUILTIN_STL_SUPPORT    = YES
  34 SUBGROUPING            = YES
  35 INLINE_GROUPED_CLASSES = NO
  36 INLINE_SIMPLE_STRUCTS  = YES
  37 TYPEDEF_HIDES_STRUCT   = NO
  38 LOOKUP_CACHE_SIZE      = 0
  39
  40 #---------------------------------------------------------------------------
  41 # Build related configuration options
  42 #---------------------------------------------------------------------------
  43
  44 EXTRACT_ALL            = YES
  45 EXTRACT_PRIVATE        = YES
  46 EXTRACT_PACKAGE        = NO
  47 EXTRACT_STATIC         = YES
  48 EXTRACT_LOCAL_CLASSES  = YES
  49 HIDE_UNDOC_MEMBERS     = NO
  50 HIDE_UNDOC_CLASSES     = NO
  51 HIDE_FRIEND_COMPOUNDS  = NO
  52 HIDE_IN_BODY_DOCS      = NO
  53 INTERNAL_DOCS          = YES
  54 CASE_SENSE_NAMES       = YES
  55 HIDE_SCOPE_NAMES       = NO
  56 SHOW_INCLUDE_FILES     = YES
  57 SHOW_GROUPED_MEMB_INC  = NO
  58 FORCE_LOCAL_INCLUDES   = NO
  59 INLINE_INFO            = YES
  60 SORT_MEMBER_DOCS       = YES
  61 SORT_BRIEF_DOCS        = NO
  62 SORT_MEMBERS_CTORS_1ST = YES
  63 SORT_GROUP_NAMES       = NO
  64 SORT_BY_SCOPE_NAME     = NO
  65 STRICT_PROTO_MATCHING  = NO
  66 GENERATE_TODOLIST      = NO
  67 GENERATE_TESTLIST      = YES
  68 GENERATE_BUGLIST       = NO
  69 GENERATE_DEPRECATEDLIST= NO
  70 ENABLED_SECTIONS       =
  71 MAX_INITIALIZER_LINES  = 30
  72 SHOW_USED_FILES        = YES
  73 SHOW_FILES             = YES
  74 SHOW_NAMESPACES        = YES
  75 FILE_VERSION_FILTER    =
  76 LAYOUT_FILE            =
  77
  78 #---------------------------------------------------------------------------
  79 # Configuration options related to warning and progress messages
  80 #---------------------------------------------------------------------------
  81
  82 QUIET                  = YES
  83 WARNINGS               = YES
  84 WARN_IF_UNDOCUMENTED   = YES
  85 WARN_IF_DOC_ERROR      = YES
  86 WARN_NO_PARAMDOC       = NO
  87 WARN_FORMAT            = "$file:$line: $text"
  88 WARN_LOGFILE           =
  89
  90 #---------------------------------------------------------------------------
  91 # Configuration options related to the input files
  92 #---------------------------------------------------------------------------
  93
  94 INPUT                  = .
  95 INPUT_ENCODING         = UTF-8
  96 FILE_PATTERNS          =
  97 RECURSIVE              = YES
  98 EXCLUDE                =
  99 EXCLUDE_SYMLINKS       = NO
 100 EXCLUDE_PATTERNS       = moc_*.cxx*
 101 EXCLUDE_SYMBOLS        =
 102 EXAMPLE_PATH           =
 103 EXAMPLE_PATTERNS       =
 104 EXAMPLE_RECURSIVE      = NO
 105 IMAGE_PATH             =
 106 INPUT_FILTER           =
 107 FILTER_PATTERNS        =
 108 FILTER_SOURCE_FILES    = NO
 109 FILTER_SOURCE_PATTERNS =
 110 USE_MDFILE_AS_MAINPAGE =
 111
 112 #---------------------------------------------------------------------------
 113 # Configuration options related to source browsing
 114 #---------------------------------------------------------------------------
 115
 116 SOURCE_BROWSER         = YES
 117 INLINE_SOURCES         = NO
 118 STRIP_CODE_COMMENTS    = YES
 119 REFERENCED_BY_RELATION = NO
 120 REFERENCES_RELATION    = NO
 121 REFERENCES_LINK_SOURCE = YES
 122 SOURCE_TOOLTIPS        = YES
 123 USE_HTAGS              = NO
 124 VERBATIM_HEADERS       = YES
 125
 126 #---------------------------------------------------------------------------
 127 # Configuration options related to the alphabetical class index
 128 #---------------------------------------------------------------------------
 129
 130 ALPHABETICAL_INDEX     = YES
 131 COLS_IN_ALPHA_INDEX    = 5
 132 IGNORE_PREFIX          =
 133
 134 #---------------------------------------------------------------------------
 135 # Configuration options related to the HTML output
 136 #---------------------------------------------------------------------------
 137
 138 GENERATE_HTML          = YES
 139 HTML_OUTPUT            = html-api
 140 HTML_FILE_EXTENSION    = .html
 141 HTML_HEADER            =
 142 HTML_FOOTER            =
 143 HTML_STYLESHEET        =
 144 HTML_EXTRA_STYLESHEET  =
 145 HTML_EXTRA_FILES       =
 146 HTML_COLORSTYLE_HUE    = 220
 147 HTML_COLORSTYLE_SAT    = 100
 148 HTML_COLORSTYLE_GAMMA  = 80
 149 HTML_TIMESTAMP         = YES
 150 HTML_DYNAMIC_SECTIONS  = NO
 151 HTML_INDEX_NUM_ENTRIES = 100
 152 DISABLE_INDEX          = NO
 153 GENERATE_TREEVIEW      = YES
 154 ENUM_VALUES_PER_LINE   = 4
 155 TREEVIEW_WIDTH         = 250
 156 EXT_LINKS_IN_WINDOW    = NO
 157 FORMULA_FONTSIZE       = 10
 158 FORMULA_TRANSPARENT    = YES
 159 SEARCHENGINE           = YES
 160 SERVER_BASED_SEARCH    = NO
 161 EXTERNAL_SEARCH        = NO
 162 SEARCHENGINE_URL       =
 163 SEARCHDATA_FILE        = searchdata.xml
 164 EXTERNAL_SEARCH_ID     =
 165 EXTRA_SEARCH_MAPPINGS  =
 166
 167 #---------------------------------------------------------------------------
 168 # Configuration options related to the Latex output
 169 #---------------------------------------------------------------------------
 170
 171 GENERATE_LATEX         = NO
 172
 173 #---------------------------------------------------------------------------
 174 # Configuration options related to the preprocessor
 175 #---------------------------------------------------------------------------
 176
 177 ENABLE_PREPROCESSING   = YES
 178 MACRO_EXPANSION        = NO
 179 EXPAND_ONLY_PREDEF     = NO
 180 SEARCH_INCLUDES        = YES
 181 INCLUDE_PATH           =
 182 INCLUDE_FILE_PATTERNS  =
 183 PREDEFINED             =
 184 EXPAND_AS_DEFINED      =
 185 SKIP_FUNCTION_MACROS   = YES
 186
 187 #---------------------------------------------------------------------------
 188 # Configuration options related to external references
 189 #---------------------------------------------------------------------------
 190
 191 TAGFILES               =
 192 GENERATE_TAGFILE       =
 193 ALLEXTERNALS           = NO
 194 EXTERNAL_GROUPS        = YES
 195 EXTERNAL_PAGES         = YES
 196 PERL_PATH              = /usr/bin/perl
 197
 198 #---------------------------------------------------------------------------
 199 # Configuration options related to the dot tool
 200 #---------------------------------------------------------------------------
 201
 202 CLASS_DIAGRAMS         = YES
 203 MSCGEN_PATH            =
 204 DIA_PATH               =
 205 HIDE_UNDOC_RELATIONS   = NO
 206 HAVE_DOT               = YES
 207 DOT_NUM_THREADS        = 0
 208 DOT_FONTNAME           = Helvetica
 209 DOT_FONTSIZE           = 10
 210 DOT_FONTPATH           =
 211 CLASS_GRAPH            = YES
 212 COLLABORATION_GRAPH    = YES
 213 GROUP_GRAPHS           = YES
 214 UML_LOOK               = YES
 215 UML_LIMIT_NUM_FIELDS   = 10
 216 TEMPLATE_RELATIONS     = NO
 217 INCLUDE_GRAPH          = YES
 218 INCLUDED_BY_GRAPH      = YES
 219 CALL_GRAPH             = YES
 220 CALLER_GRAPH           = YES
 221 GRAPHICAL_HIERARCHY    = YES
 222 DIRECTORY_GRAPH        = YES
 223 DOT_IMAGE_FORMAT       = svg
 224 INTERACTIVE_SVG        = YES
 225 DOT_PATH               =
 226 DOTFILE_DIRS           =
 227 MSCFILE_DIRS           =
 228 DIAFILE_DIRS           =
 229 DOT_GRAPH_MAX_NODES    = 50
 230 MAX_DOT_GRAPH_DEPTH    = 0
 231 DOT_TRANSPARENT        = YES
 232 DOT_MULTI_TARGETS      = YES
 233 GENERATE_LEGEND        = YES
 234 DOT_CLEANUP            = YES