doxygen.config 27.4 KB
Newer Older
Will Schroeder's avatar
Will Schroeder committed
1 2 3 4 5 6 7 8 9 10 11 12 13
# Doxyfile 1.1.4-20000625

# This file describes the settings to be used by doxygen for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------

14 15
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
Will Schroeder's avatar
Will Schroeder committed
16 17 18

PROJECT_NAME          = CMAKE

19 20
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
Will Schroeder's avatar
Will Schroeder committed
21 22 23 24
# if some version control system is used.

PROJECT_NUMBER        = 0.0.1

25 26 27
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
Will Schroeder's avatar
Will Schroeder committed
28 29 30 31
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY      = ./Doxygen

32 33 34 35 36
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,
Will Schroeder's avatar
Will Schroeder committed
37 38 39 40
# Spanish and Russian

OUTPUT_LANGUAGE       = English

41 42 43
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
Will Schroeder's avatar
Will Schroeder committed
44 45 46

DISABLE_INDEX         = NO

47 48 49 50
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
Will Schroeder's avatar
Will Schroeder committed
51 52 53

EXTRACT_ALL           = YES

54 55
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
Will Schroeder's avatar
Will Schroeder committed
56 57 58

EXTRACT_PRIVATE       = NO

59 60
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
Will Schroeder's avatar
Will Schroeder committed
61 62 63

EXTRACT_STATIC        = YES

64 65 66 67 68
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
Will Schroeder's avatar
Will Schroeder committed
69 70 71

HIDE_UNDOC_MEMBERS    = NO

72 73 74 75
# If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these class will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
Will Schroeder's avatar
Will Schroeder committed
76 77 78

HIDE_UNDOC_CLASSES    = NO

79 80 81 82
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
Will Schroeder's avatar
Will Schroeder committed
83 84 85

BRIEF_MEMBER_DESC     = YES

86 87 88 89
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
Will Schroeder's avatar
Will Schroeder committed
90 91 92

REPEAT_BRIEF          = YES

93 94 95
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
# description.
Will Schroeder's avatar
Will Schroeder committed
96 97 98

ALWAYS_DETAILED_SEC   = NO

99 100 101
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
Will Schroeder's avatar
Will Schroeder committed
102 103 104

FULL_PATH_NAMES       = NO

105 106 107 108
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path.
Will Schroeder's avatar
Will Schroeder committed
109

110
STRIP_FROM_PATH       =
Will Schroeder's avatar
Will Schroeder committed
111

112 113 114 115
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
Will Schroeder's avatar
Will Schroeder committed
116 117 118

INTERNAL_DOCS         = NO

119 120 121
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a class diagram (in Html and LaTeX) for classes with base or
# super classes. Setting the tag to NO turns the diagrams off.
Will Schroeder's avatar
Will Schroeder committed
122 123 124

CLASS_DIAGRAMS        = YES

125 126
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
Will Schroeder's avatar
Will Schroeder committed
127 128 129

SOURCE_BROWSER        = YES

130 131
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
Will Schroeder's avatar
Will Schroeder committed
132 133 134

INLINE_SOURCES        = NO

135 136 137
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
Will Schroeder's avatar
Will Schroeder committed
138 139 140

STRIP_CODE_COMMENTS   = YES

141 142 143 144 145
# If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
# will only generate file names in lower case letters. If set to
# YES upper case letters are also allowed. This is useful if you have
# classes or files whose names only differ in case and if your file system
# supports case sensitive file names.
Will Schroeder's avatar
Will Schroeder committed
146 147 148

CASE_SENSE_NAMES      = YES

149 150 151
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
Will Schroeder's avatar
Will Schroeder committed
152 153 154

HIDE_SCOPE_NAMES      = NO

155 156 157
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
Will Schroeder's avatar
Will Schroeder committed
158 159 160

VERBATIM_HEADERS      = YES

161 162 163
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put list of the files that are included by a file in the documentation
# of that file.
Will Schroeder's avatar
Will Schroeder committed
164 165 166

SHOW_INCLUDE_FILES    = YES

167 168 169 170
# If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the Javadoc-style will
# behave just like the Qt-style comments.
Will Schroeder's avatar
Will Schroeder committed
171 172 173

JAVADOC_AUTOBRIEF     = NO

174 175 176
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# reimplements.
Will Schroeder's avatar
Will Schroeder committed
177 178 179

INHERIT_DOCS          = YES

180 181
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
Will Schroeder's avatar
Will Schroeder committed
182 183 184

INLINE_INFO           = YES

185 186 187 188
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
Will Schroeder's avatar
Will Schroeder committed
189 190 191

SORT_MEMBER_DOCS      = YES

192 193
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
Will Schroeder's avatar
Will Schroeder committed
194 195 196

TAB_SIZE              = 8

197 198
# The ENABLE_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
Will Schroeder's avatar
Will Schroeder committed
199

200
ENABLED_SECTIONS      =
Will Schroeder's avatar
Will Schroeder committed
201 202 203 204 205

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

206 207
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
Will Schroeder's avatar
Will Schroeder committed
208 209 210

QUIET                 = NO

211 212 213
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
Will Schroeder's avatar
Will Schroeder committed
214 215 216

WARNINGS              = YES

217 218 219
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
Will Schroeder's avatar
Will Schroeder committed
220 221 222

WARN_IF_UNDOCUMENTED  = YES

223 224 225 226
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text.
Will Schroeder's avatar
Will Schroeder committed
227 228 229 230 231 232 233

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

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

234 235 236 237
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
Will Schroeder's avatar
Will Schroeder committed
238

239
INPUT                 = "Source"
Will Schroeder's avatar
Will Schroeder committed
240

241 242 243 244
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
Will Schroeder's avatar
Will Schroeder committed
245 246 247

FILE_PATTERNS         = *.h *.txx *.cxx

248 249 250
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
Will Schroeder's avatar
Will Schroeder committed
251 252 253

RECURSIVE             = YES

254 255 256
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
Will Schroeder's avatar
Will Schroeder committed
257

258
EXCLUDE               =
Will Schroeder's avatar
Will Schroeder committed
259

260 261 262
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
Will Schroeder's avatar
Will Schroeder committed
263

264
EXCLUDE_PATTERNS      =
Will Schroeder's avatar
Will Schroeder committed
265

266 267 268
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
Will Schroeder's avatar
Will Schroeder committed
269

270
EXAMPLE_PATH          =
Will Schroeder's avatar
Will Schroeder committed
271

272 273 274 275
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
Will Schroeder's avatar
Will Schroeder committed
276

277
EXAMPLE_PATTERNS      =
Will Schroeder's avatar
Will Schroeder committed
278

279 280 281
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
Will Schroeder's avatar
Will Schroeder committed
282

283
IMAGE_PATH            =
Will Schroeder's avatar
Will Schroeder committed
284

285 286 287 288 289 290 291 292
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.

INPUT_FILTER          =
Will Schroeder's avatar
Will Schroeder committed
293 294 295 296 297

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

298 299 300
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
Will Schroeder's avatar
Will Schroeder committed
301 302 303

ALPHABETICAL_INDEX    = YES

304 305 306
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
Will Schroeder's avatar
Will Schroeder committed
307 308 309

COLS_IN_ALPHA_INDEX   = 3

310 311 312 313
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
Will Schroeder's avatar
Will Schroeder committed
314

315
IGNORE_PREFIX         =
Will Schroeder's avatar
Will Schroeder committed
316 317 318 319 320

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

321 322
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
Will Schroeder's avatar
Will Schroeder committed
323 324 325

GENERATE_HTML         = YES

326 327 328
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
Will Schroeder's avatar
Will Schroeder committed
329 330 331

HTML_OUTPUT           = html

332 333
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
Will Schroeder's avatar
Will Schroeder committed
334 335
# standard header.

336
HTML_HEADER           =
Will Schroeder's avatar
Will Schroeder committed
337

338 339
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
Will Schroeder's avatar
Will Schroeder committed
340 341
# standard footer.

342
HTML_FOOTER           =
Will Schroeder's avatar
Will Schroeder committed
343

344 345 346 347
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet
Will Schroeder's avatar
Will Schroeder committed
348

349
HTML_STYLESHEET       =
Will Schroeder's avatar
Will Schroeder committed
350

351 352 353
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
Will Schroeder's avatar
Will Schroeder committed
354 355 356

HTML_ALIGN_MEMBERS    = YES

357 358 359 360
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
# of the generated HTML documentation.
Will Schroeder's avatar
Will Schroeder committed
361 362 363 364 365 366 367

GENERATE_HTMLHELP     = NO

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

368 369
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
Will Schroeder's avatar
Will Schroeder committed
370 371 372

GENERATE_LATEX        = YES

373 374 375
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
Will Schroeder's avatar
Will Schroeder committed
376 377 378

LATEX_OUTPUT          = latex

379 380 381
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
Will Schroeder's avatar
Will Schroeder committed
382 383 384

COMPACT_LATEX         = NO

385 386 387
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
Will Schroeder's avatar
Will Schroeder committed
388 389 390

PAPER_TYPE            = a4wide

391 392
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
Will Schroeder's avatar
Will Schroeder committed
393

394
EXTRA_PACKAGES        =
Will Schroeder's avatar
Will Schroeder committed
395

396 397 398 399
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
Will Schroeder's avatar
Will Schroeder committed
400

401
LATEX_HEADER          =
Will Schroeder's avatar
Will Schroeder committed
402

403 404 405 406
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
Will Schroeder's avatar
Will Schroeder committed
407 408 409

PDF_HYPERLINKS        = NO

410 411 412 413
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
Will Schroeder's avatar
Will Schroeder committed
414 415 416 417 418 419 420

LATEX_BATCHMODE       = NO

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

421 422 423
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# For now this is experimental and is disabled by default. The RTF output
# is optimised for Word 97 and may not look too pretty with other readers
Will Schroeder's avatar
Will Schroeder committed
424 425 426 427
# or editors.

GENERATE_RTF          = YES

428 429 430
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `rtf' will be used as the default path.
Will Schroeder's avatar
Will Schroeder committed
431 432 433

RTF_OUTPUT            = rtf

434 435 436
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
# save some trees in general.
Will Schroeder's avatar
Will Schroeder committed
437 438 439

COMPACT_RTF           = NO

440 441 442 443 444 445
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using a WORD or other.
# programs which support those fields.
# Note: wordpad (write) and others do not support links.
Will Schroeder's avatar
Will Schroeder committed
446 447 448 449 450 451 452

RTF_HYPERLINKS        = NO

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

453 454
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
Will Schroeder's avatar
Will Schroeder committed
455 456 457

GENERATE_MAN          = YES

458 459 460
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
Will Schroeder's avatar
Will Schroeder committed
461 462 463

MAN_OUTPUT            = man

464 465
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
Will Schroeder's avatar
Will Schroeder committed
466 467 468 469

MAN_EXTENSION         = .3

#---------------------------------------------------------------------------
470
# Configuration options related to the preprocessor
Will Schroeder's avatar
Will Schroeder committed
471 472
#---------------------------------------------------------------------------

473 474 475
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
# files.
Will Schroeder's avatar
Will Schroeder committed
476 477 478

ENABLE_PREPROCESSING  = YES

479 480 481
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed.
Will Schroeder's avatar
Will Schroeder committed
482 483 484

MACRO_EXPANSION       = YES

485 486
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
Will Schroeder's avatar
Will Schroeder committed
487 488 489

SEARCH_INCLUDES       = NO

490 491 492
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
Will Schroeder's avatar
Will Schroeder committed
493

494
INCLUDE_PATH          =
Will Schroeder's avatar
Will Schroeder committed
495

496 497 498 499 500
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed.
Will Schroeder's avatar
Will Schroeder committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

PREDEFINED  =  "itkNotUsed(x)="\
               "itkSetMacro(name,type)= \
                  virtual void Set##name (type _arg);" \
               "itkGetMacro(name,type)= \
                  virtual type Get##name ();" \
               "itkGetConstMacro(name,type)= \
                  virtual type Get##name () const;" \
               "itkSetStringMacro(name)= \
                  virtual void Set##name (const char* _arg);" \
               "itkGetStringMacro(name)= \
                  virtual const char* Get##name () const;" \
               "itkSetClampMacro(name,type,min,max)= \
                  virtual void Set##name (type _arg);" \
               "itkSetObjectMacro(name,type)= \
                  virtual void Set##name (type* _arg);" \
               "itkGetObjectMacro(name,type)= \
                  virtual type* Get##name ();" \
               "itkBooleanMacro(name)= \
                  virtual void name##On (); \
                  virtual void name##Off ();" \
               "itkSetVector2Macro(name,type)= \
                  virtual void Set##name (type _arg1, type _arg2) \
                  virtual void Set##name (type _arg[2]);" \
               "itkGetVector2Macro(name,type)= \
                  virtual type* Get##name () const; \
                  virtual void Get##name (type& _arg1, type& _arg2) const; \
                  virtual void Get##name (type _arg[2]) const;" \
               "itkSetVector3Macro(name,type)= \
                  virtual void Set##name (type _arg1, type _arg2, type _arg3) \
                  virtual void Set##name (type _arg[3]);" \
               "itkGetVector3Macro(name,type)= \
                  virtual type* Get##name () const; \
                  virtual void Get##name (type& _arg1, type& _arg2, type& _arg3) const; \
                  virtual void Get##name (type _arg[3]) const;" \
               "itkSetVector4Macro(name,type)= \
                  virtual void Set##name (type _arg1, type _arg2, type _arg3, type _arg4) \
                  virtual void Set##name (type _arg[4]);" \
               "itkGetVector4Macro(name,type)= \
                  virtual type* Get##name () const; \
                  virtual void Get##name (type& _arg1, type& _arg2, type& _arg3, type& _arg4) const; \
                  virtual void Get##name (type _arg[4]) const;" \
               "itkSetVector6Macro(name,type)= \
                  virtual void Set##name (type _arg1, type _arg2, type _arg3, type _arg4, type _arg5, type _arg6) \
                  virtual void Set##name (type _arg[6]);" \
               "itkGetVector6Macro(name,type)= \
                  virtual type* Get##name () const; \
                  virtual void Get##name (type& _arg1, type& _arg2, type& _arg3, type& _arg4, type& _arg5, type& _arg6) const; \
                  virtual void Get##name (type _arg[6]) const;" \
               "itkSetVectorMacro(name,type,count)= \
                  virtual void Set##name(type data[]);" \
               "itkGetVectorMacro(name,type,count)= \
                  virtual type* Get##name () const;" \
               "itkNewMacro(type)= \
                  static Pointer New();" \
               "itkTypeMacro(thisClass,superclass)= \
                  virtual const char *GetClassName() const;" \
               "ITK_NUMERIC_LIMITS= \
                  std::numeric_limits"

561 562 563
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED tag.
Will Schroeder's avatar
Will Schroeder committed
564 565 566 567

EXPAND_ONLY_PREDEF    = YES

#---------------------------------------------------------------------------
568
# Configuration::addtions related to external references
Will Schroeder's avatar
Will Schroeder committed
569 570
#---------------------------------------------------------------------------

571
# The TAGFILES tag can be used to specify one or more tagfiles.
Will Schroeder's avatar
Will Schroeder committed
572

573
TAGFILES              =
Will Schroeder's avatar
Will Schroeder committed
574

575 576
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
Will Schroeder's avatar
Will Schroeder committed
577

578
GENERATE_TAGFILE      =
Will Schroeder's avatar
Will Schroeder committed
579

580 581 582
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
Will Schroeder's avatar
Will Schroeder committed
583 584 585

ALLEXTERNALS          = NO

586 587
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
Will Schroeder's avatar
Will Schroeder committed
588 589 590 591

PERL_PATH             = /usr/bin/perl

#---------------------------------------------------------------------------
592
# Configuration options related to the dot tool
Will Schroeder's avatar
Will Schroeder committed
593 594
#---------------------------------------------------------------------------

595 596 597 598
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
Will Schroeder's avatar
Will Schroeder committed
599 600 601

HAVE_DOT              = YES

602 603 604
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
Will Schroeder's avatar
Will Schroeder committed
605 606 607 608
# the CLASS_DIAGRAMS tag to NO.

CLASS_GRAPH           = YES

609 610 611 612
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
Will Schroeder's avatar
Will Schroeder committed
613 614 615

COLLABORATION_GRAPH   = YES

616 617 618 619
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
# YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other
# documented files.
Will Schroeder's avatar
Will Schroeder committed
620 621 622

INCLUDE_GRAPH         = YES

623 624 625
# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
# YES then doxygen will generate a graph for each documented header file showing
# the documented files that directly or indirectly include this file
Will Schroeder's avatar
Will Schroeder committed
626 627 628

INCLUDED_BY_GRAPH     = YES

629 630
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
Will Schroeder's avatar
Will Schroeder committed
631 632 633

GRAPHICAL_HIERARCHY   = YES

634 635
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found on the path.
Will Schroeder's avatar
Will Schroeder committed
636 637 638

DOT_PATH              =

639 640 641 642 643
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
Will Schroeder's avatar
Will Schroeder committed
644 645 646

MAX_DOT_GRAPH_WIDTH   = 1024

647 648 649 650 651
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
Will Schroeder's avatar
Will Schroeder committed
652 653 654 655

MAX_DOT_GRAPH_HEIGHT  = 1024

#---------------------------------------------------------------------------
656
# Configuration::addtions related to the search engine
Will Schroeder's avatar
Will Schroeder committed
657 658
#---------------------------------------------------------------------------

659 660
# The SEARCHENGINE tag specifies whether or not a search engine should be
# used. If set to NO the values of all tags below this one will be ignored.
Will Schroeder's avatar
Will Schroeder committed
661 662 663

SEARCHENGINE          = NO

664 665 666
# The CGI_NAME tag should be the name of the CGI script that
# starts the search engine (doxysearch) with the correct parameters.
# A script with this name will be generated by doxygen.
Will Schroeder's avatar
Will Schroeder committed
667 668 669

CGI_NAME              = search.cgi

670 671 672
# The CGI_URL tag should be the absolute URL to the directory where the
# cgi binaries are located. See the documentation of your http daemon for
# details.
Will Schroeder's avatar
Will Schroeder committed
673

674
CGI_URL               =
Will Schroeder's avatar
Will Schroeder committed
675

676 677 678
# The DOC_URL tag should be the absolute URL to the directory where the
# documentation is located. If left blank the absolute path to the
# documentation, with file:// prepended to it, will be used.
Will Schroeder's avatar
Will Schroeder committed
679

680
DOC_URL               =
Will Schroeder's avatar
Will Schroeder committed
681

682 683 684
# The DOC_ABSPATH tag should be the absolute path to the directory where the
# documentation is located. If left blank the directory on the local machine
# will be used.
Will Schroeder's avatar
Will Schroeder committed
685

686
DOC_ABSPATH           =
Will Schroeder's avatar
Will Schroeder committed
687

688 689
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
# is installed.
Will Schroeder's avatar
Will Schroeder committed
690 691 692

BIN_ABSPATH           = /usr/local/bin/

693 694 695
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
# documentation generated for other projects. This allows doxysearch to search
# the documentation for these projects as well.
Will Schroeder's avatar
Will Schroeder committed
696

697
EXT_DOC_PATHS         =