Doxyfile.in 13.9 KB
Newer Older
1
# Copyright (c) 2014-2016, Siemens AG. All rights reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

# ==============================================================================
# Project related options
# ==============================================================================

DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "Embedded Multicore Building Blocks V@EMBB_BASE_VERSION_MAJOR@.@EMBB_BASE_VERSION_MINOR@.@EMBB_BASE_VERSION_PATCH@"
31 32 33 34
PROJECT_NUMBER         =
PROJECT_BRIEF          =
PROJECT_LOGO           =
OUTPUT_DIRECTORY       =
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the
ALWAYS_DETAILED_SEC    = YES
INLINE_INHERITED_MEMB  = YES
FULL_PATH_NAMES        = YES
STRIP_FROM_PATH        = "@CMAKE_SOURCE_DIR@"
54
STRIP_FROM_INC_PATH    =
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = YES
QT_AUTOBRIEF           = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 3
ALIASES                = "notthreadsafe=\par Concurrency\nNot thread-safe\n" \
                         "threadsafe=\par Concurrency\nThread-safe\n" \
                         "lockfree=\par Concurrency\nThread-safe and lock-free\n" \
                         "waitfree=\par Concurrency\nThread-safe and wait-free\n" \
                         "memory=\par Dynamic memory allocation\n" \
                         "pre=\par Precondition\n" \
                         "post=\par Postcondition\n" \
                         "note=\par Note\n" \
                         "concept{1}=@ingroup \1\n@par Implemented concepts:\n@ref \1"
71
TCL_SUBST              =
72 73 74 75
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
76
EXTENSION_MAPPING      =
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
MARKDOWN_SUPPORT       = YES
AUTOLINK_SUPPORT       = YES
BUILTIN_STL_SUPPORT    = NO
CPP_CLI_SUPPORT        = NO
SIP_SUPPORT            = NO
IDL_PROPERTY_SUPPORT   = YES
DISTRIBUTE_GROUP_DOC   = YES
SUBGROUPING            = YES
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS  = NO
TYPEDEF_HIDES_STRUCT   = NO
LOOKUP_CACHE_SIZE      = 0

# ==============================================================================
# Build related options
# ==============================================================================

EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_PACKAGE        = NO
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = YES
HIDE_FRIEND_COMPOUNDS  = YES
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = YES
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
SHOW_GROUPED_MEMB_INC  = NO
FORCE_LOCAL_INCLUDES   = NO
INLINE_INFO            = NO
SORT_MEMBER_DOCS       = NO
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
STRICT_PROTO_MATCHING  = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
122
ENABLED_SECTIONS       =
123 124 125 126
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = NO
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES
127
FILE_VERSION_FILTER    =
128
LAYOUT_FILE            = "@CMAKE_SOURCE_DIR@/doc/reference/DoxygenLayout.xml"
129
CITE_BIB_FILES         =
130 131 132 133 134 135 136 137 138 139 140

# ==============================================================================
# Options related to warning and progress messages
# ==============================================================================

QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = YES
WARN_FORMAT            = "$file:$line: $text"
141
WARN_LOGFILE           =
142 143 144 145 146 147 148 149 150

# ==============================================================================
# Options related to input files
# ==============================================================================

INPUT                  = "@CMAKE_SOURCE_DIR@/doc/reference/embb.dox" \
                         "@CMAKE_SOURCE_DIR@/containers_cpp/include" \
                         "@CMAKE_SOURCE_DIR@/dataflow_cpp/include" \
                         "@CMAKE_SOURCE_DIR@/algorithms_cpp/include" \
151
                         "@CMAKE_SOURCE_DIR@/tasks_cpp/include" \
152 153 154
                         "@CMAKE_SOURCE_DIR@/mtapi_cpp/include" \
                         "@CMAKE_SOURCE_DIR@/base_cpp/include" \
                         "@CMAKE_SOURCE_DIR@/mtapi_c/include" \
155
                         "@CMAKE_SOURCE_DIR@/base_c/include" \
156
                         "@CMAKE_SOURCE_DIR@/mtapi_plugins_c/mtapi_opencl_c/include" \
157 158
                         "@CMAKE_SOURCE_DIR@/mtapi_plugins_c/mtapi_network_c/include" \
                         "@CMAKE_SOURCE_DIR@/mtapi_plugins_c/mtapi_cuda_c/include"
159

160 161 162 163 164 165
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          = *.h \
                         *.cc \
                         *.c \
                         *.dox
RECURSIVE              = YES
166
EXCLUDE                =
167 168 169 170 171
EXCLUDE_SYMLINKS       = NO
EXCLUDE_PATTERNS       = */test/* \
                         */internal/*
EXCLUDE_SYMBOLS        = *test* \
                         *::internal::*
172
EXAMPLE_PATH           =
173 174
EXAMPLE_PATTERNS       = *
EXAMPLE_RECURSIVE      = NO
175
IMAGE_PATH             = "@CMAKE_SOURCE_DIR@/doc"
176 177
INPUT_FILTER           =
FILTER_PATTERNS        =
178
FILTER_SOURCE_FILES    = NO
179 180
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

# ==============================================================================
# Options related to source browsing
# ==============================================================================

SOURCE_BROWSER         = NO
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION    = NO
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS        = YES
USE_HTAGS              = NO
VERBATIM_HEADERS       = YES

# ==============================================================================
# Options related to alphabetical class index
# ==============================================================================

ALPHABETICAL_INDEX     = YES
COLS_IN_ALPHA_INDEX    = 3
IGNORE_PREFIX          = cm

# ==============================================================================
# Options related to HTML output
# ==============================================================================

GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
211 212
HTML_FOOTER            =
HTML_STYLESHEET        =
213
HTML_EXTRA_STYLESHEET  = "@CMAKE_SOURCE_DIR@/doc/reference/DoxygenHTMLStyle.css"
214
HTML_EXTRA_FILES       =
215 216 217 218 219 220 221 222 223 224 225 226
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80
HTML_TIMESTAMP         = YES
HTML_DYNAMIC_SECTIONS  = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET        = NO
DOCSET_FEEDNAME        = "Doxygen generated docs"
DOCSET_BUNDLE_ID       = org.doxygen.Project
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME  = Publisher
GENERATE_HTMLHELP      = NO
227 228
CHM_FILE               =
HHC_LOCATION           =
229
GENERATE_CHI           = NO
230
CHM_INDEX_ENCODING     =
231 232 233
BINARY_TOC             = NO
TOC_EXPAND             = NO
GENERATE_QHP           = NO
234
QCH_FILE               =
235 236
QHP_NAMESPACE          = org.doxygen.Project
QHP_VIRTUAL_FOLDER     = doc
237 238 239 240
QHP_CUST_FILTER_NAME   =
QHP_CUST_FILTER_ATTRS  =
QHP_SECT_FILTER_ATTRS  =
QHG_LOCATION           =
241 242 243 244 245 246 247 248 249 250 251 252
GENERATE_ECLIPSEHELP   = NO
ECLIPSE_DOC_ID         = org.doxygen.Project
DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = NO
ENUM_VALUES_PER_LINE   = 4
TREEVIEW_WIDTH         = 250
EXT_LINKS_IN_WINDOW    = NO
FORMULA_FONTSIZE       = 10
FORMULA_TRANSPARENT    = YES
USE_MATHJAX            = NO
MATHJAX_FORMAT         = HTML-CSS
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
253 254
MATHJAX_EXTENSIONS     =
MATHJAX_CODEFILE       =
255 256 257
SEARCHENGINE           = YES
SERVER_BASED_SEARCH    = NO
EXTERNAL_SEARCH        = NO
258
SEARCHENGINE_URL       =
259
SEARCHDATA_FILE        = searchdata.xml
260 261
EXTERNAL_SEARCH_ID     =
EXTRA_SEARCH_MAPPINGS  =
262 263 264 265 266 267 268 269 270 271 272

# ==============================================================================
# Options related to LaTeX output
# ==============================================================================

GENERATE_LATEX         = YES
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = a4
273 274 275 276
EXTRA_PACKAGES         =
LATEX_HEADER           =
LATEX_FOOTER           =
LATEX_EXTRA_FILES      =
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
LATEX_SOURCE_CODE      = NO
LATEX_BIB_STYLE        = plain

# ==============================================================================
# Options related to RTF output
# ==============================================================================

GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
292 293
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

# ==============================================================================
# Options related to man page output
# ==============================================================================

GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
MAN_LINKS              = NO

# ==============================================================================
# Options related to XML output
# ==============================================================================

GENERATE_XML           = NO
XML_OUTPUT             = xml
XML_PROGRAMLISTING     = YES

# ==============================================================================
# Options related to DOCBOOK output
# ==============================================================================

GENERATE_DOCBOOK       = NO
DOCBOOK_OUTPUT         = docbook

# ==============================================================================
# Options for the AutoGen Definitions output
# ==============================================================================

GENERATE_AUTOGEN_DEF   = NO

# ==============================================================================
# Options related to Perl module output
# ==============================================================================

GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
332
PERLMOD_MAKEVAR_PREFIX =
333 334 335 336 337 338 339 340 341

# ==============================================================================
# Options related to preprocessor
# ==============================================================================

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
342 343
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
344 345
PREDEFINED             = protected=private \
                         DOXYGEN
346
EXPAND_AS_DEFINED      =
347 348 349 350 351 352
SKIP_FUNCTION_MACROS   = YES

# ==============================================================================
# Options related to external references
# ==============================================================================

353 354
TAGFILES               =
GENERATE_TAGFILE       =
355 356 357 358 359 360 361 362 363 364
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
EXTERNAL_PAGES         = NO
PERL_PATH              = /usr/bin/perl

# ==============================================================================
# Options related to dot tool
# ==============================================================================

CLASS_DIAGRAMS         = NO
365 366
MSCGEN_PATH            =
DIA_PATH               =
367 368 369 370 371
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = NO
DOT_NUM_THREADS        = 0
DOT_FONTNAME           = Helvetica
DOT_FONTSIZE           = 10
372
DOT_FONTPATH           =
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
CLASS_GRAPH            = NO
COLLABORATION_GRAPH    = NO
GROUP_GRAPHS           = YES
UML_LOOK               = NO
UML_LIMIT_NUM_FIELDS   = 10
TEMPLATE_RELATIONS     = YES
INCLUDE_GRAPH          = NO
INCLUDED_BY_GRAPH      = NO
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = NO
DIRECTORY_GRAPH        = YES
DOT_IMAGE_FORMAT       = png
INTERACTIVE_SVG        = NO
DOT_PATH               = @DOT_PATH@
388 389 390
DOTFILE_DIRS           =
MSCFILE_DIRS           =
DIAFILE_DIRS           =
391 392 393 394 395 396
DOT_GRAPH_MAX_NODES    = 50
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES