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 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file that
18 # follow. The default is UTF-8 which is also the encoding used for all text before
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME = MagickCore
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
34 PROJECT_NUMBER = @PACKAGE_VERSION@
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
41 OUTPUT_DIRECTORY = www/api
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62 OUTPUT_LANGUAGE = English
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
67 # Set to NO to disable this.
69 BRIEF_MEMBER_DESC = YES
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # brief descriptions will be completely suppressed.
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
86 # "represents" "a" "an" "the"
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91 # Doxygen will generate a detailed section even if there is only a brief
94 ALWAYS_DETAILED_SEC = NO
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97 # inherited members of a class in the documentation of that class as if those
98 # members were ordinary class members. Constructors, destructors and assignment
99 # operators of the base classes will not be shown.
101 INLINE_INHERITED_MEMB = NO
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104 # path before files name in the file list and in the header files. If set
105 # to NO the shortest path that makes the file name unique will be used.
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110 # can be used to strip a user-defined part of the path. Stripping is
111 # only done if one of the specified strings matches the left-hand part of
112 # the path. The tag can be used to show relative paths in the file list.
113 # If left blank the directory from which doxygen is run is used as the
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119 # the path mentioned in the documentation of a class, which tells
120 # the reader which header file to include in order to use a class.
121 # If left blank only the name of the header file containing the class
122 # definition is used. Otherwise one should specify the include paths that
123 # are normally passed to the compiler using the -I flag.
125 STRIP_FROM_INC_PATH =
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128 # (but less readable) file names. This can be useful is your file systems
129 # doesn't support long names like on DOS, Mac, or CD-ROM.
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134 # will interpret the first line (until the first dot) of a JavaDoc-style
135 # comment as the brief description. If set to NO, the JavaDoc
136 # comments will behave just like regular Qt-style comments
137 # (thus requiring an explicit @brief command for a brief description.)
139 JAVADOC_AUTOBRIEF = NO
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142 # interpret the first line (until the first dot) of a Qt-style
143 # comment as the brief description. If set to NO, the comments
144 # will behave just like regular Qt-style comments (thus requiring
145 # an explicit \brief command for a brief description.)
149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151 # comments) as a brief description. This used to be the default behaviour.
152 # The new default is to treat a multi-line C++ comment block as a detailed
153 # description. Set this tag to YES if you prefer the old behaviour instead.
155 MULTILINE_CPP_IS_BRIEF = YES
157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
158 # will output the detailed description near the top, like JavaDoc.
159 # If set to NO, the detailed description appears after the member
164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
165 # member inherits the documentation from any documented member that it
170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171 # a new page for each member. If set to NO, the documentation of a member will
172 # be part of the file/class/namespace that contains it.
174 SEPARATE_MEMBER_PAGES = NO
176 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
177 # Doxygen uses this value to replace tabs by spaces in code fragments.
181 # This tag can be used to specify a number of aliases that acts
182 # as commands in the documentation. An alias has the form "name=value".
183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
184 # put the command \sideeffect (or @sideeffect) in the documentation, which
185 # will result in a user-defined paragraph with heading "Side Effects:".
186 # You can put \n's in the value part of an alias to insert newlines.
190 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
191 # sources only. Doxygen will then generate output that is more tailored for C.
192 # For instance, some of the names that are used will be different. The list
193 # of all members will be omitted, etc.
195 OPTIMIZE_OUTPUT_FOR_C = YES
197 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
198 # sources only. Doxygen will then generate output that is more tailored for Java.
199 # For instance, namespaces will be presented as packages, qualified scopes
200 # will look different, etc.
202 OPTIMIZE_OUTPUT_JAVA = NO
204 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
205 # include (a tag file for) the STL sources as input, then you should
206 # set this tag to YES in order to let doxygen match functions declarations and
207 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
208 # func(std::string) {}). This also make the inheritance and collaboration
209 # diagrams that involve STL classes more complete and accurate.
211 BUILTIN_STL_SUPPORT = NO
213 # If you use Microsoft's C++/CLI language, you should set this option to YES to
214 # enable parsing support.
218 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
219 # Doxygen will parse them like normal C++ but will assume all classes use public
220 # instead of private inheritance when no explicit protection keyword is present.
224 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
225 # tag is set to YES, then doxygen will reuse the documentation of the first
226 # member in the group (if any) for the other members of the group. By default
227 # all members of a group must be documented explicitly.
229 DISTRIBUTE_GROUP_DOC = NO
231 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
232 # the same type (for instance a group of public functions) to be put as a
233 # subgroup of that type (e.g. under the Public Functions section). Set it to
234 # NO to prevent subgrouping. Alternatively, this can be done per class using
235 # the \nosubgrouping command.
239 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is
240 # documented as struct with the name of the typedef. So
241 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
242 # with name TypeT. When disabled the typedef will appear as a member of a file,
243 # namespace, or class. And the struct will be named TypeS. This can typically
244 # be useful for C code where the coding convention is that all structs are
245 # typedef'ed and only the typedef is referenced never the struct's name.
247 TYPEDEF_HIDES_STRUCT = NO
249 #---------------------------------------------------------------------------
250 # Build related configuration options
251 #---------------------------------------------------------------------------
253 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
254 # documentation are documented, even if no documentation was available.
255 # Private class members and static file members will be hidden unless
256 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
260 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
261 # will be included in the documentation.
265 # If the EXTRACT_STATIC tag is set to YES all static members of a file
266 # will be included in the documentation.
270 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
271 # defined locally in source files will be included in the documentation.
272 # If set to NO only classes defined in header files are included.
274 EXTRACT_LOCAL_CLASSES = YES
276 # This flag is only useful for Objective-C code. When set to YES local
277 # methods, which are defined in the implementation section but not in
278 # the interface are included in the documentation.
279 # If set to NO (the default) only methods in the interface are included.
281 EXTRACT_LOCAL_METHODS = NO
283 # If this flag is set to YES, the members of anonymous namespaces will be extracted
284 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
285 # where file will be replaced with the base name of the file that contains the anonymous
286 # namespace. By default anonymous namespace are hidden.
288 EXTRACT_ANON_NSPACES = NO
290 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
291 # undocumented members of documented classes, files or namespaces.
292 # If set to NO (the default) these members will be included in the
293 # various overviews, but no documentation section is generated.
294 # This option has no effect if EXTRACT_ALL is enabled.
296 HIDE_UNDOC_MEMBERS = NO
298 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
299 # undocumented classes that are normally visible in the class hierarchy.
300 # If set to NO (the default) these classes will be included in the various
301 # overviews. This option has no effect if EXTRACT_ALL is enabled.
303 HIDE_UNDOC_CLASSES = NO
305 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
306 # friend (class|struct|union) declarations.
307 # If set to NO (the default) these declarations will be included in the
310 HIDE_FRIEND_COMPOUNDS = NO
312 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
313 # documentation blocks found inside the body of a function.
314 # If set to NO (the default) these blocks will be appended to the
315 # function's detailed documentation block.
317 HIDE_IN_BODY_DOCS = NO
319 # The INTERNAL_DOCS tag determines if documentation
320 # that is typed after a \internal command is included. If the tag is set
321 # to NO (the default) then the documentation will be excluded.
322 # Set it to YES to include the internal documentation.
326 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
327 # file names in lower-case letters. If set to YES upper-case letters are also
328 # allowed. This is useful if you have classes or files whose names only differ
329 # in case and if your file system supports case sensitive file names. Windows
330 # and Mac users are advised to set this option to NO.
332 CASE_SENSE_NAMES = YES
334 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
335 # will show members with their full class and namespace scopes in the
336 # documentation. If set to YES the scope will be hidden.
338 HIDE_SCOPE_NAMES = NO
340 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
341 # will put a list of the files that are included by a file in the documentation
344 SHOW_INCLUDE_FILES = YES
346 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
347 # is inserted in the documentation for inline members.
351 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
352 # will sort the (detailed) documentation of file and class members
353 # alphabetically by member name. If set to NO the members will appear in
356 SORT_MEMBER_DOCS = YES
358 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
359 # brief documentation of file, namespace and class members alphabetically
360 # by member name. If set to NO (the default) the members will appear in
365 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
366 # sorted by fully-qualified names, including namespaces. If set to
367 # NO (the default), the class list will be sorted only by class name,
368 # not including the namespace part.
369 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
370 # Note: This option applies only to the class list, not to the
373 SORT_BY_SCOPE_NAME = NO
375 # The GENERATE_TODOLIST tag can be used to enable (YES) or
376 # disable (NO) the todo list. This list is created by putting \todo
377 # commands in the documentation.
379 GENERATE_TODOLIST = YES
381 # The GENERATE_TESTLIST tag can be used to enable (YES) or
382 # disable (NO) the test list. This list is created by putting \test
383 # commands in the documentation.
385 GENERATE_TESTLIST = YES
387 # The GENERATE_BUGLIST tag can be used to enable (YES) or
388 # disable (NO) the bug list. This list is created by putting \bug
389 # commands in the documentation.
391 GENERATE_BUGLIST = YES
393 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
394 # disable (NO) the deprecated list. This list is created by putting
395 # \deprecated commands in the documentation.
397 GENERATE_DEPRECATEDLIST= YES
399 # The ENABLED_SECTIONS tag can be used to enable conditional
400 # documentation sections, marked by \if sectionname ... \endif.
404 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
405 # the initial value of a variable or define consists of for it to appear in
406 # the documentation. If the initializer consists of more lines than specified
407 # here it will be hidden. Use a value of 0 to hide initializers completely.
408 # The appearance of the initializer of individual variables and defines in the
409 # documentation can be controlled using \showinitializer or \hideinitializer
410 # command in the documentation regardless of this setting.
412 MAX_INITIALIZER_LINES = 30
414 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
415 # at the bottom of the documentation of classes and structs. If set to YES the
416 # list will mention the files that were used to generate the documentation.
418 SHOW_USED_FILES = YES
420 # If the sources in your project are distributed over multiple directories
421 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
422 # in the documentation. The default is NO.
424 SHOW_DIRECTORIES = YES
426 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
427 # doxygen should invoke to get the current version for each file (typically from the
428 # version control system). Doxygen will invoke the program by executing (via
429 # popen()) the command <command> <input-file>, where <command> is the value of
430 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
431 # provided by doxygen. Whatever the program writes to standard output
432 # is used as the file version. See the manual for examples.
434 FILE_VERSION_FILTER =
436 #---------------------------------------------------------------------------
437 # configuration options related to warning and progress messages
438 #---------------------------------------------------------------------------
440 # The QUIET tag can be used to turn on/off the messages that are generated
441 # by doxygen. Possible values are YES and NO. If left blank NO is used.
445 # The WARNINGS tag can be used to turn on/off the warning messages that are
446 # generated by doxygen. Possible values are YES and NO. If left blank
451 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
452 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
453 # automatically be disabled.
455 WARN_IF_UNDOCUMENTED = YES
457 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
458 # potential errors in the documentation, such as not documenting some
459 # parameters in a documented function, or documenting parameters that
460 # don't exist or using markup commands wrongly.
462 WARN_IF_DOC_ERROR = YES
464 # This WARN_NO_PARAMDOC option can be abled to get warnings for
465 # functions that are documented, but have no documentation for their parameters
466 # or return value. If set to NO (the default) doxygen will only warn about
467 # wrong or incomplete parameter documentation, but not about the absence of
470 WARN_NO_PARAMDOC = NO
472 # The WARN_FORMAT tag determines the format of the warning messages that
473 # doxygen can produce. The string should contain the $file, $line, and $text
474 # tags, which will be replaced by the file and line number from which the
475 # warning originated and the warning text. Optionally the format may contain
476 # $version, which will be replaced by the version of the file (if it could
477 # be obtained via FILE_VERSION_FILTER)
479 WARN_FORMAT = "$file:$line: $text "
481 # The WARN_LOGFILE tag can be used to specify a file to which warning
482 # and error messages should be written. If left blank the output is written
487 #---------------------------------------------------------------------------
488 # configuration options related to the input files
489 #---------------------------------------------------------------------------
491 # The INPUT tag can be used to specify the files and/or directories that contain
492 # documented source files. You may enter file names like "myfile.cpp" or
493 # directories like "/usr/src/myproject". Separate the files or directories
498 # This tag can be used to specify the character encoding of the source files that
499 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
500 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
501 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
503 INPUT_ENCODING = UTF-8
505 # If the value of the INPUT tag contains directories, you can use the
506 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
507 # and *.h) to filter out the source-files in the directories. If left
508 # blank the following patterns are tested:
509 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
510 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
512 FILE_PATTERNS = *.c \
515 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
516 # should be searched for input files as well. Possible values are YES and NO.
517 # If left blank NO is used.
521 # The EXCLUDE tag can be used to specify files and/or directories that should
522 # excluded from the INPUT source files. This way you can easily exclude a
523 # subdirectory from a directory tree whose root is specified with the INPUT tag.
527 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
528 # directories that are symbolic links (a Unix filesystem feature) are excluded
531 EXCLUDE_SYMLINKS = NO
533 # If the value of the INPUT tag contains directories, you can use the
534 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
535 # certain files from those directories. Note that the wildcards are matched
536 # against the file with absolute path, so to exclude all test directories
537 # for example use the pattern */test/*
541 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
542 # (namespaces, classes, functions, etc.) that should be excluded from the output.
543 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
544 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
548 # The EXAMPLE_PATH tag can be used to specify one or more files or
549 # directories that contain example code fragments that are included (see
550 # the \include command).
554 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
555 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
556 # and *.h) to filter out the source-files in the directories. If left
557 # blank all files are included.
561 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
562 # searched for input files to be used with the \include or \dontinclude
563 # commands irrespective of the value of the RECURSIVE tag.
564 # Possible values are YES and NO. If left blank NO is used.
566 EXAMPLE_RECURSIVE = NO
568 # The IMAGE_PATH tag can be used to specify one or more files or
569 # directories that contain image that are included in the documentation (see
570 # the \image command).
574 # The INPUT_FILTER tag can be used to specify a program that doxygen should
575 # invoke to filter for each input file. Doxygen will invoke the filter program
576 # by executing (via popen()) the command <filter> <input-file>, where <filter>
577 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
578 # input file. Doxygen will then use the output that the filter program writes
579 # to standard output. If FILTER_PATTERNS is specified, this tag will be
584 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
585 # basis. Doxygen will compare the file name with each pattern and apply the
586 # filter if there is a match. The filters are a list of the form:
587 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
588 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
589 # is applied to all files.
593 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
594 # INPUT_FILTER) will be used to filter the input files when producing source
595 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
597 FILTER_SOURCE_FILES = NO
599 #---------------------------------------------------------------------------
600 # configuration options related to source browsing
601 #---------------------------------------------------------------------------
603 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
604 # be generated. Documented entities will be cross-referenced with these sources.
605 # Note: To get rid of all source code in the generated output, make sure also
606 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
607 # then you must also enable this option. If you don't then doxygen will produce
608 # a warning and turn it on anyway
612 # Setting the INLINE_SOURCES tag to YES will include the body
613 # of functions and classes directly in the documentation.
617 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
618 # doxygen to hide any special comment blocks from generated source code
619 # fragments. Normal C and C++ comments will always remain visible.
621 STRIP_CODE_COMMENTS = YES
623 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
624 # then for each documented function all documented
625 # functions referencing it will be listed.
627 REFERENCED_BY_RELATION = YES
629 # If the REFERENCES_RELATION tag is set to YES (the default)
630 # then for each documented function all documented entities
631 # called/used by that function will be listed.
633 REFERENCES_RELATION = YES
635 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
636 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
637 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
638 # link to the source code. Otherwise they will link to the documentstion.
640 REFERENCES_LINK_SOURCE = YES
642 # If the USE_HTAGS tag is set to YES then the references to source code
643 # will point to the HTML generated by the htags(1) tool instead of doxygen
644 # built-in source browser. The htags tool is part of GNU's global source
645 # tagging system (see http://www.gnu.org/software/global/global.html). You
646 # will need version 4.8.6 or higher.
650 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
651 # will generate a verbatim copy of the header file for each class for
652 # which an include is specified. Set to NO to disable this.
654 VERBATIM_HEADERS = YES
656 #---------------------------------------------------------------------------
657 # configuration options related to the alphabetical class index
658 #---------------------------------------------------------------------------
660 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
661 # of all compounds will be generated. Enable this if the project
662 # contains a lot of classes, structs, unions or interfaces.
664 ALPHABETICAL_INDEX = YES
666 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
667 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
668 # in which this list will be split (can be a number in the range [1..20])
670 COLS_IN_ALPHA_INDEX = 8
672 # In case all classes in a project start with a common prefix, all
673 # classes will be put under the same header in the alphabetical index.
674 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
675 # should be ignored while generating the index headers.
679 #---------------------------------------------------------------------------
680 # configuration options related to the HTML output
681 #---------------------------------------------------------------------------
683 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
684 # generate HTML output.
688 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
689 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
690 # put in front of it. If left blank `html' will be used as the default path.
692 HTML_OUTPUT = MagickCore
694 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
695 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
696 # doxygen will generate files with .html extension.
698 HTML_FILE_EXTENSION = .html
700 # The HTML_HEADER tag can be used to specify a personal HTML header for
701 # each generated HTML page. If it is left blank doxygen will generate a
706 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
707 # each generated HTML page. If it is left blank doxygen will generate a
712 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
713 # style sheet that is used by each HTML page. It can be used to
714 # fine-tune the look of the HTML output. If the tag is left blank doxygen
715 # will generate a default style sheet. Note that doxygen will try to copy
716 # the style sheet file to the HTML output directory, so don't put your own
717 # stylesheet in the HTML output directory as well, or it will be erased!
721 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
722 # files or namespaces will be aligned in HTML using tables. If set to
723 # NO a bullet list will be used.
725 HTML_ALIGN_MEMBERS = YES
727 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
728 # will be generated that can be used as input for tools like the
729 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
730 # of the generated HTML documentation.
732 GENERATE_HTMLHELP = NO
734 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
735 # documentation will contain sections that can be hidden and shown after the
736 # page has loaded. For this to work a browser that supports
737 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
738 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
740 HTML_DYNAMIC_SECTIONS = NO
742 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
743 # be used to specify the file name of the resulting .chm file. You
744 # can add a path in front of the file if the result should not be
745 # written to the html output directory.
749 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
750 # be used to specify the location (absolute path including file name) of
751 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
752 # the HTML help compiler on the generated index.hhp.
756 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
757 # controls if a separate .chi index file is generated (YES) or that
758 # it should be included in the master .chm file (NO).
762 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
763 # controls whether a binary table of contents is generated (YES) or a
764 # normal table of contents (NO) in the .chm file.
768 # The TOC_EXPAND flag can be set to YES to add extra items for group members
769 # to the contents of the HTML help documentation and to the tree view.
773 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
774 # top of each HTML page. The value NO (the default) enables the index and
775 # the value YES disables it.
779 # This tag can be used to set the number of enum values (range [1..20])
780 # that doxygen will group on one line in the generated HTML documentation.
782 ENUM_VALUES_PER_LINE = 4
784 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
785 # generated containing a tree-like index structure (just like the one that
786 # is generated for HTML Help). For this to work a browser that supports
787 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
788 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
789 # probably better off using the HTML help feature.
791 GENERATE_TREEVIEW = YES
793 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
794 # used to set the initial width (in pixels) of the frame in which the tree
799 #---------------------------------------------------------------------------
800 # configuration options related to the LaTeX output
801 #---------------------------------------------------------------------------
803 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
804 # generate Latex output.
808 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
809 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
810 # put in front of it. If left blank `latex' will be used as the default path.
814 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
815 # invoked. If left blank `latex' will be used as the default command name.
817 LATEX_CMD_NAME = latex
819 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
820 # generate index for LaTeX. If left blank `makeindex' will be used as the
821 # default command name.
823 MAKEINDEX_CMD_NAME = makeindex
825 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
826 # LaTeX documents. This may be useful for small projects and may help to
827 # save some trees in general.
831 # The PAPER_TYPE tag can be used to set the paper type that is used
832 # by the printer. Possible values are: a4, a4wide, letter, legal and
833 # executive. If left blank a4wide will be used.
837 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
838 # packages that should be included in the LaTeX output.
842 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
843 # the generated latex document. The header should contain everything until
844 # the first chapter. If it is left blank doxygen will generate a
845 # standard header. Notice: only use this tag if you know what you are doing!
849 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
850 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
851 # contain links (just like the HTML output) instead of page references
852 # This makes the output suitable for online browsing using a pdf viewer.
856 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
857 # plain latex in the generated Makefile. Set this option to YES to get a
858 # higher quality PDF documentation.
862 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
863 # command to the generated LaTeX files. This will instruct LaTeX to keep
864 # running if errors occur, instead of asking the user for help.
865 # This option is also used when generating formulas in HTML.
869 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
870 # include the index chapters (such as File Index, Compound Index, etc.)
873 LATEX_HIDE_INDICES = NO
875 #---------------------------------------------------------------------------
876 # configuration options related to the RTF output
877 #---------------------------------------------------------------------------
879 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
880 # The RTF output is optimized for Word 97 and may not look very pretty with
881 # other RTF readers or editors.
885 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
886 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
887 # put in front of it. If left blank `rtf' will be used as the default path.
891 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
892 # RTF documents. This may be useful for small projects and may help to
893 # save some trees in general.
897 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
898 # will contain hyperlink fields. The RTF file will
899 # contain links (just like the HTML output) instead of page references.
900 # This makes the output suitable for online browsing using WORD or other
901 # programs which support those fields.
902 # Note: wordpad (write) and others do not support links.
906 # Load stylesheet definitions from file. Syntax is similar to doxygen's
907 # config file, i.e. a series of assignments. You only have to provide
908 # replacements, missing definitions are set to their default value.
910 RTF_STYLESHEET_FILE =
912 # Set optional variables used in the generation of an rtf document.
913 # Syntax is similar to doxygen's config file.
915 RTF_EXTENSIONS_FILE =
917 #---------------------------------------------------------------------------
918 # configuration options related to the man page output
919 #---------------------------------------------------------------------------
921 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
926 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
927 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
928 # put in front of it. If left blank `man' will be used as the default path.
932 # The MAN_EXTENSION tag determines the extension that is added to
933 # the generated man pages (default is the subroutine's section .3)
937 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
938 # then it will generate one additional man file for each entity
939 # documented in the real man page(s). These additional files
940 # only source the real man page, but without them the man command
941 # would be unable to find the correct page. The default is NO.
945 #---------------------------------------------------------------------------
946 # configuration options related to the XML output
947 #---------------------------------------------------------------------------
949 # If the GENERATE_XML tag is set to YES Doxygen will
950 # generate an XML file that captures the structure of
951 # the code including all documentation.
955 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
956 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
957 # put in front of it. If left blank `xml' will be used as the default path.
961 # The XML_SCHEMA tag can be used to specify an XML schema,
962 # which can be used by a validating XML parser to check the
963 # syntax of the XML files.
967 # The XML_DTD tag can be used to specify an XML DTD,
968 # which can be used by a validating XML parser to check the
969 # syntax of the XML files.
973 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
974 # dump the program listings (including syntax highlighting
975 # and cross-referencing information) to the XML output. Note that
976 # enabling this will significantly increase the size of the XML output.
978 XML_PROGRAMLISTING = YES
980 #---------------------------------------------------------------------------
981 # configuration options for the AutoGen Definitions output
982 #---------------------------------------------------------------------------
984 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
985 # generate an AutoGen Definitions (see autogen.sf.net) file
986 # that captures the structure of the code including all
987 # documentation. Note that this feature is still experimental
988 # and incomplete at the moment.
990 GENERATE_AUTOGEN_DEF = NO
992 #---------------------------------------------------------------------------
993 # configuration options related to the Perl module output
994 #---------------------------------------------------------------------------
996 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
997 # generate a Perl module file that captures the structure of
998 # the code including all documentation. Note that this
999 # feature is still experimental and incomplete at the
1002 GENERATE_PERLMOD = NO
1004 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1005 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1006 # to generate PDF and DVI output from the Perl module output.
1010 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1011 # nicely formatted so it can be parsed by a human reader. This is useful
1012 # if you want to understand what is going on. On the other hand, if this
1013 # tag is set to NO the size of the Perl module output will be much smaller
1014 # and Perl will parse it just the same.
1016 PERLMOD_PRETTY = YES
1018 # The names of the make variables in the generated doxyrules.make file
1019 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1020 # This is useful so different doxyrules.make files included by the same
1021 # Makefile don't overwrite each other's variables.
1023 PERLMOD_MAKEVAR_PREFIX =
1025 #---------------------------------------------------------------------------
1026 # Configuration options related to the preprocessor
1027 #---------------------------------------------------------------------------
1029 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1030 # evaluate all C-preprocessor directives found in the sources and include
1033 ENABLE_PREPROCESSING = YES
1035 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1036 # names in the source code. If set to NO (the default) only conditional
1037 # compilation will be performed. Macro expansion can be done in a controlled
1038 # way by setting EXPAND_ONLY_PREDEF to YES.
1040 MACRO_EXPANSION = NO
1042 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1043 # then the macro expansion is limited to the macros specified with the
1044 # PREDEFINED and EXPAND_AS_DEFINED tags.
1046 EXPAND_ONLY_PREDEF = NO
1048 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1049 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1051 SEARCH_INCLUDES = YES
1053 # The INCLUDE_PATH tag can be used to specify one or more directories that
1054 # contain include files that are not input files but should be processed by
1059 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1060 # patterns (like *.h and *.hpp) to filter out the header-files in the
1061 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1064 INCLUDE_FILE_PATTERNS =
1066 # The PREDEFINED tag can be used to specify one or more macro names that
1067 # are defined before the preprocessor is started (similar to the -D option of
1068 # gcc). The argument of the tag is a list of macros of the form: name
1069 # or name=definition (no spaces). If the definition and the = are
1070 # omitted =1 is assumed. To prevent a macro definition from being
1071 # undefined via #undef or recursively expanded use the := operator
1072 # instead of the = operator.
1076 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1077 # this tag can be used to specify a list of macro names that should be expanded.
1078 # The macro definition that is found in the sources will be used.
1079 # Use the PREDEFINED tag if you want to use a different macro definition.
1083 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1084 # doxygen's preprocessor will remove all function-like macros that are alone
1085 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1086 # function macros are typically used for boiler-plate code, and will confuse
1087 # the parser if not removed.
1089 SKIP_FUNCTION_MACROS = YES
1091 #---------------------------------------------------------------------------
1092 # Configuration::additions related to external references
1093 #---------------------------------------------------------------------------
1095 # The TAGFILES option can be used to specify one or more tagfiles.
1096 # Optionally an initial location of the external documentation
1097 # can be added for each tagfile. The format of a tag file without
1098 # this location is as follows:
1099 # TAGFILES = file1 file2 ...
1100 # Adding location for the tag files is done as follows:
1101 # TAGFILES = file1=loc1 "file2 = loc2" ...
1102 # where "loc1" and "loc2" can be relative or absolute paths or
1103 # URLs. If a location is present for each tag, the installdox tool
1104 # does not have to be run to correct the links.
1105 # Note that each tag file must have a unique name
1106 # (where the name does NOT include the path)
1107 # If a tag file is not located in the directory in which doxygen
1108 # is run, you must also specify the path to the tagfile here.
1112 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1113 # a tag file that is based on the input files it reads.
1117 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1118 # in the class index. If set to NO only the inherited external classes
1123 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1124 # in the modules index. If set to NO, only the current project's groups will
1127 EXTERNAL_GROUPS = YES
1129 # The PERL_PATH should be the absolute path and name of the perl script
1130 # interpreter (i.e. the result of `which perl').
1132 PERL_PATH = /usr/bin/perl
1134 #---------------------------------------------------------------------------
1135 # Configuration options related to the dot tool
1136 #---------------------------------------------------------------------------
1138 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1139 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1140 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1141 # this option is superseded by the HAVE_DOT option below. This is only a
1142 # fallback. It is recommended to install and use dot, since it yields more
1145 CLASS_DIAGRAMS = YES
1147 # You can define message sequence charts within doxygen comments using the \msc
1148 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1149 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1150 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1151 # be found in the default search path.
1155 # If set to YES, the inheritance and collaboration graphs will hide
1156 # inheritance and usage relations if the target is undocumented
1157 # or is not a class.
1159 HIDE_UNDOC_RELATIONS = YES
1161 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1162 # available from the path. This tool is part of Graphviz, a graph visualization
1163 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1164 # have no effect if this option is set to NO (the default)
1168 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1169 # will generate a graph for each documented class showing the direct and
1170 # indirect inheritance relations. Setting this tag to YES will force the
1171 # the CLASS_DIAGRAMS tag to NO.
1175 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1176 # will generate a graph for each documented class showing the direct and
1177 # indirect implementation dependencies (inheritance, containment, and
1178 # class references variables) of the class with other documented classes.
1180 COLLABORATION_GRAPH = YES
1182 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1183 # will generate a graph for groups, showing the direct groups dependencies
1187 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1188 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1193 # If set to YES, the inheritance and collaboration graphs will show the
1194 # relations between templates and their instances.
1196 TEMPLATE_RELATIONS = NO
1198 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1199 # tags are set to YES then doxygen will generate a graph for each documented
1200 # file showing the direct and indirect include dependencies of the file with
1201 # other documented files.
1205 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1206 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1207 # documented header file showing the documented files that directly or
1208 # indirectly include this file.
1210 INCLUDED_BY_GRAPH = YES
1212 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1213 # generate a call dependency graph for every global function or class method.
1214 # Note that enabling this option will significantly increase the time of a run.
1215 # So in most cases it will be better to enable call graphs for selected
1216 # functions only using the \callgraph command.
1220 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1221 # generate a caller dependency graph for every global function or class method.
1222 # Note that enabling this option will significantly increase the time of a run.
1223 # So in most cases it will be better to enable caller graphs for selected
1224 # functions only using the \callergraph command.
1228 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1229 # will graphical hierarchy of all classes instead of a textual one.
1231 GRAPHICAL_HIERARCHY = YES
1233 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1234 # then doxygen will show the dependencies a directory has on other directories
1235 # in a graphical way. The dependency relations are determined by the #include
1236 # relations between the files in the directories.
1238 DIRECTORY_GRAPH = YES
1240 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1241 # generated by dot. Possible values are png, jpg, or gif
1242 # If left blank png will be used.
1244 DOT_IMAGE_FORMAT = png
1246 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1247 # found. If left blank, it is assumed the dot tool can be found in the path.
1251 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1252 # contain dot files that are included in the documentation (see the
1253 # \dotfile command).
1257 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1258 # nodes that will be shown in the graph. If the number of nodes in a graph
1259 # becomes larger than this value, doxygen will truncate the graph, which is
1260 # visualized by representing a node as a red box. Note that doxygen if the number
1261 # of direct children of the root node in a graph is already larger than
1262 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1263 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1265 DOT_GRAPH_MAX_NODES = 50
1267 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1268 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1269 # from the root by following a path via at most 3 edges will be shown. Nodes
1270 # that lay further from the root node will be omitted. Note that setting this
1271 # option to 1 or 2 may greatly reduce the computation time needed for large
1272 # code bases. Also note that the size of a graph can be further restricted by
1273 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1275 MAX_DOT_GRAPH_DEPTH = 0
1277 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1278 # background. This is disabled by default, which results in a white background.
1279 # Warning: Depending on the platform used, enabling this option may lead to
1280 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1283 DOT_TRANSPARENT = NO
1285 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1286 # files in one run (i.e. multiple -o and -T options on the command line). This
1287 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1288 # support this, this feature is disabled by default.
1290 DOT_MULTI_TARGETS = NO
1292 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1293 # generate a legend page explaining the meaning of the various boxes and
1294 # arrows in the dot generated graphs.
1296 GENERATE_LEGEND = YES
1298 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1299 # remove the intermediate dot files that are used to generate
1300 # the various graphs.
1304 #---------------------------------------------------------------------------
1305 # Configuration::additions related to the search engine
1306 #---------------------------------------------------------------------------
1308 # The SEARCHENGINE tag specifies whether or not a search engine should be
1309 # used. If set to NO the values of all tags below this one will be ignored.