doxyfile.in 9.45 KB
Newer Older
1 2 3 4 5 6 7 8
##============================================================================
##  Copyright (c) Kitware, Inc.
##  All rights reserved.
##  See LICENSE.txt for details.
##  This software is distributed WITHOUT ANY WARRANTY; without even
##  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
##  PURPOSE.  See the above copyright notice for more information.
##
9
##  Copyright 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
10 11 12
##  Copyright 2014 UT-Battelle, LLC.
##  Copyright 2014 Los Alamos National Security.
##
13
##  Under the terms of Contract DE-NA0003525 with NTESS,
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
##  the U.S. Government retains certain rights in this software.
##
##  Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
##  Laboratory (LANL), the U.S. Government retains certain rights in
##  this software.
##============================================================================

PROJECT_NAME           = "VTK-m"

PROJECT_NUMBER         = @VTKm_VERSION@

OUTPUT_DIRECTORY       = @VTKm_BINARY_DIR@/docs/doxygen/

CREATE_SUBDIRS         = NO

OUTPUT_LANGUAGE        = English

BRIEF_MEMBER_DESC      = YES

REPEAT_BRIEF           = YES

ABBREVIATE_BRIEF       =

ALWAYS_DETAILED_SEC    = NO

INLINE_INHERITED_MEMB  = NO

41
FULL_PATH_NAMES        = NO
42 43 44 45 46 47 48

STRIP_FROM_PATH        =

STRIP_FROM_INC_PATH    =

SHORT_NAMES            = NO

49 50
SHOW_NAMESPACES        = NO

51 52 53 54 55 56
JAVADOC_AUTOBRIEF      = YES

MULTILINE_CPP_IS_BRIEF = NO

INHERIT_DOCS           = YES

57
DISTRIBUTE_GROUP_DOC   = YES
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

TAB_SIZE               = 2

ALIASES                =

OPTIMIZE_OUTPUT_FOR_C  = NO

OPTIMIZE_OUTPUT_JAVA   = NO

SUBGROUPING            = YES

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

EXTRACT_ALL            = YES

EXTRACT_PRIVATE        = YES

EXTRACT_STATIC         = NO

EXTRACT_LOCAL_CLASSES  = NO

EXTRACT_LOCAL_METHODS  = NO

HIDE_UNDOC_MEMBERS     = NO

HIDE_UNDOC_CLASSES     = NO

HIDE_FRIEND_COMPOUNDS  = NO

HIDE_IN_BODY_DOCS      = NO

INTERNAL_DOCS          = NO

CASE_SENSE_NAMES       = YES

HIDE_SCOPE_NAMES       = NO

SHOW_INCLUDE_FILES     = YES

INLINE_INFO            = YES

SORT_MEMBER_DOCS       = YES

SORT_BRIEF_DOCS        = NO

SORT_BY_SCOPE_NAME     = NO

GENERATE_TODOLIST      = YES

GENERATE_TESTLIST      = YES

GENERATE_BUGLIST       = YES

GENERATE_DEPRECATEDLIST= YES

ENABLED_SECTIONS       =

MAX_INITIALIZER_LINES  = 30

SHOW_USED_FILES        = YES

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

QUIET                  = NO

WARNINGS               = YES

WARN_IF_UNDOCUMENTED   = YES

WARN_IF_DOC_ERROR      = YES

WARN_FORMAT            = "$file:$line: $text"

WARN_LOGFILE           =

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

141
INPUT                  = @VTKm_SOURCE_DIR@/README.md
142
INPUT                  += @VTKm_SOURCE_DIR@/CONTRIBUTING.md
143 144 145 146
INPUT                  += @VTKm_SOURCE_DIR@/docs/CodingConventions.md
INPUT                  += @VTKm_SOURCE_DIR@/vtkm

USE_MDFILE_AS_MAINPAGE = README.md
147

148
FILE_PATTERNS          = *.h
149 150 151

RECURSIVE              = YES

152
EXCLUDE                = @VTKm_SOURCE_DIR@/vtkm/testing/OptionParser.h
153
EXCLUDE                += @VTKm_SOURCE_DIR@/vtkm/exec/cuda/internal/ExecutionPolicy.h
154 155 156

EXCLUDE_SYMLINKS       = NO

157 158 159
EXCLUDE_PATTERNS       = */testing/*
EXCLUDE_PATTERNS       += */examples/*
EXCLUDE_PATTERNS       += UnitTest*
160 161
EXCLUDE_PATTERNS       += */vtkmdiy/fmt/*
EXCLUDE_PATTERNS       += */vtkmdiy/thread/*
162 163 164 165 166

EXCLUDE_SYMBOLS        = thrust
EXCLUDE_SYMBOLS        += detail
EXCLUDE_SYMBOLS        += placeholders
EXCLUDE_SYMBOLS        += benchmarking
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

EXAMPLE_PATH           =

EXAMPLE_PATTERNS       =

EXAMPLE_RECURSIVE      = NO

IMAGE_PATH             =

INPUT_FILTER           =

FILTER_PATTERNS        =

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

SOURCE_BROWSER         = NO

INLINE_SOURCES         = NO

STRIP_CODE_COMMENTS    = YES

192
REFERENCED_BY_RELATION = NO
193

194
REFERENCES_RELATION    = NO
195 196 197 198 199 200 201

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

202
ALPHABETICAL_INDEX     = YES
203

204
COLS_IN_ALPHA_INDEX    = 2
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

IGNORE_PREFIX          =

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

GENERATE_HTML          = YES

HTML_OUTPUT            = html

HTML_FILE_EXTENSION    = .html

HTML_HEADER            =

HTML_FOOTER            =

HTML_STYLESHEET        =

GENERATE_HTMLHELP      = NO

CHM_FILE               =

HHC_LOCATION           =

GENERATE_CHI           = NO

BINARY_TOC             = NO

TOC_EXPAND             = NO

DISABLE_INDEX          = NO

ENUM_VALUES_PER_LINE   = 4

240
GENERATE_TREEVIEW      = NO
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307

TREEVIEW_WIDTH         = 250

#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

GENERATE_LATEX         = NO

LATEX_OUTPUT           = latex

LATEX_CMD_NAME         = latex

MAKEINDEX_CMD_NAME     = makeindex

COMPACT_LATEX          = NO

PAPER_TYPE             = a4wide

EXTRA_PACKAGES         =

LATEX_HEADER           =

PDF_HYPERLINKS         = NO

USE_PDFLATEX           = NO

LATEX_BATCHMODE        = NO

LATEX_HIDE_INDICES     = NO

#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

GENERATE_RTF           = NO

RTF_OUTPUT             = rtf

COMPACT_RTF            = NO

RTF_HYPERLINKS         = NO

RTF_STYLESHEET_FILE    =

RTF_EXTENSIONS_FILE    =

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

GENERATE_MAN           = NO

MAN_OUTPUT             = man

MAN_EXTENSION          = .3

MAN_LINKS              = NO

#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------

GENERATE_XML           = NO

XML_OUTPUT             = xml

308
#XML_SCHEMA             =
309

310
#XML_DTD                =
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348

XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

GENERATE_PERLMOD       = NO

PERLMOD_LATEX          = NO

PERLMOD_PRETTY         = YES

PERLMOD_MAKEVAR_PREFIX =

#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------

ENABLE_PREPROCESSING   = YES

MACRO_EXPANSION        = NO

EXPAND_ONLY_PREDEF     = NO

SEARCH_INCLUDES        = YES

INCLUDE_PATH           = @VTKm_SOURCE_DIR@ @VTKm_BINARY_DIR@

INCLUDE_FILE_PATTERNS  =

PREDEFINED             = DOXYGEN
349
PREDEFINED             += VTKM_DOXYGEN_ONLY
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384

EXPAND_AS_DEFINED      =

SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------

TAGFILES               =

GENERATE_TAGFILE       =

ALLEXTERNALS           = NO

EXTERNAL_GROUPS        = YES

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------

CLASS_DIAGRAMS         = YES

HIDE_UNDOC_RELATIONS   = YES

HAVE_DOT               = @VTKm_DOXYGEN_HAVE_DOT@

CLASS_GRAPH            = YES

COLLABORATION_GRAPH    = YES

UML_LOOK               = NO

385
TEMPLATE_RELATIONS     = NO
386

387
INCLUDE_GRAPH          = YES
388

389
INCLUDED_BY_GRAPH      = YES
390 391 392

CALL_GRAPH             = NO

393
GRAPHICAL_HIERARCHY    = NO
394 395 396 397 398 399 400

DOT_IMAGE_FORMAT       = png

DOT_PATH               = @VTKm_DOXYGEN_DOT_PATH@

DOTFILE_DIRS           =

401 402 403
DOT_GRAPH_MAX_NODES    = 75

MAX_DOT_GRAPH_DEPTH    = 5
404 405 406 407 408 409 410 411 412 413

GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------

SEARCHENGINE           = NO