3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16 # This tag specifies the encoding used for all characters in the config file that
17 # follow. The default is UTF-8 which is also the encoding used for all text before
18 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
19 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
22 DOXYFILE_ENCODING = UTF-8
24 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
25 # by quotes) that should identify the project.
29 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
30 # This could be handy for archiving the generated documentation or
31 # if some version control system is used.
33 PROJECT_NUMBER = @GDCM_MAJOR_VERSION@.@GDCM_MINOR_VERSION@.@GDCM_BUILD_VERSION@
35 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
36 # base path where the generated documentation will be put.
37 # If a relative path is entered, it will be relative to the location
38 # where doxygen was started. If left blank the current directory will be used.
40 OUTPUT_DIRECTORY = @GDCM_BINARY_DIR@/Doc/
42 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
43 # 4096 sub-directories (in 2 levels) under the output directory of each output
44 # format and will distribute the generated files over these directories.
45 # Enabling this option can be useful when feeding doxygen a huge amount of
46 # source files, where putting all generated files in the same directory would
47 # otherwise cause performance problems for the file system.
51 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
52 # documentation generated by doxygen is written. Doxygen will use this
53 # information to generate all constant output in the proper language.
54 # The default language is English, other supported languages are:
55 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
56 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
57 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
58 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
59 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
61 OUTPUT_LANGUAGE = English
62 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
63 # include brief member descriptions after the members that are listed in
64 # the file and class documentation (similar to JavaDoc).
65 # Set to NO to disable this.
67 BRIEF_MEMBER_DESC = YES
69 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
70 # the brief description of a member or function before the detailed description.
71 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
72 # brief descriptions will be completely suppressed.
76 # This tag implements a quasi-intelligent brief description abbreviator
77 # that is used to form the text in various listings. Each string
78 # in this list, if found as the leading text of the brief description, will be
79 # stripped from the text and the result after processing the whole list, is
80 # used as the annotated text. Otherwise, the brief description is used as-is.
81 # If left blank, the following values are used ("$name" is automatically
82 # replaced with the name of the entity): "The $name class" "The $name widget"
83 # "The $name file" "is" "provides" "specifies" "contains"
84 # "represents" "a" "an" "the"
88 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
89 # Doxygen will generate a detailed section even if there is only a brief
92 ALWAYS_DETAILED_SEC = NO
94 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
95 # inherited members of a class in the documentation of that class as if those
96 # members were ordinary class members. Constructors, destructors and assignment
97 # operators of the base classes will not be shown.
99 INLINE_INHERITED_MEMB = YES
101 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
102 # path before files name in the file list and in the header files. If set
103 # to NO the shortest path that makes the file name unique will be used.
107 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
108 # can be used to strip a user-defined part of the path. Stripping is
109 # only done if one of the specified strings matches the left-hand part of
110 # the path. The tag can be used to show relative paths in the file list.
111 # If left blank the directory from which doxygen is run is used as the
116 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
117 # the path mentioned in the documentation of a class, which tells
118 # the reader which header file to include in order to use a class.
119 # If left blank only the name of the header file containing the class
120 # definition is used. Otherwise one should specify the include paths that
121 # are normally passed to the compiler using the -I flag.
123 STRIP_FROM_INC_PATH =
125 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
126 # (but less readable) file names. This can be useful is your file systems
127 # doesn't support long names like on DOS, Mac, or CD-ROM.
131 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
132 # will interpret the first line (until the first dot) of a JavaDoc-style
133 # comment as the brief description. If set to NO, the JavaDoc
134 # comments will behave just like the Qt-style comments (thus requiring an
135 # explicit @brief command for a brief description.
137 JAVADOC_AUTOBRIEF = NO
139 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
140 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
141 # comments) as a brief description. This used to be the default behaviour.
142 # The new default is to treat a multi-line C++ comment block as a detailed
143 # description. Set this tag to YES if you prefer the old behaviour instead.
145 MULTILINE_CPP_IS_BRIEF = NO
147 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
148 # will output the detailed description near the top, like JavaDoc.
149 # If set to NO, the detailed description appears after the member
154 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
155 # member inherits the documentation from any documented member that it
160 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
161 # a new page for each member. If set to NO, the documentation of a member will
162 # be part of the file/class/namespace that contains it.
164 SEPARATE_MEMBER_PAGES = NO
166 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
167 # Doxygen uses this value to replace tabs by spaces in code fragments.
171 # This tag can be used to specify a number of aliases that acts
172 # as commands in the documentation. An alias has the form "name=value".
173 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
174 # put the command \sideeffect (or @sideeffect) in the documentation, which
175 # will result in a user-defined paragraph with heading "Side Effects:".
176 # You can put \n's in the value part of an alias to insert newlines.
180 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
181 # sources only. Doxygen will then generate output that is more tailored for C.
182 # For instance, some of the names that are used will be different. The list
183 # of all members will be omitted, etc.
185 OPTIMIZE_OUTPUT_FOR_C = NO
187 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
188 # sources only. Doxygen will then generate output that is more tailored for Java.
189 # For instance, namespaces will be presented as packages, qualified scopes
190 # will look different, etc.
192 OPTIMIZE_OUTPUT_JAVA = NO
194 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
195 # include (a tag file for) the STL sources as input, then you should
196 # set this tag to YES in order to let doxygen match functions declarations and
197 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
198 # func(std::string) {}). This also make the inheritance and collaboration
199 # diagrams that involve STL classes more complete and accurate.
201 BUILTIN_STL_SUPPORT = NO
203 # If you use Microsoft's C++/CLI language, you should set this option to YES to
204 # enable parsing support.
208 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
209 # tag is set to YES, then doxygen will reuse the documentation of the first
210 # member in the group (if any) for the other members of the group. By default
211 # all members of a group must be documented explicitly.
213 DISTRIBUTE_GROUP_DOC = NO
215 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
216 # the same type (for instance a group of public functions) to be put as a
217 # subgroup of that type (e.g. under the Public Functions section). Set it to
218 # NO to prevent subgrouping. Alternatively, this can be done per class using
219 # the \nosubgrouping command.
223 #---------------------------------------------------------------------------
224 # Build related configuration options
225 #---------------------------------------------------------------------------
227 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
228 # documentation are documented, even if no documentation was available.
229 # Private class members and static file members will be hidden unless
230 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
234 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
235 # will be included in the documentation.
237 EXTRACT_PRIVATE = YES
239 # If the EXTRACT_STATIC tag is set to YES all static members of a file
240 # will be included in the documentation.
244 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
245 # defined locally in source files will be included in the documentation.
246 # If set to NO only classes defined in header files are included.
248 EXTRACT_LOCAL_CLASSES = YES
249 # This flag is only useful for Objective-C code. When set to YES local
250 # methods, which are defined in the implementation section but not in
251 # the interface are included in the documentation.
252 # If set to NO (the default) only methods in the interface are included.
254 EXTRACT_LOCAL_METHODS = NO
256 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
257 # undocumented members of documented classes, files or namespaces.
258 # If set to NO (the default) these members will be included in the
259 # various overviews, but no documentation section is generated.
260 # This option has no effect if EXTRACT_ALL is enabled.
262 HIDE_UNDOC_MEMBERS = NO
264 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
265 # undocumented classes that are normally visible in the class hierarchy.
266 # If set to NO (the default) these classes will be included in the various
267 # overviews. This option has no effect if EXTRACT_ALL is enabled.
269 HIDE_UNDOC_CLASSES = NO
271 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
272 # friend (class|struct|union) declarations.
273 # If set to NO (the default) these declarations will be included in the
276 HIDE_FRIEND_COMPOUNDS = NO
278 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
279 # documentation blocks found inside the body of a function.
280 # If set to NO (the default) these blocks will be appended to the
281 # function's detailed documentation block.
283 HIDE_IN_BODY_DOCS = NO
285 # The INTERNAL_DOCS tag determines if documentation
286 # that is typed after a \internal command is included. If the tag is set
287 # to NO (the default) then the documentation will be excluded.
288 # Set it to YES to include the internal documentation.
293 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
294 # file names in lower-case letters. If set to YES upper-case letters are also
295 # allowed. This is useful if you have classes or files whose names only differ
296 # in case and if your file system supports case sensitive file names. Windows
297 # and Mac users are advised to set this option to NO.
299 CASE_SENSE_NAMES = YES
302 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
303 # will show members with their full class and namespace scopes in the
304 # documentation. If set to YES the scope will be hidden.
306 HIDE_SCOPE_NAMES = NO
309 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
310 # will put a list of the files that are included by a file in the documentation
313 SHOW_INCLUDE_FILES = YES
315 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
316 # is inserted in the documentation for inline members.
320 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
321 # will sort the (detailed) documentation of file and class members
322 # alphabetically by member name. If set to NO the members will appear in
325 SORT_MEMBER_DOCS = YES
327 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
328 # brief documentation of file, namespace and class members alphabetically
329 # by member name. If set to NO (the default) the members will appear in
334 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
335 # sorted by fully-qualified names, including namespaces. If set to
336 # NO (the default), the class list will be sorted only by class name,
337 # not including the namespace part.
338 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
339 # Note: This option applies only to the class list, not to the
342 SORT_BY_SCOPE_NAME = NO
344 # The GENERATE_TODOLIST tag can be used to enable (YES) or
345 # disable (NO) the todo list. This list is created by putting \todo
346 # commands in the documentation.
348 GENERATE_TODOLIST = YES
350 # The GENERATE_TESTLIST tag can be used to enable (YES) or
351 # disable (NO) the test list. This list is created by putting \test
352 # commands in the documentation.
354 GENERATE_TESTLIST = YES
356 # The GENERATE_BUGLIST tag can be used to enable (YES) or
357 # disable (NO) the bug list. This list is created by putting \bug
358 # commands in the documentation.
360 GENERATE_BUGLIST = YES
362 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
363 # disable (NO) the deprecated list. This list is created by putting
364 # \deprecated commands in the documentation.
366 GENERATE_DEPRECATEDLIST= YES
368 # The ENABLED_SECTIONS tag can be used to enable conditional
369 # documentation sections, marked by \if sectionname ... \endif.
373 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
374 # the initial value of a variable or define consists of for it to appear in
375 # the documentation. If the initializer consists of more lines than specified
376 # here it will be hidden. Use a value of 0 to hide initializers completely.
377 # The appearance of the initializer of individual variables and defines in the
378 # documentation can be controlled using \showinitializer or \hideinitializer
379 # command in the documentation regardless of this setting.
381 MAX_INITIALIZER_LINES = 30
383 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
384 # at the bottom of the documentation of classes and structs. If set to YES the
385 # list will mention the files that were used to generate the documentation.
387 SHOW_USED_FILES = YES
389 # If the sources in your project are distributed over multiple directories
390 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
391 # in the documentation. The default is NO.
393 SHOW_DIRECTORIES = NO
395 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
396 # doxygen should invoke to get the current version for each file (typically from the
397 # version control system). Doxygen will invoke the program by executing (via
398 # popen()) the command <command> <input-file>, where <command> is the value of
399 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
400 # provided by doxygen. Whatever the program writes to standard output
401 # is used as the file version. See the manual for examples.
403 FILE_VERSION_FILTER =
405 #---------------------------------------------------------------------------
406 # configuration options related to warning and progress messages
407 #---------------------------------------------------------------------------
409 # The QUIET tag can be used to turn on/off the messages that are generated
410 # by doxygen. Possible values are YES and NO. If left blank NO is used.
414 # The WARNINGS tag can be used to turn on/off the warning messages that are
415 # generated by doxygen. Possible values are YES and NO. If left blank
420 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
421 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
422 # automatically be disabled.
424 WARN_IF_UNDOCUMENTED = YES
426 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
427 # potential errors in the documentation, such as not documenting some
428 # parameters in a documented function, or documenting parameters that
429 # don't exist or using markup commands wrongly.
431 WARN_IF_DOC_ERROR = YES
433 # This WARN_NO_PARAMDOC option can be abled to get warnings for
434 # functions that are documented, but have no documentation for their parameters
435 # or return value. If set to NO (the default) doxygen will only warn about
436 # wrong or incomplete parameter documentation, but not about the absence of
439 WARN_NO_PARAMDOC = NO
441 # The WARN_FORMAT tag determines the format of the warning messages that
442 # doxygen can produce. The string should contain the $file, $line, and $text
443 # tags, which will be replaced by the file and line number from which the
444 # warning originated and the warning text. Optionally the format may contain
445 # $version, which will be replaced by the version of the file (if it could
446 # be obtained via FILE_VERSION_FILTER)
448 WARN_FORMAT = "$file:$line: $text"
450 # The WARN_LOGFILE tag can be used to specify a file to which warning
451 # and error messages should be written. If left blank the output is written
456 #---------------------------------------------------------------------------
457 # configuration options related to the input files
458 #---------------------------------------------------------------------------
460 # The INPUT tag can be used to specify the files and/or directories that contain
461 # documented source files. You may enter file names like "myfile.cpp" or
462 # directories like "/usr/src/myproject". Separate the files or directories
465 INPUT = @GDCM_DOCUMENTATION_INPUT@
467 # This tag can be used to specify the character encoding of the source files that
468 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
469 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
470 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
472 INPUT_ENCODING = UTF-8
474 # If the value of the INPUT tag contains directories, you can use the
475 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
476 # and *.h) to filter out the source-files in the directories. If left
477 # blank the following patterns are tested:
478 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
479 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
481 FILE_PATTERNS = *.h \
484 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
485 # should be searched for input files as well. Possible values are YES and NO.
486 # If left blank NO is used.
490 # The EXCLUDE tag can be used to specify files and/or directories that should
491 # excluded from the INPUT source files. This way you can easily exclude a
492 # subdirectory from a directory tree whose root is specified with the INPUT tag.
494 EXCLUDE = @GDCM_DOCUMENTATION_EXCLUDE@
496 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
497 # directories that are symbolic links (a Unix filesystem feature) are excluded
500 EXCLUDE_SYMLINKS = NO
502 # If the value of the INPUT tag contains directories, you can use the
503 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
504 # certain files from those directories. Note that the wildcards are matched
505 # against the file with absolute path, so to exclude all test directories
506 # for example use the pattern */test/*
510 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
511 # (namespaces, classes, functions, etc.) that should be excluded from the output.
512 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
513 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
517 # The EXAMPLE_PATH tag can be used to specify one or more files or
518 # directories that contain example code fragments that are included (see
519 # the \include command).
521 EXAMPLE_PATH = @GDCM_SOURCE_DIR@/Example \
522 @GDCM_SOURCE_DIR@/Testing \
523 @GDCM_SOURCE_DIR@/gdcmPython/demo \
524 @GDCM_SOURCE_DIR@/vtk
526 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
527 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
528 # and *.h) to filter out the source-files in the directories. If left
529 # blank all files are included.
531 EXAMPLE_PATTERNS = *.py \
534 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
535 # searched for input files to be used with the \include or \dontinclude
536 # commands irrespective of the value of the RECURSIVE tag.
537 # Possible values are YES and NO. If left blank NO is used.
539 EXAMPLE_RECURSIVE = NO
541 # The IMAGE_PATH tag can be used to specify one or more files or
542 # directories that contain image that are included in the documentation (see
543 # the \image command).
547 # The INPUT_FILTER tag can be used to specify a program that doxygen should
548 # invoke to filter for each input file. Doxygen will invoke the filter program
549 # by executing (via popen()) the command <filter> <input-file>, where <filter>
550 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
551 # input file. Doxygen will then use the output that the filter program writes
552 # to standard output. If FILTER_PATTERNS is specified, this tag will be
556 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
557 # basis. Doxygen will compare the file name with each pattern and apply the
558 # filter if there is a match. The filters are a list of the form:
559 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
560 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
561 # is applied to all files.
565 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
566 # INPUT_FILTER) will be used to filter the input files when producing source
567 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
569 FILTER_SOURCE_FILES = NO
571 #---------------------------------------------------------------------------
572 # configuration options related to source browsing
573 #---------------------------------------------------------------------------
575 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
576 # be generated. Documented entities will be cross-referenced with these sources.
577 # Note: To get rid of all source code in the generated output, make sure also
578 # VERBATIM_HEADERS is set to NO.
582 # Setting the INLINE_SOURCES tag to YES will include the body
583 # of functions and classes directly in the documentation.
586 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
587 # doxygen to hide any special comment blocks from generated source code
588 # fragments. Normal C and C++ comments will always remain visible.
590 STRIP_CODE_COMMENTS = YES
592 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
593 # then for each documented function all documented
594 # functions referencing it will be listed.
596 REFERENCED_BY_RELATION = YES
598 # If the REFERENCES_RELATION tag is set to YES (the default)
599 # then for each documented function all documented entities
600 # called/used by that function will be listed.
602 REFERENCES_RELATION = YES
604 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
605 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
606 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
607 # link to the source code. Otherwise they will link to the documentstion.
609 REFERENCES_LINK_SOURCE = YES
611 # If the USE_HTAGS tag is set to YES then the references to source code
612 # will point to the HTML generated by the htags(1) tool instead of doxygen
613 # built-in source browser. The htags tool is part of GNU's global source
614 # tagging system (see http://www.gnu.org/software/global/global.html). You
615 # will need version 4.8.6 or higher.
619 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
620 # will generate a verbatim copy of the header file for each class for
621 # which an include is specified. Set to NO to disable this.
623 VERBATIM_HEADERS = YES
625 #---------------------------------------------------------------------------
626 # configuration options related to the alphabetical class index
627 #---------------------------------------------------------------------------
629 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
630 # of all compounds will be generated. Enable this if the project
631 # contains a lot of classes, structs, unions or interfaces.
633 ALPHABETICAL_INDEX = YES
635 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
636 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
637 # in which this list will be split (can be a number in the range [1..20])
639 COLS_IN_ALPHA_INDEX = 5
641 # In case all classes in a project start with a common prefix, all
642 # classes will be put under the same header in the alphabetical index.
643 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
644 # should be ignored while generating the index headers.
648 #---------------------------------------------------------------------------
649 # configuration options related to the HTML output
650 #---------------------------------------------------------------------------
652 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
653 # generate HTML output.
657 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
658 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
659 # put in front of it. If left blank `html' will be used as the default path.
661 HTML_OUTPUT = @GDCM_HTML_OUTPUT@
663 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
664 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
665 # doxygen will generate files with .html extension.
667 HTML_FILE_EXTENSION = .html
669 # The HTML_HEADER tag can be used to specify a personal HTML header for
670 # each generated HTML page. If it is left blank doxygen will generate a
675 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
676 # each generated HTML page. If it is left blank doxygen will generate a
681 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
682 # style sheet that is used by each HTML page. It can be used to
683 # fine-tune the look of the HTML output. If the tag is left blank doxygen
684 # will generate a default style sheet. Note that doxygen will try to copy
685 # the style sheet file to the HTML output directory, so don't put your own
686 # stylesheet in the HTML output directory as well, or it will be erased!
690 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
691 # files or namespaces will be aligned in HTML using tables. If set to
692 # NO a bullet list will be used.
694 HTML_ALIGN_MEMBERS = YES
696 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
697 # will be generated that can be used as input for tools like the
698 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
699 # of the generated HTML documentation.
701 GENERATE_HTMLHELP = NO
703 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
704 # be used to specify the file name of the resulting .chm file. You
705 # can add a path in front of the file if the result should not be
706 # written to the html output directory.
710 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
711 # be used to specify the location (absolute path including file name) of
712 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
713 # the HTML help compiler on the generated index.hhp.
717 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
718 # controls if a separate .chi index file is generated (YES) or that
719 # it should be included in the master .chm file (NO).
723 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
724 # controls whether a binary table of contents is generated (YES) or a
725 # normal table of contents (NO) in the .chm file.
729 # The TOC_EXPAND flag can be set to YES to add extra items for group members
730 # to the contents of the HTML help documentation and to the tree view.
734 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
735 # top of each HTML page. The value NO (the default) enables the index and
736 # the value YES disables it.
740 # This tag can be used to set the number of enum values (range [1..20])
741 # that doxygen will group on one line in the generated HTML documentation.
743 ENUM_VALUES_PER_LINE = 4
745 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
746 # generated containing a tree-like index structure (just like the one that
747 # is generated for HTML Help). For this to work a browser that supports
748 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
749 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
750 # probably better off using the HTML help feature.
752 GENERATE_TREEVIEW = NO
754 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
755 # used to set the initial width (in pixels) of the frame in which the tree
760 #---------------------------------------------------------------------------
761 # configuration options related to the LaTeX output
762 #---------------------------------------------------------------------------
764 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
765 # generate Latex output.
769 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
770 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
771 # put in front of it. If left blank `latex' will be used as the default path.
774 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
775 # invoked. If left blank `latex' will be used as the default command name.
777 LATEX_CMD_NAME = latex
779 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
780 # generate index for LaTeX. If left blank `makeindex' will be used as the
781 # default command name.
783 MAKEINDEX_CMD_NAME = makeindex
785 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
786 # LaTeX documents. This may be useful for small projects and may help to
787 # save some trees in general.
791 # The PAPER_TYPE tag can be used to set the paper type that is used
792 # by the printer. Possible values are: a4, a4wide, letter, legal and
793 # executive. If left blank a4wide will be used.
797 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
798 # packages that should be included in the LaTeX output.
802 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
803 # the generated latex document. The header should contain everything until
804 # the first chapter. If it is left blank doxygen will generate a
805 # standard header. Notice: only use this tag if you know what you are doing!
809 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
810 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
811 # contain links (just like the HTML output) instead of page references
812 # This makes the output suitable for online browsing using a pdf viewer.
816 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
817 # plain latex in the generated Makefile. Set this option to YES to get a
818 # higher quality PDF documentation.
822 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
823 # command to the generated LaTeX files. This will instruct LaTeX to keep
824 # running if errors occur, instead of asking the user for help.
825 # This option is also used when generating formulas in HTML.
829 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
830 # include the index chapters (such as File Index, Compound Index, etc.)
833 LATEX_HIDE_INDICES = NO
835 #---------------------------------------------------------------------------
836 # configuration options related to the RTF output
837 #---------------------------------------------------------------------------
839 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
840 # The RTF output is optimized for Word 97 and may not look very pretty with
841 # other RTF readers or editors.
845 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
846 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
847 # put in front of it. If left blank `rtf' will be used as the default path.
851 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
852 # RTF documents. This may be useful for small projects and may help to
853 # save some trees in general.
857 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
858 # will contain hyperlink fields. The RTF file will
859 # contain links (just like the HTML output) instead of page references.
860 # This makes the output suitable for online browsing using WORD or other
861 # programs which support those fields.
862 # Note: wordpad (write) and others do not support links.
866 # Load stylesheet definitions from file. Syntax is similar to doxygen's
867 # config file, i.e. a series of assignments. You only have to provide
868 # replacements, missing definitions are set to their default value.
870 RTF_STYLESHEET_FILE =
872 # Set optional variables used in the generation of an rtf document.
873 # Syntax is similar to doxygen's config file.
875 RTF_EXTENSIONS_FILE =
877 #---------------------------------------------------------------------------
878 # configuration options related to the man page output
879 #---------------------------------------------------------------------------
881 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
886 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
887 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
888 # put in front of it. If left blank `man' will be used as the default path.
892 # The MAN_EXTENSION tag determines the extension that is added to
893 # the generated man pages (default is the subroutine's section .3)
897 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
898 # then it will generate one additional man file for each entity
899 # documented in the real man page(s). These additional files
900 # only source the real man page, but without them the man command
901 # would be unable to find the correct page. The default is NO.
905 #---------------------------------------------------------------------------
906 # configuration options related to the XML output
907 #---------------------------------------------------------------------------
909 # If the GENERATE_XML tag is set to YES Doxygen will
910 # generate an XML file that captures the structure of
911 # the code including all documentation.
915 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
916 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
917 # put in front of it. If left blank `xml' will be used as the default path.
921 # The XML_SCHEMA tag can be used to specify an XML schema,
922 # which can be used by a validating XML parser to check the
923 # syntax of the XML files.
927 # The XML_DTD tag can be used to specify an XML DTD,
928 # which can be used by a validating XML parser to check the
929 # syntax of the XML files.
933 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
934 # dump the program listings (including syntax highlighting
935 # and cross-referencing information) to the XML output. Note that
936 # enabling this will significantly increase the size of the XML output.
938 XML_PROGRAMLISTING = YES
940 #---------------------------------------------------------------------------
941 # configuration options for the AutoGen Definitions output
942 #---------------------------------------------------------------------------
944 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
945 # generate an AutoGen Definitions (see autogen.sf.net) file
946 # that captures the structure of the code including all
947 # documentation. Note that this feature is still experimental
948 # and incomplete at the moment.
950 GENERATE_AUTOGEN_DEF = NO
952 #---------------------------------------------------------------------------
953 # configuration options related to the Perl module output
954 #---------------------------------------------------------------------------
956 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
957 # generate a Perl module file that captures the structure of
958 # the code including all documentation. Note that this
959 # feature is still experimental and incomplete at the
962 GENERATE_PERLMOD = NO
964 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
965 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
966 # to generate PDF and DVI output from the Perl module output.
970 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
971 # nicely formatted so it can be parsed by a human reader. This is useful
972 # if you want to understand what is going on. On the other hand, if this
973 # tag is set to NO the size of the Perl module output will be much smaller
974 # and Perl will parse it just the same.
978 # The names of the make variables in the generated doxyrules.make file
979 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
980 # This is useful so different doxyrules.make files included by the same
981 # Makefile don't overwrite each other's variables.
983 PERLMOD_MAKEVAR_PREFIX =
985 #---------------------------------------------------------------------------
986 # Configuration options related to the preprocessor
987 #---------------------------------------------------------------------------
989 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
990 # evaluate all C-preprocessor directives found in the sources and include
993 ENABLE_PREPROCESSING = YES
995 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
996 # names in the source code. If set to NO (the default) only conditional
997 # compilation will be performed. Macro expansion can be done in a controlled
998 # way by setting EXPAND_ONLY_PREDEF to YES.
1000 MACRO_EXPANSION = NO
1002 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1003 # then the macro expansion is limited to the macros specified with the
1004 # PREDEFINED and EXPAND_AS_DEFINED tags.
1006 EXPAND_ONLY_PREDEF = NO
1008 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1009 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1011 SEARCH_INCLUDES = YES
1013 # The INCLUDE_PATH tag can be used to specify one or more directories that
1014 # contain include files that are not input files but should be processed by
1019 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1020 # patterns (like *.h and *.hpp) to filter out the header-files in the
1021 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1024 INCLUDE_FILE_PATTERNS =
1026 # The PREDEFINED tag can be used to specify one or more macro names that
1027 # are defined before the preprocessor is started (similar to the -D option of
1028 # gcc). The argument of the tag is a list of macros of the form: name
1029 # or name=definition (no spaces). If the definition and the = are
1030 # omitted =1 is assumed. To prevent a macro definition from being
1031 # undefined via #undef or recursively expanded use the := operator
1032 # instead of the = operator.
1036 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1037 # this tag can be used to specify a list of macro names that should be expanded.
1038 # The macro definition that is found in the sources will be used.
1039 # Use the PREDEFINED tag if you want to use a different macro definition.
1043 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1044 # doxygen's preprocessor will remove all function-like macros that are alone
1045 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1046 # function macros are typically used for boiler-plate code, and will confuse
1047 # the parser if not removed.
1049 SKIP_FUNCTION_MACROS = YES
1051 #---------------------------------------------------------------------------
1052 # Configuration::additions related to external references
1053 #---------------------------------------------------------------------------
1055 # The TAGFILES option can be used to specify one or more tagfiles.
1056 # Optionally an initial location of the external documentation
1057 # can be added for each tagfile. The format of a tag file without
1058 # this location is as follows:
1059 # TAGFILES = file1 file2 ...
1060 # Adding location for the tag files is done as follows:
1061 # TAGFILES = file1=loc1 "file2 = loc2" ...
1062 # where "loc1" and "loc2" can be relative or absolute paths or
1063 # URLs. If a location is present for each tag, the installdox tool
1064 # does not have to be run to correct the links.
1065 # Note that each tag file must have a unique name
1066 # (where the name does NOT include the path)
1067 # If a tag file is not located in the directory in which doxygen
1068 # is run, you must also specify the path to the tagfile here.
1072 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1073 # a tag file that is based on the input files it reads.
1077 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1078 # in the class index. If set to NO only the inherited external classes
1083 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1084 # in the modules index. If set to NO, only the current project's groups will
1087 EXTERNAL_GROUPS = YES
1089 # The PERL_PATH should be the absolute path and name of the perl script
1090 # interpreter (i.e. the result of `which perl').
1092 PERL_PATH = /usr/bin/perl
1094 #---------------------------------------------------------------------------
1095 # Configuration options related to the dot tool
1096 #---------------------------------------------------------------------------
1098 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1099 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1100 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1101 # this option is superseded by the HAVE_DOT option below. This is only a
1102 # fallback. It is recommended to install and use dot, since it yields more
1105 CLASS_DIAGRAMS = YES
1107 # You can define message sequence charts within doxygen comments using the \msc
1108 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1109 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1110 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1111 # be found in the default search path.
1115 # If set to YES, the inheritance and collaboration graphs will hide
1116 # inheritance and usage relations if the target is undocumented
1117 # or is not a class.
1119 HIDE_UNDOC_RELATIONS = YES
1121 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1122 # available from the path. This tool is part of Graphviz, a graph visualization
1123 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1124 # have no effect if this option is set to NO (the default)
1126 HAVE_DOT = @GDCM_DOCUMENTATION_HAVE_DOT@
1128 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1129 # will generate a graph for each documented class showing the direct and
1130 # indirect inheritance relations. Setting this tag to YES will force the
1131 # the CLASS_DIAGRAMS tag to NO.
1135 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1136 # will generate a graph for each documented class showing the direct and
1137 # indirect implementation dependencies (inheritance, containment, and
1138 # class references variables) of the class with other documented classes.
1140 COLLABORATION_GRAPH = YES
1142 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1143 # will generate a graph for groups, showing the direct groups dependencies
1147 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1148 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1153 # If set to YES, the inheritance and collaboration graphs will show the
1154 # relations between templates and their instances.
1156 TEMPLATE_RELATIONS = YES
1158 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1159 # tags are set to YES then doxygen will generate a graph for each documented
1160 # file showing the direct and indirect include dependencies of the file with
1161 # other documented files.
1165 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1166 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1167 # documented header file showing the documented files that directly or
1168 # indirectly include this file.
1170 INCLUDED_BY_GRAPH = YES
1172 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1173 # generate a call dependency graph for every global function or class method.
1174 # Note that enabling this option will significantly increase the time of a run.
1175 # So in most cases it will be better to enable call graphs for selected
1176 # functions only using the \callgraph command.
1180 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1181 # generate a caller dependency graph for every global function or class method.
1182 # Note that enabling this option will significantly increase the time of a run.
1183 # So in most cases it will be better to enable caller graphs for selected
1184 # functions only using the \callergraph command.
1188 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1189 # will graphical hierarchy of all classes instead of a textual one.
1191 GRAPHICAL_HIERARCHY = YES
1193 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1194 # then doxygen will show the dependencies a directory has on other directories
1195 # in a graphical way. The dependency relations are determined by the #include
1196 # relations between the files in the directories.
1198 DIRECTORY_GRAPH = YES
1200 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1201 # generated by dot. Possible values are png, jpg, or gif
1202 # If left blank png will be used.
1204 DOT_IMAGE_FORMAT = png
1206 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1207 # found. If left blank, it is assumed the dot tool can be found in the path.
1209 DOT_PATH = @GDCM_DOCUMENTATION_DOT_PATH@
1211 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1212 # contain dot files that are included in the documentation (see the
1213 # \dotfile command).
1217 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1218 # nodes that will be shown in the graph. If the number of nodes in a graph
1219 # becomes larger than this value, doxygen will truncate the graph, which is
1220 # visualized by representing a node as a red box. Note that doxygen will always
1221 # show the root nodes and its direct children regardless of this setting.
1223 DOT_GRAPH_MAX_NODES = 50
1225 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1226 # background. This is disabled by default, which results in a white background.
1227 # Warning: Depending on the platform used, enabling this option may lead to
1228 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1231 DOT_TRANSPARENT = NO
1233 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1234 # files in one run (i.e. multiple -o and -T options on the command line). This
1235 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1236 # support this, this feature is disabled by default.
1238 DOT_MULTI_TARGETS = NO
1240 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1241 # generate a legend page explaining the meaning of the various boxes and
1242 # arrows in the dot generated graphs.
1244 GENERATE_LEGEND = YES
1246 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1247 # remove the intermediate dot files that are used to generate
1248 # the various graphs.
1252 #---------------------------------------------------------------------------
1253 # Configuration::additions related to the search engine
1254 #---------------------------------------------------------------------------
1256 # The SEARCHENGINE tag specifies whether or not a search engine should be
1257 # used. If set to NO the values of all tags below this one will be ignored.