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

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

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