annotate doxygen_config @ 81:f1f849d31272 extractapp

book_id as string
author Zoe Hong <zhong@mpiwg-berlin.mpg.de>
date Thu, 23 Apr 2015 14:58:27 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
81
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1 # Doxyfile 1.8.9.1
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
3 # This file describes the settings to be used by the documentation system
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
4 # doxygen (www.doxygen.org) for a project.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
5 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
6 # All text after a double hash (##) is considered a comment and is placed in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
7 # front of the TAG it is preceding.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
8 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
9 # All text after a single hash (#) is considered a comment and will be ignored.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
10 # The format is:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
11 # TAG = value [value, ...]
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
12 # For lists, items can also be appended using:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
13 # TAG += value [value, ...]
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
14 # Values that contain spaces should be placed between quotes (\" \").
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
15
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
16 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
17 # Project related configuration options
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
18 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
19
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
20 # This tag specifies the encoding used for all characters in the config file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
21 # that follow. The default is UTF-8 which is also the encoding used for all text
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
24 # for the list of possible encodings.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
25 # The default value is: UTF-8.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
26
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
27 DOXYFILE_ENCODING = UTF-8
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
28
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
30 # double-quotes, unless you are using Doxywizard) that should identify the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
31 # project for which the documentation is generated. This name is used in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
32 # title of most generated pages and in a few other places.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
33 # The default value is: My Project.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
34
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
35 PROJECT_NAME = "Extraction Interface (draft)"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
36
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
38 # could be handy for archiving the generated documentation or if some version
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
39 # control system is used.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
40
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
41 PROJECT_NUMBER = 0.1
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
42
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
44 # for a project that appears at the top of each page and should give viewer a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
45 # quick idea about the purpose of the project. Keep the description short.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
46
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
47 PROJECT_BRIEF =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
48
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
50 # in the documentation. The maximum height of the logo should not exceed 55
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
52 # the logo to the output directory.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
53
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
54 PROJECT_LOGO =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
55
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
57 # into which the generated documentation will be written. If a relative path is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
58 # entered, it will be relative to the location where doxygen was started. If
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
59 # left blank the current directory will be used.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
60
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
61 OUTPUT_DIRECTORY = doc/
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
62
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
64 # directories (in 2 levels) under the output directory of each output format and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
65 # will distribute the generated files over these directories. Enabling this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
66 # option can be useful when feeding doxygen a huge amount of source files, where
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
67 # putting all generated files in the same directory would otherwise causes
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
68 # performance problems for the file system.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
69 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
70
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
71 CREATE_SUBDIRS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
72
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
76 # U+3044.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
77 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
78
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
79 ALLOW_UNICODE_NAMES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
80
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
82 # documentation generated by doxygen is written. Doxygen will use this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
83 # information to generate all constant output in the proper language.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
91 # Ukrainian and Vietnamese.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
92 # The default value is: English.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
93
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
94 OUTPUT_LANGUAGE = English
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
95
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
97 # descriptions after the members that are listed in the file and class
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
98 # documentation (similar to Javadoc). Set to NO to disable this.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
99 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
100
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
101 BRIEF_MEMBER_DESC = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
102
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
104 # description of a member or function before the detailed description
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
105 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
107 # brief descriptions will be completely suppressed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
108 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
109
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
110 REPEAT_BRIEF = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
111
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
112 # This tag implements a quasi-intelligent brief description abbreviator that is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
113 # used to form the text in various listings. Each string in this list, if found
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
114 # as the leading text of the brief description, will be stripped from the text
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
115 # and the result, after processing the whole list, is used as the annotated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
116 # text. Otherwise, the brief description is used as-is. If left blank, the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
117 # following values are used ($name is automatically replaced with the name of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
118 # the entity):The $name class, The $name widget, The $name file, is, provides,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
119 # specifies, contains, represents, a, an and the.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
120
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
121 ABBREVIATE_BRIEF =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
122
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
124 # doxygen will generate a detailed section even if there is only a brief
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
125 # description.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
126 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
127
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
128 ALWAYS_DETAILED_SEC = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
129
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
131 # inherited members of a class in the documentation of that class as if those
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
132 # members were ordinary class members. Constructors, destructors and assignment
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
133 # operators of the base classes will not be shown.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
134 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
135
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
136 INLINE_INHERITED_MEMB = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
137
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
139 # before files name in the file list and in the header files. If set to NO the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
140 # shortest path that makes the file name unique will be used
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
141 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
142
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
143 FULL_PATH_NAMES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
144
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
146 # Stripping is only done if one of the specified strings matches the left-hand
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
147 # part of the path. The tag can be used to show relative paths in the file list.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
148 # If left blank the directory from which doxygen is run is used as the path to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
149 # strip.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
150 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
151 # Note that you can specify absolute paths here, but also relative paths, which
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
152 # will be relative from the directory where doxygen is started.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
154
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
155 STRIP_FROM_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
156
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
158 # path mentioned in the documentation of a class, which tells the reader which
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
159 # header file to include in order to use a class. If left blank only the name of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
160 # the header file containing the class definition is used. Otherwise one should
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
161 # specify the list of include paths that are normally passed to the compiler
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
162 # using the -I flag.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
163
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
164 STRIP_FROM_INC_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
165
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
167 # less readable) file names. This can be useful is your file systems doesn't
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
168 # support long names like on DOS, Mac, or CD-ROM.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
169 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
170
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
171 SHORT_NAMES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
172
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
174 # first line (until the first dot) of a Javadoc-style comment as the brief
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
176 # style comments (thus requiring an explicit @brief command for a brief
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
177 # description.)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
178 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
179
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
180 JAVADOC_AUTOBRIEF = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
181
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
183 # line (until the first dot) of a Qt-style comment as the brief description. If
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
185 # requiring an explicit \brief command for a brief description.)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
186 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
187
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
188 QT_AUTOBRIEF = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
189
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
192 # a brief description. This used to be the default behavior. The new default is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
193 # to treat a multi-line C++ comment block as a detailed description. Set this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
194 # tag to YES if you prefer the old behavior instead.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
195 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
196 # Note that setting this tag to YES also means that rational rose comments are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
197 # not recognized any more.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
198 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
199
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
200 MULTILINE_CPP_IS_BRIEF = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
201
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
203 # documentation from any documented member that it re-implements.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
204 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
205
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
206 INHERIT_DOCS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
207
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
209 # page for each member. If set to NO, the documentation of a member will be part
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
210 # of the file/class/namespace that contains it.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
211 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
212
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
213 SEPARATE_MEMBER_PAGES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
214
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
216 # uses this value to replace tabs by spaces in code fragments.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
217 # Minimum value: 1, maximum value: 16, default value: 4.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
218
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
219 TAB_SIZE = 4
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
220
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
221 # This tag can be used to specify a number of aliases that act as commands in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
222 # the documentation. An alias has the form:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
223 # name=value
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
224 # For example adding
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
225 # "sideeffect=@par Side Effects:\n"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
226 # will allow you to put the command \sideeffect (or @sideeffect) in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
227 # documentation, which will result in a user-defined paragraph with heading
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
228 # "Side Effects:". You can put \n's in the value part of an alias to insert
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
229 # newlines.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
230
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
231 ALIASES =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
232
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
234 # A mapping has the form "name=value". For example adding "class=itcl::class"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
235 # will allow you to use the command class in the itcl::class meaning.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
236
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
237 TCL_SUBST =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
238
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
240 # only. Doxygen will then generate output that is more tailored for C. For
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
241 # instance, some of the names that are used will be different. The list of all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
242 # members will be omitted, etc.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
243 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
244
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
245 OPTIMIZE_OUTPUT_FOR_C = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
246
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
248 # Python sources only. Doxygen will then generate output that is more tailored
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
249 # for that language. For instance, namespaces will be presented as packages,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
250 # qualified scopes will look different, etc.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
251 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
252
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
253 OPTIMIZE_OUTPUT_JAVA = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
254
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
256 # sources. Doxygen will then generate output that is tailored for Fortran.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
257 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
258
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
259 OPTIMIZE_FOR_FORTRAN = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
260
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
262 # sources. Doxygen will then generate output that is tailored for VHDL.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
263 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
264
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
265 OPTIMIZE_OUTPUT_VHDL = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
266
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
267 # Doxygen selects the parser to use depending on the extension of the files it
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
268 # parses. With this tag you can assign which parser to use for a given
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
269 # extension. Doxygen has a built-in mapping, but you can override or extend it
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
270 # using this tag. The format is ext=language, where ext is a file extension, and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
274 # Fortran. In the later case the parser tries to guess whether the code is fixed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
275 # or free formatted code, this is the default for Fortran type files), VHDL. For
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
278 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
279 # Note: For files without extension you can use no_extension as a placeholder.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
280 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
282 # the files are not read by doxygen.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
283
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
284 EXTENSION_MAPPING =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
285
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
287 # according to the Markdown format, which allows for more readable
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
289 # The output of markdown processing is further processed by doxygen, so you can
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
291 # case of backward compatibilities issues.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
292 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
293
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
294 MARKDOWN_SUPPORT = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
295
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
296 # When enabled doxygen tries to link words that correspond to documented
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
297 # classes, or namespaces to their corresponding documentation. Such a link can
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
298 # be prevented in individual cases by putting a % sign in front of the word or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
299 # globally by setting AUTOLINK_SUPPORT to NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
300 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
301
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
302 AUTOLINK_SUPPORT = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
303
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
305 # to include (a tag file for) the STL sources as input, then you should set this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
306 # tag to YES in order to let doxygen match functions declarations and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
307 # definitions whose arguments contain STL classes (e.g. func(std::string);
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
308 # versus func(std::string) {}). This also make the inheritance and collaboration
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
309 # diagrams that involve STL classes more complete and accurate.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
310 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
311
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
312 BUILTIN_STL_SUPPORT = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
313
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
315 # enable parsing support.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
316 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
317
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
318 CPP_CLI_SUPPORT = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
319
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
322 # will parse them like normal C++ but will assume all classes use public instead
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
323 # of private inheritance when no explicit protection keyword is present.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
324 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
325
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
326 SIP_SUPPORT = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
327
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
328 # For Microsoft's IDL there are propget and propput attributes to indicate
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
329 # getter and setter methods for a property. Setting this option to YES will make
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
330 # doxygen to replace the get and set methods by a property in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
331 # This will only work if the methods are indeed getting or setting a simple
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
332 # type. If this is not the case, or you want to show the methods anyway, you
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
333 # should set this option to NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
334 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
335
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
336 IDL_PROPERTY_SUPPORT = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
337
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
339 # tag is set to YES then doxygen will reuse the documentation of the first
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
340 # member in the group (if any) for the other members of the group. By default
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
341 # all members of a group must be documented explicitly.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
342 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
343
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
344 DISTRIBUTE_GROUP_DOC = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
345
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
347 # (for instance a group of public functions) to be put as a subgroup of that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
348 # type (e.g. under the Public Functions section). Set it to NO to prevent
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
349 # subgrouping. Alternatively, this can be done per class using the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
350 # \nosubgrouping command.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
351 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
352
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
353 SUBGROUPING = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
354
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
356 # are shown inside the group in which they are included (e.g. using \ingroup)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
358 # and RTF).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
359 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
360 # Note that this feature does not work in combination with
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
361 # SEPARATE_MEMBER_PAGES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
362 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
363
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
364 INLINE_GROUPED_CLASSES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
365
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
367 # with only public data fields or simple typedef fields will be shown inline in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
368 # the documentation of the scope in which they are defined (i.e. file,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
369 # namespace, or group documentation), provided this scope is documented. If set
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
371 # Man pages) or section (for LaTeX and RTF).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
372 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
373
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
374 INLINE_SIMPLE_STRUCTS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
375
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
377 # enum is documented as struct, union, or enum with the name of the typedef. So
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
379 # with name TypeT. When disabled the typedef will appear as a member of a file,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
380 # namespace, or class. And the struct will be named TypeS. This can typically be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
381 # useful for C code in case the coding convention dictates that all compound
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
382 # types are typedef'ed and only the typedef is referenced, never the tag name.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
383 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
384
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
385 TYPEDEF_HIDES_STRUCT = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
386
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
388 # cache is used to resolve symbols given their name and scope. Since this can be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
389 # an expensive process and often the same symbol appears multiple times in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
391 # doxygen will become slower. If the cache is too large, memory is wasted. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
394 # symbols. At the end of a run doxygen will report the cache usage and suggest
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
395 # the optimal cache size from a speed point of view.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
396 # Minimum value: 0, maximum value: 9, default value: 0.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
397
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
398 LOOKUP_CACHE_SIZE = 0
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
399
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
400 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
401 # Build related configuration options
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
402 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
403
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
404 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
405 # documentation are documented, even if no documentation was available. Private
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
406 # class members and static file members will be hidden unless the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
408 # Note: This will also disable the warnings about undocumented members that are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
409 # normally produced when WARNINGS is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
410 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
411
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
412 EXTRACT_ALL = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
413
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
414 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
415 # be included in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
416 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
417
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
418 EXTRACT_PRIVATE = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
419
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
420 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
421 # scope will be included in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
422 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
423
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
424 EXTRACT_PACKAGE = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
425
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
426 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
427 # included in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
428 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
429
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
430 EXTRACT_STATIC = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
431
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
433 # locally in source files will be included in the documentation. If set to NO,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
434 # only classes defined in header files are included. Does not have any effect
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
435 # for Java sources.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
436 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
437
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
438 EXTRACT_LOCAL_CLASSES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
439
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
440 # This flag is only useful for Objective-C code. If set to YES, local methods,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
441 # which are defined in the implementation section but not in the interface are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
442 # included in the documentation. If set to NO, only methods in the interface are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
443 # included.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
444 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
445
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
446 EXTRACT_LOCAL_METHODS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
447
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
448 # If this flag is set to YES, the members of anonymous namespaces will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
449 # extracted and appear in the documentation as a namespace called
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
451 # the file that contains the anonymous namespace. By default anonymous namespace
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
452 # are hidden.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
453 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
454
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
455 EXTRACT_ANON_NSPACES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
456
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
458 # undocumented members inside documented classes or files. If set to NO these
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
459 # members will be included in the various overviews, but no documentation
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
461 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
462
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
463 HIDE_UNDOC_MEMBERS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
464
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
466 # undocumented classes that are normally visible in the class hierarchy. If set
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
467 # to NO, these classes will be included in the various overviews. This option
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
468 # has no effect if EXTRACT_ALL is enabled.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
469 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
470
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
471 HIDE_UNDOC_CLASSES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
472
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
474 # (class|struct|union) declarations. If set to NO, these declarations will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
475 # included in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
476 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
477
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
478 HIDE_FRIEND_COMPOUNDS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
479
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
481 # documentation blocks found inside the body of a function. If set to NO, these
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
482 # blocks will be appended to the function's detailed documentation block.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
483 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
484
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
485 HIDE_IN_BODY_DOCS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
486
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
488 # \internal command is included. If the tag is set to NO then the documentation
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
489 # will be excluded. Set it to YES to include the internal documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
490 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
491
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
492 INTERNAL_DOCS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
493
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
495 # names in lower-case letters. If set to YES, upper-case letters are also
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
496 # allowed. This is useful if you have classes or files whose names only differ
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
497 # in case and if your file system supports case sensitive file names. Windows
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
498 # and Mac users are advised to set this option to NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
499 # The default value is: system dependent.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
500
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
501 CASE_SENSE_NAMES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
502
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
504 # their full class and namespace scopes in the documentation. If set to YES, the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
505 # scope will be hidden.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
506 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
507
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
508 HIDE_SCOPE_NAMES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
509
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
510 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
511 # append additional text to a page's title, such as Class Reference. If set to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
512 # YES the compound reference will be hidden.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
513 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
514
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
515 HIDE_COMPOUND_REFERENCE= NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
516
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
517 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
518 # the files that are included by a file in the documentation of that file.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
519 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
520
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
521 SHOW_INCLUDE_FILES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
522
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
523 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
524 # grouped member an include statement to the documentation, telling the reader
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
525 # which file to include in order to use the member.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
526 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
527
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
528 SHOW_GROUPED_MEMB_INC = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
529
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
530 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
531 # files with double quotes in the documentation rather than with sharp brackets.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
532 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
533
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
534 FORCE_LOCAL_INCLUDES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
535
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
536 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
537 # documentation for inline members.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
538 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
539
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
540 INLINE_INFO = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
541
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
542 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
543 # (detailed) documentation of file and class members alphabetically by member
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
544 # name. If set to NO, the members will appear in declaration order.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
545 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
546
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
547 SORT_MEMBER_DOCS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
548
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
549 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
550 # descriptions of file, namespace and class members alphabetically by member
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
551 # name. If set to NO, the members will appear in declaration order. Note that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
552 # this will also influence the order of the classes in the class list.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
553 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
554
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
555 SORT_BRIEF_DOCS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
556
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
557 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
558 # (brief and detailed) documentation of class members so that constructors and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
559 # destructors are listed first. If set to NO the constructors will appear in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
560 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
561 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
562 # member documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
563 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
564 # detailed member documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
565 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
566
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
567 SORT_MEMBERS_CTORS_1ST = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
568
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
569 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
570 # of group names into alphabetical order. If set to NO the group names will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
571 # appear in their defined order.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
572 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
573
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
574 SORT_GROUP_NAMES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
575
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
576 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
577 # fully-qualified names, including namespaces. If set to NO, the class list will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
578 # be sorted only by class name, not including the namespace part.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
579 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
580 # Note: This option applies only to the class list, not to the alphabetical
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
581 # list.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
582 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
583
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
584 SORT_BY_SCOPE_NAME = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
585
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
586 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
587 # type resolution of all parameters of a function it will reject a match between
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
588 # the prototype and the implementation of a member function even if there is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
589 # only one candidate or it is obvious which candidate to choose by doing a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
590 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
591 # accept a match between prototype and implementation in such cases.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
592 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
593
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
594 STRICT_PROTO_MATCHING = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
595
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
596 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
597 # list. This list is created by putting \todo commands in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
598 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
599
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
600 GENERATE_TODOLIST = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
601
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
602 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
603 # list. This list is created by putting \test commands in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
604 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
605
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
606 GENERATE_TESTLIST = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
607
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
608 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
609 # list. This list is created by putting \bug commands in the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
610 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
611
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
612 GENERATE_BUGLIST = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
613
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
614 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
615 # the deprecated list. This list is created by putting \deprecated commands in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
616 # the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
617 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
618
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
619 GENERATE_DEPRECATEDLIST= YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
620
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
621 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
622 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
623 # ... \endcond blocks.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
624
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
625 ENABLED_SECTIONS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
626
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
627 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
628 # initial value of a variable or macro / define can have for it to appear in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
629 # documentation. If the initializer consists of more lines than specified here
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
630 # it will be hidden. Use a value of 0 to hide initializers completely. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
631 # appearance of the value of individual variables and macros / defines can be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
632 # controlled using \showinitializer or \hideinitializer command in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
633 # documentation regardless of this setting.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
634 # Minimum value: 0, maximum value: 10000, default value: 30.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
635
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
636 MAX_INITIALIZER_LINES = 30
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
637
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
638 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
639 # the bottom of the documentation of classes and structs. If set to YES, the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
640 # list will mention the files that were used to generate the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
641 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
642
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
643 SHOW_USED_FILES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
644
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
645 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
646 # will remove the Files entry from the Quick Index and from the Folder Tree View
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
647 # (if specified).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
648 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
649
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
650 SHOW_FILES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
651
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
652 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
653 # page. This will remove the Namespaces entry from the Quick Index and from the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
654 # Folder Tree View (if specified).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
655 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
656
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
657 SHOW_NAMESPACES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
658
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
659 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
660 # doxygen should invoke to get the current version for each file (typically from
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
661 # the version control system). Doxygen will invoke the program by executing (via
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
662 # popen()) the command command input-file, where command is the value of the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
663 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
664 # by doxygen. Whatever the program writes to standard output is used as the file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
665 # version. For an example see the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
666
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
667 FILE_VERSION_FILTER =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
668
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
669 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
670 # by doxygen. The layout file controls the global structure of the generated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
671 # output files in an output format independent way. To create the layout file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
672 # that represents doxygen's defaults, run doxygen with the -l option. You can
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
673 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
674 # will be used as the name of the layout file.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
675 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
676 # Note that if you run doxygen from a directory containing a file called
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
677 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
678 # tag is left empty.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
679
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
680 LAYOUT_FILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
681
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
682 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
683 # the reference definitions. This must be a list of .bib files. The .bib
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
684 # extension is automatically appended if omitted. This requires the bibtex tool
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
685 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
686 # For LaTeX the style of the bibliography can be controlled using
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
687 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
688 # search path. See also \cite for info how to create references.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
689
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
690 CITE_BIB_FILES =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
691
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
692 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
693 # Configuration options related to warning and progress messages
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
694 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
695
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
696 # The QUIET tag can be used to turn on/off the messages that are generated to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
697 # standard output by doxygen. If QUIET is set to YES this implies that the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
698 # messages are off.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
699 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
700
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
701 QUIET = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
702
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
703 # The WARNINGS tag can be used to turn on/off the warning messages that are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
704 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
705 # this implies that the warnings are on.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
706 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
707 # Tip: Turn warnings on while writing the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
708 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
709
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
710 WARNINGS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
711
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
712 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
713 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
714 # will automatically be disabled.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
715 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
716
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
717 WARN_IF_UNDOCUMENTED = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
718
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
719 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
720 # potential errors in the documentation, such as not documenting some parameters
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
721 # in a documented function, or documenting parameters that don't exist or using
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
722 # markup commands wrongly.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
723 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
724
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
725 WARN_IF_DOC_ERROR = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
726
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
727 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
728 # are documented, but have no documentation for their parameters or return
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
729 # value. If set to NO, doxygen will only warn about wrong or incomplete
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
730 # parameter documentation, but not about the absence of documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
731 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
732
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
733 WARN_NO_PARAMDOC = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
734
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
735 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
736 # can produce. The string should contain the $file, $line, and $text tags, which
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
737 # will be replaced by the file and line number from which the warning originated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
738 # and the warning text. Optionally the format may contain $version, which will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
739 # be replaced by the version of the file (if it could be obtained via
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
740 # FILE_VERSION_FILTER)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
741 # The default value is: $file:$line: $text.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
742
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
743 WARN_FORMAT = "$file:$line: $text"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
744
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
745 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
746 # messages should be written. If left blank the output is written to standard
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
747 # error (stderr).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
748
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
749 WARN_LOGFILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
750
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
751 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
752 # Configuration options related to the input files
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
753 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
754
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
755 # The INPUT tag is used to specify the files and/or directories that contain
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
756 # documented source files. You may enter file names like myfile.cpp or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
757 # directories like /usr/src/myproject. Separate the files or directories with
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
758 # spaces.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
759 # Note: If this tag is empty the current directory is searched.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
760
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
761 INPUT =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
762
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
763 # This tag can be used to specify the character encoding of the source files
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
764 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
765 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
766 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
767 # possible encodings.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
768 # The default value is: UTF-8.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
769
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
770 INPUT_ENCODING = UTF-8
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
771
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
772 # If the value of the INPUT tag contains directories, you can use the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
773 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
774 # *.h) to filter out the source-files in the directories. If left blank the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
775 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
776 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
777 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
778 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
779 # *.qsf, *.as and *.js.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
780
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
781 FILE_PATTERNS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
782
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
783 # The RECURSIVE tag can be used to specify whether or not subdirectories should
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
784 # be searched for input files as well.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
785 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
786
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
787 RECURSIVE = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
788
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
789 # The EXCLUDE tag can be used to specify files and/or directories that should be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
790 # excluded from the INPUT source files. This way you can easily exclude a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
791 # subdirectory from a directory tree whose root is specified with the INPUT tag.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
792 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
793 # Note that relative paths are relative to the directory from which doxygen is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
794 # run.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
795
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
796 EXCLUDE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
797
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
798 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
799 # directories that are symbolic links (a Unix file system feature) are excluded
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
800 # from the input.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
801 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
802
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
803 EXCLUDE_SYMLINKS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
804
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
805 # If the value of the INPUT tag contains directories, you can use the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
806 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
807 # certain files from those directories.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
808 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
809 # Note that the wildcards are matched against the file with absolute path, so to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
810 # exclude all test directories for example use the pattern */test/*
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
811
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
812 EXCLUDE_PATTERNS = *.sql
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
813
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
814 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
815 # (namespaces, classes, functions, etc.) that should be excluded from the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
816 # output. The symbol name can be a fully qualified name, a word, or if the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
817 # wildcard * is used, a substring. Examples: ANamespace, AClass,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
818 # AClass::ANamespace, ANamespace::*Test
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
819 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
820 # Note that the wildcards are matched against the file with absolute path, so to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
821 # exclude all test directories use the pattern */test/*
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
822
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
823 EXCLUDE_SYMBOLS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
824
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
825 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
826 # that contain example code fragments that are included (see the \include
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
827 # command).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
828
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
829 EXAMPLE_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
830
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
831 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
832 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
833 # *.h) to filter out the source-files in the directories. If left blank all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
834 # files are included.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
835
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
836 EXAMPLE_PATTERNS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
837
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
838 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
839 # searched for input files to be used with the \include or \dontinclude commands
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
840 # irrespective of the value of the RECURSIVE tag.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
841 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
842
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
843 EXAMPLE_RECURSIVE = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
844
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
845 # The IMAGE_PATH tag can be used to specify one or more files or directories
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
846 # that contain images that are to be included in the documentation (see the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
847 # \image command).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
848
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
849 IMAGE_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
850
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
851 # The INPUT_FILTER tag can be used to specify a program that doxygen should
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
852 # invoke to filter for each input file. Doxygen will invoke the filter program
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
853 # by executing (via popen()) the command:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
854 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
855 # <filter> <input-file>
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
856 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
857 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
858 # name of an input file. Doxygen will then use the output that the filter
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
859 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
860 # will be ignored.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
861 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
862 # Note that the filter must not add or remove lines; it is applied before the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
863 # code is scanned, but not when the output code is generated. If lines are added
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
864 # or removed, the anchors will not be placed correctly.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
865
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
866 INPUT_FILTER =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
867
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
868 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
869 # basis. Doxygen will compare the file name with each pattern and apply the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
870 # filter if there is a match. The filters are a list of the form: pattern=filter
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
871 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
872 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
873 # patterns match the file name, INPUT_FILTER is applied.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
874
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
875 FILTER_PATTERNS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
876
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
877 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
878 # INPUT_FILTER) will also be used to filter the input files that are used for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
879 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
880 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
881
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
882 FILTER_SOURCE_FILES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
883
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
884 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
885 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
886 # it is also possible to disable source filtering for a specific pattern using
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
887 # *.ext= (so without naming a filter).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
888 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
889
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
890 FILTER_SOURCE_PATTERNS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
891
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
892 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
893 # is part of the input, its contents will be placed on the main page
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
894 # (index.html). This can be useful if you have a project on for instance GitHub
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
895 # and want to reuse the introduction page also for the doxygen output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
896
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
897 USE_MDFILE_AS_MAINPAGE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
898
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
899 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
900 # Configuration options related to source browsing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
901 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
902
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
903 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
904 # generated. Documented entities will be cross-referenced with these sources.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
905 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
906 # Note: To get rid of all source code in the generated output, make sure that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
907 # also VERBATIM_HEADERS is set to NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
908 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
909
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
910 SOURCE_BROWSER = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
911
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
912 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
913 # classes and enums directly into the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
914 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
915
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
916 INLINE_SOURCES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
917
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
918 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
919 # special comment blocks from generated source code fragments. Normal C, C++ and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
920 # Fortran comments will always remain visible.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
921 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
922
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
923 STRIP_CODE_COMMENTS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
924
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
925 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
926 # function all documented functions referencing it will be listed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
927 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
928
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
929 REFERENCED_BY_RELATION = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
930
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
931 # If the REFERENCES_RELATION tag is set to YES then for each documented function
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
932 # all documented entities called/used by that function will be listed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
933 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
934
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
935 REFERENCES_RELATION = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
936
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
937 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
938 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
939 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
940 # link to the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
941 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
942
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
943 REFERENCES_LINK_SOURCE = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
944
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
945 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
946 # source code will show a tooltip with additional information such as prototype,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
947 # brief description and links to the definition and documentation. Since this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
948 # will make the HTML file larger and loading of large files a bit slower, you
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
949 # can opt to disable this feature.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
950 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
951 # This tag requires that the tag SOURCE_BROWSER is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
952
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
953 SOURCE_TOOLTIPS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
954
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
955 # If the USE_HTAGS tag is set to YES then the references to source code will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
956 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
957 # source browser. The htags tool is part of GNU's global source tagging system
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
958 # (see http://www.gnu.org/software/global/global.html). You will need version
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
959 # 4.8.6 or higher.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
960 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
961 # To use it do the following:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
962 # - Install the latest version of global
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
963 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
964 # - Make sure the INPUT points to the root of the source tree
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
965 # - Run doxygen as normal
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
966 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
967 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
968 # tools must be available from the command line (i.e. in the search path).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
969 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
970 # The result: instead of the source browser generated by doxygen, the links to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
971 # source code will now point to the output of htags.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
972 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
973 # This tag requires that the tag SOURCE_BROWSER is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
974
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
975 USE_HTAGS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
976
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
977 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
978 # verbatim copy of the header file for each class for which an include is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
979 # specified. Set to NO to disable this.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
980 # See also: Section \class.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
981 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
982
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
983 VERBATIM_HEADERS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
984
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
985 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
986 # Configuration options related to the alphabetical class index
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
987 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
988
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
989 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
990 # compounds will be generated. Enable this if the project contains a lot of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
991 # classes, structs, unions or interfaces.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
992 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
993
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
994 ALPHABETICAL_INDEX = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
995
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
996 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
997 # which the alphabetical index list will be split.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
998 # Minimum value: 1, maximum value: 20, default value: 5.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
999 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1000
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1001 COLS_IN_ALPHA_INDEX = 5
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1002
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1003 # In case all classes in a project start with a common prefix, all classes will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1004 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1005 # can be used to specify a prefix (or a list of prefixes) that should be ignored
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1006 # while generating the index headers.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1007 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1008
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1009 IGNORE_PREFIX =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1010
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1011 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1012 # Configuration options related to the HTML output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1013 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1014
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1015 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1016 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1017
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1018 GENERATE_HTML = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1019
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1020 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1021 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1022 # it.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1023 # The default directory is: html.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1024 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1025
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1026 HTML_OUTPUT = html
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1027
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1028 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1029 # generated HTML page (for example: .htm, .php, .asp).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1030 # The default value is: .html.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1031 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1032
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1033 HTML_FILE_EXTENSION = .html
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1034
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1035 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1036 # each generated HTML page. If the tag is left blank doxygen will generate a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1037 # standard header.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1038 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1039 # To get valid HTML the header file that includes any scripts and style sheets
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1040 # that doxygen needs, which is dependent on the configuration options used (e.g.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1041 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1042 # default header using
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1043 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1044 # YourConfigFile
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1045 # and then modify the file new_header.html. See also section "Doxygen usage"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1046 # for information on how to generate the default header that doxygen normally
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1047 # uses.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1048 # Note: The header is subject to change so you typically have to regenerate the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1049 # default header when upgrading to a newer version of doxygen. For a description
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1050 # of the possible markers and block names see the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1051 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1052
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1053 HTML_HEADER =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1054
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1055 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1056 # generated HTML page. If the tag is left blank doxygen will generate a standard
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1057 # footer. See HTML_HEADER for more information on how to generate a default
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1058 # footer and what special commands can be used inside the footer. See also
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1059 # section "Doxygen usage" for information on how to generate the default footer
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1060 # that doxygen normally uses.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1061 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1062
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1063 HTML_FOOTER =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1064
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1065 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1066 # sheet that is used by each HTML page. It can be used to fine-tune the look of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1067 # the HTML output. If left blank doxygen will generate a default style sheet.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1068 # See also section "Doxygen usage" for information on how to generate the style
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1069 # sheet that doxygen normally uses.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1070 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1071 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1072 # obsolete.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1073 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1074
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1075 HTML_STYLESHEET =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1076
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1077 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1078 # cascading style sheets that are included after the standard style sheets
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1079 # created by doxygen. Using this option one can overrule certain style aspects.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1080 # This is preferred over using HTML_STYLESHEET since it does not replace the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1081 # standard style sheet and is therefore more robust against future updates.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1082 # Doxygen will copy the style sheet files to the output directory.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1083 # Note: The order of the extra style sheet files is of importance (e.g. the last
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1084 # style sheet in the list overrules the setting of the previous ones in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1085 # list). For an example see the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1086 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1087
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1088 HTML_EXTRA_STYLESHEET =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1089
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1090 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1091 # other source files which should be copied to the HTML output directory. Note
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1092 # that these files will be copied to the base HTML output directory. Use the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1093 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1094 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1095 # files will be copied as-is; there are no commands or markers available.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1096 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1097
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1098 HTML_EXTRA_FILES =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1099
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1100 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1101 # will adjust the colors in the style sheet and background images according to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1102 # this color. Hue is specified as an angle on a colorwheel, see
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1103 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1104 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1105 # purple, and 360 is red again.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1106 # Minimum value: 0, maximum value: 359, default value: 220.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1107 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1108
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1109 HTML_COLORSTYLE_HUE = 220
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1110
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1111 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1112 # in the HTML output. For a value of 0 the output will use grayscales only. A
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1113 # value of 255 will produce the most vivid colors.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1114 # Minimum value: 0, maximum value: 255, default value: 100.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1115 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1116
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1117 HTML_COLORSTYLE_SAT = 100
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1118
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1119 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1120 # luminance component of the colors in the HTML output. Values below 100
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1121 # gradually make the output lighter, whereas values above 100 make the output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1122 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1123 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1124 # change the gamma.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1125 # Minimum value: 40, maximum value: 240, default value: 80.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1126 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1127
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1128 HTML_COLORSTYLE_GAMMA = 80
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1129
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1130 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1131 # page will contain the date and time when the page was generated. Setting this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1132 # to YES can help to show when doxygen was last run and thus if the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1133 # documentation is up to date.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1134 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1135 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1136
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1137 HTML_TIMESTAMP = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1138
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1139 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1140 # documentation will contain sections that can be hidden and shown after the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1141 # page has loaded.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1142 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1143 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1144
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1145 HTML_DYNAMIC_SECTIONS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1146
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1147 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1148 # shown in the various tree structured indices initially; the user can expand
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1149 # and collapse entries dynamically later on. Doxygen will expand the tree to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1150 # such a level that at most the specified number of entries are visible (unless
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1151 # a fully collapsed tree already exceeds this amount). So setting the number of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1152 # entries 1 will produce a full collapsed tree by default. 0 is a special value
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1153 # representing an infinite number of entries and will result in a full expanded
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1154 # tree by default.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1155 # Minimum value: 0, maximum value: 9999, default value: 100.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1156 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1157
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1158 HTML_INDEX_NUM_ENTRIES = 100
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1159
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1160 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1161 # generated that can be used as input for Apple's Xcode 3 integrated development
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1162 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1163 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1164 # Makefile in the HTML output directory. Running make will produce the docset in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1165 # that directory and running make install will install the docset in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1166 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1167 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1168 # for more information.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1169 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1170 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1171
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1172 GENERATE_DOCSET = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1173
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1174 # This tag determines the name of the docset feed. A documentation feed provides
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1175 # an umbrella under which multiple documentation sets from a single provider
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1176 # (such as a company or product suite) can be grouped.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1177 # The default value is: Doxygen generated docs.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1178 # This tag requires that the tag GENERATE_DOCSET is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1179
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1180 DOCSET_FEEDNAME = "Doxygen generated docs"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1181
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1182 # This tag specifies a string that should uniquely identify the documentation
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1183 # set bundle. This should be a reverse domain-name style string, e.g.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1184 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1185 # The default value is: org.doxygen.Project.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1186 # This tag requires that the tag GENERATE_DOCSET is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1187
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1188 DOCSET_BUNDLE_ID = org.doxygen.Project
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1189
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1190 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1191 # the documentation publisher. This should be a reverse domain-name style
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1192 # string, e.g. com.mycompany.MyDocSet.documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1193 # The default value is: org.doxygen.Publisher.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1194 # This tag requires that the tag GENERATE_DOCSET is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1195
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1196 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1197
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1198 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1199 # The default value is: Publisher.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1200 # This tag requires that the tag GENERATE_DOCSET is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1201
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1202 DOCSET_PUBLISHER_NAME = Publisher
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1203
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1204 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1205 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1206 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1207 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1208 # Windows.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1209 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1210 # The HTML Help Workshop contains a compiler that can convert all HTML output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1211 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1212 # files are now used as the Windows 98 help format, and will replace the old
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1213 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1214 # HTML files also contain an index, a table of contents, and you can search for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1215 # words in the documentation. The HTML workshop also contains a viewer for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1216 # compressed HTML files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1217 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1218 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1219
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1220 GENERATE_HTMLHELP = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1221
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1222 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1223 # file. You can add a path in front of the file if the result should not be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1224 # written to the html output directory.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1225 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1226
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1227 CHM_FILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1228
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1229 # The HHC_LOCATION tag can be used to specify the location (absolute path
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1230 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1231 # doxygen will try to run the HTML help compiler on the generated index.hhp.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1232 # The file has to be specified with full path.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1234
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1235 HHC_LOCATION =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1236
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1237 # The GENERATE_CHI flag controls if a separate .chi index file is generated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1238 # (YES) or that it should be included in the master .chm file (NO).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1239 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1240 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1241
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1242 GENERATE_CHI = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1243
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1244 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1245 # and project file content.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1246 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1247
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1248 CHM_INDEX_ENCODING =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1249
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1250 # The BINARY_TOC flag controls whether a binary table of contents is generated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1251 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1252 # enables the Previous and Next buttons.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1253 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1254 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1255
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1256 BINARY_TOC = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1257
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1258 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1259 # the table of contents of the HTML help documentation and to the tree view.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1260 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1261 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1262
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1263 TOC_EXPAND = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1264
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1265 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1266 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1267 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1268 # (.qch) of the generated HTML documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1269 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1270 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1271
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1272 GENERATE_QHP = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1273
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1274 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1275 # the file name of the resulting .qch file. The path specified is relative to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1276 # the HTML output folder.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1277 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1278
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1279 QCH_FILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1280
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1281 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1282 # Project output. For more information please see Qt Help Project / Namespace
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1283 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1284 # The default value is: org.doxygen.Project.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1285 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1286
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1287 QHP_NAMESPACE = org.doxygen.Project
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1288
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1289 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1290 # Help Project output. For more information please see Qt Help Project / Virtual
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1291 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1292 # folders).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1293 # The default value is: doc.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1294 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1295
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1296 QHP_VIRTUAL_FOLDER = doc
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1297
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1298 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1299 # filter to add. For more information please see Qt Help Project / Custom
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1300 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1301 # filters).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1302 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1303
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1304 QHP_CUST_FILTER_NAME =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1305
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1306 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1307 # custom filter to add. For more information please see Qt Help Project / Custom
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1308 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1309 # filters).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1310 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1311
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1312 QHP_CUST_FILTER_ATTRS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1313
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1314 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1315 # project's filter section matches. Qt Help Project / Filter Attributes (see:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1316 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1317 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1318
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1319 QHP_SECT_FILTER_ATTRS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1320
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1321 # The QHG_LOCATION tag can be used to specify the location of Qt's
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1322 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1323 # generated .qhp file.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1324 # This tag requires that the tag GENERATE_QHP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1325
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1326 QHG_LOCATION =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1327
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1328 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1329 # generated, together with the HTML files, they form an Eclipse help plugin. To
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1330 # install this plugin and make it available under the help contents menu in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1331 # Eclipse, the contents of the directory containing the HTML and XML files needs
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1332 # to be copied into the plugins directory of eclipse. The name of the directory
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1333 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1334 # After copying Eclipse needs to be restarted before the help appears.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1335 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1336 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1337
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1338 GENERATE_ECLIPSEHELP = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1339
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1340 # A unique identifier for the Eclipse help plugin. When installing the plugin
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1341 # the directory name containing the HTML and XML files should also have this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1342 # name. Each documentation set should have its own identifier.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1343 # The default value is: org.doxygen.Project.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1344 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1345
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1346 ECLIPSE_DOC_ID = org.doxygen.Project
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1347
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1348 # If you want full control over the layout of the generated HTML pages it might
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1349 # be necessary to disable the index and replace it with your own. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1350 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1351 # of each HTML page. A value of NO enables the index and the value YES disables
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1352 # it. Since the tabs in the index contain the same information as the navigation
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1353 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1354 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1355 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1356
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1357 DISABLE_INDEX = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1358
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1359 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1360 # structure should be generated to display hierarchical information. If the tag
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1361 # value is set to YES, a side panel will be generated containing a tree-like
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1362 # index structure (just like the one that is generated for HTML Help). For this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1363 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1364 # (i.e. any modern browser). Windows users are probably better off using the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1365 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1366 # further fine-tune the look of the index. As an example, the default style
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1367 # sheet generated by doxygen has an example that shows how to put an image at
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1368 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1369 # the same information as the tab index, you could consider setting
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1370 # DISABLE_INDEX to YES when enabling this option.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1371 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1372 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1373
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1374 GENERATE_TREEVIEW = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1375
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1376 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1377 # doxygen will group on one line in the generated HTML documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1378 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1379 # Note that a value of 0 will completely suppress the enum values from appearing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1380 # in the overview section.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1381 # Minimum value: 0, maximum value: 20, default value: 4.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1382 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1383
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1384 ENUM_VALUES_PER_LINE = 4
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1385
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1386 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1387 # to set the initial width (in pixels) of the frame in which the tree is shown.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1388 # Minimum value: 0, maximum value: 1500, default value: 250.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1389 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1390
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1391 TREEVIEW_WIDTH = 250
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1392
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1393 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1394 # external symbols imported via tag files in a separate window.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1395 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1396 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1397
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1398 EXT_LINKS_IN_WINDOW = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1399
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1400 # Use this tag to change the font size of LaTeX formulas included as images in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1401 # the HTML documentation. When you change the font size after a successful
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1402 # doxygen run you need to manually remove any form_*.png images from the HTML
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1403 # output directory to force them to be regenerated.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1404 # Minimum value: 8, maximum value: 50, default value: 10.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1405 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1406
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1407 FORMULA_FONTSIZE = 10
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1408
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1409 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1410 # generated for formulas are transparent PNGs. Transparent PNGs are not
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1411 # supported properly for IE 6.0, but are supported on all modern browsers.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1412 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1413 # Note that when changing this option you need to delete any form_*.png files in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1414 # the HTML output directory before the changes have effect.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1415 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1416 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1417
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1418 FORMULA_TRANSPARENT = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1419
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1420 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1421 # http://www.mathjax.org) which uses client side Javascript for the rendering
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1422 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1423 # installed or if you want to formulas look prettier in the HTML output. When
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1424 # enabled you may also need to install MathJax separately and configure the path
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1425 # to it using the MATHJAX_RELPATH option.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1426 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1427 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1428
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1429 USE_MATHJAX = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1430
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1431 # When MathJax is enabled you can set the default output format to be used for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1432 # the MathJax output. See the MathJax site (see:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1433 # http://docs.mathjax.org/en/latest/output.html) for more details.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1434 # Possible values are: HTML-CSS (which is slower, but has the best
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1435 # compatibility), NativeMML (i.e. MathML) and SVG.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1436 # The default value is: HTML-CSS.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1437 # This tag requires that the tag USE_MATHJAX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1438
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1439 MATHJAX_FORMAT = HTML-CSS
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1440
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1441 # When MathJax is enabled you need to specify the location relative to the HTML
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1442 # output directory using the MATHJAX_RELPATH option. The destination directory
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1443 # should contain the MathJax.js script. For instance, if the mathjax directory
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1444 # is located at the same level as the HTML output directory, then
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1445 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1446 # Content Delivery Network so you can quickly see the result without installing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1447 # MathJax. However, it is strongly recommended to install a local copy of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1448 # MathJax from http://www.mathjax.org before deployment.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1449 # The default value is: http://cdn.mathjax.org/mathjax/latest.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1450 # This tag requires that the tag USE_MATHJAX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1451
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1452 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1453
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1454 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1455 # extension names that should be enabled during MathJax rendering. For example
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1456 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1457 # This tag requires that the tag USE_MATHJAX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1458
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1459 MATHJAX_EXTENSIONS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1460
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1461 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1462 # of code that will be used on startup of the MathJax code. See the MathJax site
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1463 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1464 # example see the documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1465 # This tag requires that the tag USE_MATHJAX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1466
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1467 MATHJAX_CODEFILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1468
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1469 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1470 # the HTML output. The underlying search engine uses javascript and DHTML and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1471 # should work on any modern browser. Note that when using HTML help
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1472 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1473 # there is already a search function so this one should typically be disabled.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1474 # For large projects the javascript based search engine can be slow, then
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1475 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1476 # search using the keyboard; to jump to the search box use <access key> + S
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1477 # (what the <access key> is depends on the OS and browser, but it is typically
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1478 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1479 # key> to jump into the search results window, the results can be navigated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1480 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1481 # the search. The filter options can be selected when the cursor is inside the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1482 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1483 # to select a filter and <Enter> or <escape> to activate or cancel the filter
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1484 # option.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1485 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1486 # This tag requires that the tag GENERATE_HTML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1487
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1488 SEARCHENGINE = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1489
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1490 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1491 # implemented using a web server instead of a web client using Javascript. There
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1492 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1493 # setting. When disabled, doxygen will generate a PHP script for searching and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1494 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1495 # and searching needs to be provided by external tools. See the section
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1496 # "External Indexing and Searching" for details.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1497 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1498 # This tag requires that the tag SEARCHENGINE is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1499
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1500 SERVER_BASED_SEARCH = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1501
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1502 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1503 # script for searching. Instead the search results are written to an XML file
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1504 # which needs to be processed by an external indexer. Doxygen will invoke an
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1505 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1506 # search results.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1507 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1508 # Doxygen ships with an example indexer (doxyindexer) and search engine
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1509 # (doxysearch.cgi) which are based on the open source search engine library
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1510 # Xapian (see: http://xapian.org/).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1511 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1512 # See the section "External Indexing and Searching" for details.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1513 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1514 # This tag requires that the tag SEARCHENGINE is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1515
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1516 EXTERNAL_SEARCH = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1517
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1518 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1519 # which will return the search results when EXTERNAL_SEARCH is enabled.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1520 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1521 # Doxygen ships with an example indexer (doxyindexer) and search engine
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1522 # (doxysearch.cgi) which are based on the open source search engine library
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1523 # Xapian (see: http://xapian.org/). See the section "External Indexing and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1524 # Searching" for details.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1525 # This tag requires that the tag SEARCHENGINE is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1526
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1527 SEARCHENGINE_URL =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1528
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1529 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1530 # search data is written to a file for indexing by an external tool. With the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1531 # SEARCHDATA_FILE tag the name of this file can be specified.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1532 # The default file is: searchdata.xml.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1533 # This tag requires that the tag SEARCHENGINE is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1534
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1535 SEARCHDATA_FILE = searchdata.xml
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1536
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1537 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1538 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1539 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1540 # projects and redirect the results back to the right project.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1541 # This tag requires that the tag SEARCHENGINE is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1542
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1543 EXTERNAL_SEARCH_ID =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1544
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1545 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1546 # projects other than the one defined by this configuration file, but that are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1547 # all added to the same external search index. Each project needs to have a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1548 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1549 # to a relative location where the documentation can be found. The format is:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1550 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1551 # This tag requires that the tag SEARCHENGINE is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1552
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1553 EXTRA_SEARCH_MAPPINGS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1554
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1555 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1556 # Configuration options related to the LaTeX output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1557 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1558
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1559 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1560 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1561
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1562 GENERATE_LATEX = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1563
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1564 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1565 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1566 # it.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1567 # The default directory is: latex.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1568 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1569
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1570 LATEX_OUTPUT = latex
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1571
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1572 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1573 # invoked.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1574 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1575 # Note that when enabling USE_PDFLATEX this option is only used for generating
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1576 # bitmaps for formulas in the HTML output, but not in the Makefile that is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1577 # written to the output directory.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1578 # The default file is: latex.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1579 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1580
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1581 LATEX_CMD_NAME = latex
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1582
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1583 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1584 # index for LaTeX.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1585 # The default file is: makeindex.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1586 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1587
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1588 MAKEINDEX_CMD_NAME = makeindex
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1589
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1590 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1591 # documents. This may be useful for small projects and may help to save some
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1592 # trees in general.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1593 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1594 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1595
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1596 COMPACT_LATEX = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1597
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1598 # The PAPER_TYPE tag can be used to set the paper type that is used by the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1599 # printer.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1600 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1601 # 14 inches) and executive (7.25 x 10.5 inches).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1602 # The default value is: a4.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1603 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1604
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1605 PAPER_TYPE = a4
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1606
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1607 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1608 # that should be included in the LaTeX output. The package can be specified just
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1609 # by its name or with the correct syntax as to be used with the LaTeX
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1610 # \usepackage command. To get the times font for instance you can specify :
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1611 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1612 # To use the option intlimits with the amsmath package you can specify:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1613 # EXTRA_PACKAGES=[intlimits]{amsmath}
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1614 # If left blank no extra packages will be included.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1615 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1616
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1617 EXTRA_PACKAGES =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1618
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1619 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1620 # generated LaTeX document. The header should contain everything until the first
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1621 # chapter. If it is left blank doxygen will generate a standard header. See
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1622 # section "Doxygen usage" for information on how to let doxygen write the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1623 # default header to a separate file.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1624 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1625 # Note: Only use a user-defined header if you know what you are doing! The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1626 # following commands have a special meaning inside the header: $title,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1627 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1628 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1629 # string, for the replacement values of the other commands the user is referred
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1630 # to HTML_HEADER.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1632
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1633 LATEX_HEADER =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1634
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1635 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1636 # generated LaTeX document. The footer should contain everything after the last
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1637 # chapter. If it is left blank doxygen will generate a standard footer. See
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1638 # LATEX_HEADER for more information on how to generate a default footer and what
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1639 # special commands can be used inside the footer.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1640 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1641 # Note: Only use a user-defined footer if you know what you are doing!
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1642 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1643
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1644 LATEX_FOOTER =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1645
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1646 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1647 # LaTeX style sheets that are included after the standard style sheets created
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1648 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1649 # will copy the style sheet files to the output directory.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1650 # Note: The order of the extra style sheet files is of importance (e.g. the last
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1651 # style sheet in the list overrules the setting of the previous ones in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1652 # list).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1653 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1654
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1655 LATEX_EXTRA_STYLESHEET =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1656
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1657 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1658 # other source files which should be copied to the LATEX_OUTPUT output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1659 # directory. Note that the files will be copied as-is; there are no commands or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1660 # markers available.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1661 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1662
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1663 LATEX_EXTRA_FILES =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1664
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1665 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1666 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1667 # contain links (just like the HTML output) instead of page references. This
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1668 # makes the output suitable for online browsing using a PDF viewer.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1669 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1671
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1672 PDF_HYPERLINKS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1673
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1674 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1675 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1676 # higher quality PDF documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1677 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1678 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1679
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1680 USE_PDFLATEX = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1681
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1682 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1683 # command to the generated LaTeX files. This will instruct LaTeX to keep running
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1684 # if errors occur, instead of asking the user for help. This option is also used
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1685 # when generating formulas in HTML.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1686 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1688
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1689 LATEX_BATCHMODE = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1690
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1691 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1692 # index chapters (such as File Index, Compound Index, etc.) in the output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1693 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1694 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1695
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1696 LATEX_HIDE_INDICES = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1697
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1698 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1699 # code with syntax highlighting in the LaTeX output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1700 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1701 # Note that which sources are shown also depends on other settings such as
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1702 # SOURCE_BROWSER.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1703 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1705
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1706 LATEX_SOURCE_CODE = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1707
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1708 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1709 # bibliography, e.g. plainnat, or ieeetr. See
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1710 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1711 # The default value is: plain.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1712 # This tag requires that the tag GENERATE_LATEX is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1713
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1714 LATEX_BIB_STYLE = plain
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1715
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1716 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1717 # Configuration options related to the RTF output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1718 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1719
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1720 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1721 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1722 # readers/editors.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1723 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1724
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1725 GENERATE_RTF = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1726
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1727 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1728 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1729 # it.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1730 # The default directory is: rtf.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1731 # This tag requires that the tag GENERATE_RTF is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1732
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1733 RTF_OUTPUT = rtf
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1734
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1735 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1736 # documents. This may be useful for small projects and may help to save some
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1737 # trees in general.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1738 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1739 # This tag requires that the tag GENERATE_RTF is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1740
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1741 COMPACT_RTF = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1742
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1743 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1744 # contain hyperlink fields. The RTF file will contain links (just like the HTML
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1745 # output) instead of page references. This makes the output suitable for online
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1746 # browsing using Word or some other Word compatible readers that support those
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1747 # fields.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1748 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1749 # Note: WordPad (write) and others do not support links.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1750 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1751 # This tag requires that the tag GENERATE_RTF is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1752
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1753 RTF_HYPERLINKS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1754
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1755 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1756 # file, i.e. a series of assignments. You only have to provide replacements,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1757 # missing definitions are set to their default value.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1758 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1759 # See also section "Doxygen usage" for information on how to generate the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1760 # default style sheet that doxygen normally uses.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1761 # This tag requires that the tag GENERATE_RTF is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1762
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1763 RTF_STYLESHEET_FILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1764
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1765 # Set optional variables used in the generation of an RTF document. Syntax is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1766 # similar to doxygen's config file. A template extensions file can be generated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1767 # using doxygen -e rtf extensionFile.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1768 # This tag requires that the tag GENERATE_RTF is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1769
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1770 RTF_EXTENSIONS_FILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1771
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1772 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1773 # with syntax highlighting in the RTF output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1774 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1775 # Note that which sources are shown also depends on other settings such as
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1776 # SOURCE_BROWSER.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1777 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1778 # This tag requires that the tag GENERATE_RTF is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1779
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1780 RTF_SOURCE_CODE = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1781
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1782 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1783 # Configuration options related to the man page output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1784 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1785
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1786 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1787 # classes and files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1788 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1789
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1790 GENERATE_MAN = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1791
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1792 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1793 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1794 # it. A directory man3 will be created inside the directory specified by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1795 # MAN_OUTPUT.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1796 # The default directory is: man.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1797 # This tag requires that the tag GENERATE_MAN is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1798
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1799 MAN_OUTPUT = man
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1800
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1801 # The MAN_EXTENSION tag determines the extension that is added to the generated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1802 # man pages. In case the manual section does not start with a number, the number
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1803 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1804 # optional.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1805 # The default value is: .3.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1806 # This tag requires that the tag GENERATE_MAN is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1807
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1808 MAN_EXTENSION = .3
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1809
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1810 # The MAN_SUBDIR tag determines the name of the directory created within
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1811 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1812 # MAN_EXTENSION with the initial . removed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1813 # This tag requires that the tag GENERATE_MAN is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1814
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1815 MAN_SUBDIR =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1816
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1817 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1818 # will generate one additional man file for each entity documented in the real
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1819 # man page(s). These additional files only source the real man page, but without
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1820 # them the man command would be unable to find the correct page.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1821 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1822 # This tag requires that the tag GENERATE_MAN is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1823
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1824 MAN_LINKS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1825
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1826 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1827 # Configuration options related to the XML output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1828 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1829
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1830 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1831 # captures the structure of the code including all documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1832 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1833
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1834 GENERATE_XML = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1835
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1836 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1837 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1838 # it.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1839 # The default directory is: xml.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1840 # This tag requires that the tag GENERATE_XML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1841
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1842 XML_OUTPUT = xml
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1843
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1844 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1845 # listings (including syntax highlighting and cross-referencing information) to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1846 # the XML output. Note that enabling this will significantly increase the size
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1847 # of the XML output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1848 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1849 # This tag requires that the tag GENERATE_XML is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1850
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1851 XML_PROGRAMLISTING = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1852
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1853 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1854 # Configuration options related to the DOCBOOK output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1855 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1856
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1857 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1858 # that can be used to generate PDF.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1859 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1860
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1861 GENERATE_DOCBOOK = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1862
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1863 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1864 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1865 # front of it.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1866 # The default directory is: docbook.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1867 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1868
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1869 DOCBOOK_OUTPUT = docbook
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1870
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1871 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1872 # program listings (including syntax highlighting and cross-referencing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1873 # information) to the DOCBOOK output. Note that enabling this will significantly
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1874 # increase the size of the DOCBOOK output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1875 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1876 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1877
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1878 DOCBOOK_PROGRAMLISTING = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1879
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1880 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1881 # Configuration options for the AutoGen Definitions output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1882 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1883
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1884 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1885 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1886 # structure of the code including all documentation. Note that this feature is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1887 # still experimental and incomplete at the moment.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1888 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1889
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1890 GENERATE_AUTOGEN_DEF = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1891
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1892 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1893 # Configuration options related to the Perl module output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1894 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1895
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1896 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1897 # file that captures the structure of the code including all documentation.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1898 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1899 # Note that this feature is still experimental and incomplete at the moment.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1900 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1901
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1902 GENERATE_PERLMOD = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1903
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1904 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1905 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1906 # output from the Perl module output.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1907 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1908 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1909
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1910 PERLMOD_LATEX = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1911
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1912 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1913 # formatted so it can be parsed by a human reader. This is useful if you want to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1914 # understand what is going on. On the other hand, if this tag is set to NO, the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1915 # size of the Perl module output will be much smaller and Perl will parse it
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1916 # just the same.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1917 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1918 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1919
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1920 PERLMOD_PRETTY = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1921
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1922 # The names of the make variables in the generated doxyrules.make file are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1923 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1924 # so different doxyrules.make files included by the same Makefile don't
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1925 # overwrite each other's variables.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1926 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1927
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1928 PERLMOD_MAKEVAR_PREFIX =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1929
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1930 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1931 # Configuration options related to the preprocessor
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1932 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1933
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1934 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1935 # C-preprocessor directives found in the sources and include files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1936 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1937
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1938 ENABLE_PREPROCESSING = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1939
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1940 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1941 # in the source code. If set to NO, only conditional compilation will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1942 # performed. Macro expansion can be done in a controlled way by setting
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1943 # EXPAND_ONLY_PREDEF to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1944 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1945 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1946
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1947 MACRO_EXPANSION = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1948
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1949 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1950 # the macro expansion is limited to the macros specified with the PREDEFINED and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1951 # EXPAND_AS_DEFINED tags.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1952 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1953 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1954
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1955 EXPAND_ONLY_PREDEF = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1956
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1957 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1958 # INCLUDE_PATH will be searched if a #include is found.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1959 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1960 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1961
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1962 SEARCH_INCLUDES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1963
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1964 # The INCLUDE_PATH tag can be used to specify one or more directories that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1965 # contain include files that are not input files but should be processed by the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1966 # preprocessor.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1967 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1968
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1969 INCLUDE_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1970
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1971 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1972 # patterns (like *.h and *.hpp) to filter out the header-files in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1973 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1974 # used.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1975 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1976
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1977 INCLUDE_FILE_PATTERNS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1978
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1979 # The PREDEFINED tag can be used to specify one or more macro names that are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1980 # defined before the preprocessor is started (similar to the -D option of e.g.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1981 # gcc). The argument of the tag is a list of macros of the form: name or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1982 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1983 # is assumed. To prevent a macro definition from being undefined via #undef or
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1984 # recursively expanded use the := operator instead of the = operator.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1985 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1986
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1987 PREDEFINED =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1988
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1989 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1990 # tag can be used to specify a list of macro names that should be expanded. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1991 # macro definition that is found in the sources will be used. Use the PREDEFINED
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1992 # tag if you want to use a different macro definition that overrules the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1993 # definition found in the source code.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1994 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1995
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1996 EXPAND_AS_DEFINED =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1997
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1998 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
1999 # remove all references to function-like macros that are alone on a line, have
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2000 # an all uppercase name, and do not end with a semicolon. Such function macros
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2001 # are typically used for boiler-plate code, and will confuse the parser if not
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2002 # removed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2003 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2004 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2005
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2006 SKIP_FUNCTION_MACROS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2007
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2008 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2009 # Configuration options related to external references
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2010 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2011
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2012 # The TAGFILES tag can be used to specify one or more tag files. For each tag
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2013 # file the location of the external documentation should be added. The format of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2014 # a tag file without this location is as follows:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2015 # TAGFILES = file1 file2 ...
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2016 # Adding location for the tag files is done as follows:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2017 # TAGFILES = file1=loc1 "file2 = loc2" ...
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2018 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2019 # section "Linking to external documentation" for more information about the use
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2020 # of tag files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2021 # Note: Each tag file must have a unique name (where the name does NOT include
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2022 # the path). If a tag file is not located in the directory in which doxygen is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2023 # run, you must also specify the path to the tagfile here.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2024
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2025 TAGFILES =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2026
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2027 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2028 # tag file that is based on the input files it reads. See section "Linking to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2029 # external documentation" for more information about the usage of tag files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2030
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2031 GENERATE_TAGFILE =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2032
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2033 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2034 # the class index. If set to NO, only the inherited external classes will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2035 # listed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2036 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2037
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2038 ALLEXTERNALS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2039
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2040 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2041 # in the modules index. If set to NO, only the current project's groups will be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2042 # listed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2043 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2044
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2045 EXTERNAL_GROUPS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2046
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2047 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2048 # the related pages index. If set to NO, only the current project's pages will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2049 # be listed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2050 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2051
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2052 EXTERNAL_PAGES = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2053
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2054 # The PERL_PATH should be the absolute path and name of the perl script
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2055 # interpreter (i.e. the result of 'which perl').
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2056 # The default file (with absolute path) is: /usr/bin/perl.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2057
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2058 PERL_PATH = /usr/bin/perl
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2059
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2060 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2061 # Configuration options related to the dot tool
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2062 #---------------------------------------------------------------------------
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2063
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2064 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2065 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2066 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2067 # disabled, but it is recommended to install and use dot, since it yields more
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2068 # powerful graphs.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2069 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2070
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2071 CLASS_DIAGRAMS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2072
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2073 # You can define message sequence charts within doxygen comments using the \msc
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2074 # command. Doxygen will then run the mscgen tool (see:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2075 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2076 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2077 # the mscgen tool resides. If left empty the tool is assumed to be found in the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2078 # default search path.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2079
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2080 MSCGEN_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2081
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2082 # You can include diagrams made with dia in doxygen documentation. Doxygen will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2083 # then run dia to produce the diagram and insert it in the documentation. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2084 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2085 # If left empty dia is assumed to be found in the default search path.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2086
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2087 DIA_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2088
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2089 # If set to YES the inheritance and collaboration graphs will hide inheritance
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2090 # and usage relations if the target is undocumented or is not a class.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2091 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2092
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2093 HIDE_UNDOC_RELATIONS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2094
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2095 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2096 # available from the path. This tool is part of Graphviz (see:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2097 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2098 # Bell Labs. The other options in this section have no effect if this option is
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2099 # set to NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2100 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2101
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2102 HAVE_DOT = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2103
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2104 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2105 # to run in parallel. When set to 0 doxygen will base this on the number of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2106 # processors available in the system. You can set it explicitly to a value
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2107 # larger than 0 to get control over the balance between CPU load and processing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2108 # speed.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2109 # Minimum value: 0, maximum value: 32, default value: 0.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2110 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2111
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2112 DOT_NUM_THREADS = 0
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2113
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2114 # When you want a differently looking font in the dot files that doxygen
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2115 # generates you can specify the font name using DOT_FONTNAME. You need to make
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2116 # sure dot is able to find the font, which can be done by putting it in a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2117 # standard location or by setting the DOTFONTPATH environment variable or by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2118 # setting DOT_FONTPATH to the directory containing the font.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2119 # The default value is: Helvetica.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2120 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2121
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2122 DOT_FONTNAME = Helvetica
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2123
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2124 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2125 # dot graphs.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2126 # Minimum value: 4, maximum value: 24, default value: 10.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2127 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2128
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2129 DOT_FONTSIZE = 10
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2130
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2131 # By default doxygen will tell dot to use the default font as specified with
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2132 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2133 # the path where dot can find it using this tag.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2134 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2135
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2136 DOT_FONTPATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2137
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2138 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2139 # each documented class showing the direct and indirect inheritance relations.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2140 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2141 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2142 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2143
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2144 CLASS_GRAPH = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2145
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2146 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2147 # graph for each documented class showing the direct and indirect implementation
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2148 # dependencies (inheritance, containment, and class references variables) of the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2149 # class with other documented classes.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2150 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2151 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2152
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2153 COLLABORATION_GRAPH = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2154
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2155 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2156 # groups, showing the direct groups dependencies.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2157 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2158 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2159
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2160 GROUP_GRAPHS = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2161
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2162 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2163 # collaboration diagrams in a style similar to the OMG's Unified Modeling
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2164 # Language.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2165 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2166 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2167
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2168 UML_LOOK = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2169
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2170 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2171 # class node. If there are many fields or methods and many nodes the graph may
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2172 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2173 # number of items for each type to make the size more manageable. Set this to 0
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2174 # for no limit. Note that the threshold may be exceeded by 50% before the limit
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2175 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2176 # but if the number exceeds 15, the total amount of fields shown is limited to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2177 # 10.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2178 # Minimum value: 0, maximum value: 100, default value: 10.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2179 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2180
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2181 UML_LIMIT_NUM_FIELDS = 10
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2182
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2183 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2184 # collaboration graphs will show the relations between templates and their
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2185 # instances.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2186 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2187 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2188
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2189 TEMPLATE_RELATIONS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2190
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2191 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2192 # YES then doxygen will generate a graph for each documented file showing the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2193 # direct and indirect include dependencies of the file with other documented
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2194 # files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2195 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2196 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2197
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2198 INCLUDE_GRAPH = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2199
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2200 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2201 # set to YES then doxygen will generate a graph for each documented file showing
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2202 # the direct and indirect include dependencies of the file with other documented
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2203 # files.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2204 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2205 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2206
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2207 INCLUDED_BY_GRAPH = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2208
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2209 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2210 # dependency graph for every global function or class method.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2211 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2212 # Note that enabling this option will significantly increase the time of a run.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2213 # So in most cases it will be better to enable call graphs for selected
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2214 # functions only using the \callgraph command. Disabling a call graph can be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2215 # accomplished by means of the command \hidecallgraph.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2216 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2217 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2218
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2219 CALL_GRAPH = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2220
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2221 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2222 # dependency graph for every global function or class method.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2223 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2224 # Note that enabling this option will significantly increase the time of a run.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2225 # So in most cases it will be better to enable caller graphs for selected
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2226 # functions only using the \callergraph command. Disabling a caller graph can be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2227 # accomplished by means of the command \hidecallergraph.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2228 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2229 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2230
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2231 CALLER_GRAPH = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2232
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2233 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2234 # hierarchy of all classes instead of a textual one.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2235 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2236 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2237
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2238 GRAPHICAL_HIERARCHY = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2239
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2240 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2241 # dependencies a directory has on other directories in a graphical way. The
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2242 # dependency relations are determined by the #include relations between the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2243 # files in the directories.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2244 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2245 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2246
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2247 DIRECTORY_GRAPH = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2248
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2249 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2250 # generated by dot. For an explanation of the image formats see the section
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2251 # output formats in the documentation of the dot tool (Graphviz (see:
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2252 # http://www.graphviz.org/)).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2253 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2254 # to make the SVG files visible in IE 9+ (other browsers do not have this
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2255 # requirement).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2256 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2257 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2258 # png:gdiplus:gdiplus.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2259 # The default value is: png.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2260 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2261
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2262 DOT_IMAGE_FORMAT = png
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2263
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2264 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2265 # enable generation of interactive SVG images that allow zooming and panning.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2266 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2267 # Note that this requires a modern browser other than Internet Explorer. Tested
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2268 # and working are Firefox, Chrome, Safari, and Opera.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2269 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2270 # the SVG files visible. Older versions of IE do not have SVG support.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2271 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2272 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2273
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2274 INTERACTIVE_SVG = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2275
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2276 # The DOT_PATH tag can be used to specify the path where the dot tool can be
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2277 # found. If left blank, it is assumed the dot tool can be found in the path.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2278 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2279
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2280 DOT_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2281
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2282 # The DOTFILE_DIRS tag can be used to specify one or more directories that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2283 # contain dot files that are included in the documentation (see the \dotfile
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2284 # command).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2285 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2286
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2287 DOTFILE_DIRS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2288
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2289 # The MSCFILE_DIRS tag can be used to specify one or more directories that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2290 # contain msc files that are included in the documentation (see the \mscfile
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2291 # command).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2292
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2293 MSCFILE_DIRS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2294
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2295 # The DIAFILE_DIRS tag can be used to specify one or more directories that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2296 # contain dia files that are included in the documentation (see the \diafile
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2297 # command).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2298
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2299 DIAFILE_DIRS =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2300
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2301 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2302 # path where java can find the plantuml.jar file. If left blank, it is assumed
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2303 # PlantUML is not used or called during a preprocessing step. Doxygen will
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2304 # generate a warning when it encounters a \startuml command in this case and
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2305 # will not generate output for the diagram.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2306
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2307 PLANTUML_JAR_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2308
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2309 # When using plantuml, the specified paths are searched for files specified by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2310 # the !include statement in a plantuml block.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2311
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2312 PLANTUML_INCLUDE_PATH =
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2313
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2314 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2315 # that will be shown in the graph. If the number of nodes in a graph becomes
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2316 # larger than this value, doxygen will truncate the graph, which is visualized
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2317 # by representing a node as a red box. Note that doxygen if the number of direct
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2318 # children of the root node in a graph is already larger than
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2319 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2320 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2321 # Minimum value: 0, maximum value: 10000, default value: 50.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2322 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2323
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2324 DOT_GRAPH_MAX_NODES = 50
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2325
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2326 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2327 # generated by dot. A depth value of 3 means that only nodes reachable from the
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2328 # root by following a path via at most 3 edges will be shown. Nodes that lay
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2329 # further from the root node will be omitted. Note that setting this option to 1
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2330 # or 2 may greatly reduce the computation time needed for large code bases. Also
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2331 # note that the size of a graph can be further restricted by
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2332 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2333 # Minimum value: 0, maximum value: 1000, default value: 0.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2334 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2335
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2336 MAX_DOT_GRAPH_DEPTH = 0
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2337
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2338 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2339 # background. This is disabled by default, because dot on Windows does not seem
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2340 # to support this out of the box.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2341 #
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2342 # Warning: Depending on the platform used, enabling this option may lead to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2343 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2344 # read).
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2345 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2346 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2347
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2348 DOT_TRANSPARENT = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2349
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2350 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2351 # files in one run (i.e. multiple -o and -T options on the command line). This
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2352 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2353 # this, this feature is disabled by default.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2354 # The default value is: NO.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2355 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2356
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2357 DOT_MULTI_TARGETS = NO
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2358
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2359 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2360 # explaining the meaning of the various boxes and arrows in the dot generated
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2361 # graphs.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2362 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2363 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2364
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2365 GENERATE_LEGEND = YES
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2366
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2367 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2368 # files that are used to generate the various graphs.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2369 # The default value is: YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2370 # This tag requires that the tag HAVE_DOT is set to YES.
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2371
f1f849d31272 book_id as string
Zoe Hong <zhong@mpiwg-berlin.mpg.de>
parents:
diff changeset
2372 DOT_CLEANUP = YES