##// END OF EJS Templates
HG_REPOSITORIES » LPP » INSTRUMENTATION » libuc2
RSS

Clone from http://pc-instru.lpp.polytechnique.fr:5000/libuc2

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