Merge lp:~dannf/libdebian-installer/debsync into lp:~ubuntu-core-dev/libdebian-installer/ubuntu
- debsync
- Merge into ubuntu
Proposed by
dann frazier
Status: | Merged |
---|---|
Merged at revision: | 394 |
Proposed branch: | lp:~dannf/libdebian-installer/debsync |
Merge into: | lp:~ubuntu-core-dev/libdebian-installer/ubuntu |
Diff against target: |
3883 lines (+2284/-1030) 13 files modified
debian/changelog (+131/-0) debian/control (+2/-2) doc/Doxyfile.in (+1938/-710) include/debian-installer/system/efi.h (+34/-0) include/debian-installer/system/subarch.h (+1/-1) src/system/Makefile.am (+3/-0) src/system/efi.c (+42/-0) src/system/subarch-arm-linux.c (+16/-15) src/system/subarch-arm64-linux.c (+29/-0) src/system/subarch-mips-linux.c (+85/-134) src/system/subarch-mipsel-linux.c (+0/-156) src/system/subarch-powerpc-linux.c (+1/-0) src/system/subarch-x86-linux.c (+2/-12) |
To merge this branch: | bzr merge lp:~dannf/libdebian-installer/debsync |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Ubuntu Core Development Team | Pending | ||
Review via email: mp+247903@code.launchpad.net |
Commit message
Description of the change
Update the repo w/ the last few ubuntu releases, sync with Debian unstable and drop some ARM cruft.
To post a comment you must log in.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'debian/changelog' |
2 | --- debian/changelog 2014-03-20 13:50:17 +0000 |
3 | +++ debian/changelog 2015-01-28 21:45:05 +0000 |
4 | @@ -1,3 +1,134 @@ |
5 | +libdebian-installer (0.99ubuntu1) UNRELEASED; urgency=medium |
6 | + |
7 | + * Resynchronise with Debian. Remaining changes: |
8 | + - Add Dove SoC subarchitecture. |
9 | + - Add more OMAP4 Panda support. |
10 | + - Add OMAP4 Blaze support. |
11 | + - Add ArmadaXP support. |
12 | + - Add Calxeda Highbank support. |
13 | + - Add Freescale "P4080 DS" and "QEMU e500" support. |
14 | + - Add Calxeda ECX-2000 support. (LP: #1196946) |
15 | + - Add support for EXYNOS5440-based platforms (LP: #1231251) |
16 | + - Add support for the WandBoard quad. |
17 | + - Add support for keystone subarch |
18 | + - Add support for HP ProLiant m800 Server Cartridge (keystone) |
19 | + * The "generic" subarch is now returned for all unknown flavors, |
20 | + so drop explicit matching for generic subarch hardware. |
21 | + * Switch the Armada XP, EXYNOS5 and KeyStone2 to the "generic" subarch. |
22 | + These platforms required special flavor kernel builds in previous |
23 | + Ubuntu releases that are no longer provided. |
24 | + * Drop support for Marvell DB-MV88F6781-BP Development Board. We |
25 | + no longer support the "dove" subarch (Ref: partman-auto changelog). |
26 | + |
27 | + -- dann frazier <dannf@ubuntu.com> Wed, 28 Jan 2015 11:57:45 -0700 |
28 | + |
29 | +libdebian-installer (0.99) unstable; urgency=medium |
30 | + |
31 | + * Replace NULL terminator for the arm map_hardware table, accidentally |
32 | + dropped in 0.92 (Closes: #776488). |
33 | + |
34 | + -- dann frazier <dannf@debian.org> Wed, 28 Jan 2015 10:51:22 -0700 |
35 | + |
36 | +libdebian-installer (0.98) unstable; urgency=low |
37 | + |
38 | + [ Steve McIntyre ] |
39 | + * Recognise the new ignore_uefi flag from partman-efi. |
40 | + * Add myself to uploaders. |
41 | + |
42 | + -- Steve McIntyre <93sam@debian.org> Tue, 25 Nov 2014 17:32:51 +0000 |
43 | + |
44 | +libdebian-installer (0.97) unstable; urgency=low |
45 | + |
46 | + [ Jérémy Bobbio ] |
47 | + * Do not write timesamps in Doxygen generated documentation for |
48 | + reproducibility of the build process (Closes: #762732). |
49 | + |
50 | + -- Christian Perrier <bubulle@debian.org> Thu, 25 Sep 2014 06:39:10 +0200 |
51 | + |
52 | +libdebian-installer (0.96) unstable; urgency=medium |
53 | + |
54 | + * arm64: Detect UEFI based systems as "efi" subarch. |
55 | + |
56 | + -- Ian Campbell <ijc@debian.org> Thu, 04 Sep 2014 21:19:26 +0100 |
57 | + |
58 | +libdebian-installer (0.95) unstable; urgency=medium |
59 | + |
60 | + [ Aurelien Jarno ] |
61 | + * Add ppc64 and ppc64el support, based on a patch from |
62 | + Frederic Bonnard. |
63 | + |
64 | + -- Aurelien Jarno <aurel32@debian.org> Sun, 17 Aug 2014 23:25:04 +0200 |
65 | + |
66 | +libdebian-installer (0.94) unstable; urgency=medium |
67 | + |
68 | + [ Aurelien Jarno ] |
69 | + * Group Loongson 3A and 3B in the same loongson-3 subarchitecture. |
70 | + |
71 | + -- Aurelien Jarno <aurel32@debian.org> Sat, 12 Jul 2014 16:35:02 +0200 |
72 | + |
73 | +libdebian-installer (0.93) unstable; urgency=medium |
74 | + |
75 | + [ Colin Watson ] |
76 | + * Policy version 3.9.5: no changes required. |
77 | + * Upgrade doxygen configuration file using "doxygen -u", suppressing |
78 | + several build warnings. |
79 | + |
80 | + [ Ian Campbell ] |
81 | + * Add support for the Buffalo Linkstation LS-XHL. (Closes: #740787) |
82 | + |
83 | + -- Cyril Brulebois <kibi@debian.org> Fri, 14 Mar 2014 12:33:35 +0100 |
84 | + |
85 | +libdebian-installer (0.92) unstable; urgency=low |
86 | + |
87 | + [ Ian Campbell ] |
88 | + * armel: Add support for "Buffalo Linkstation LS-CHLv2". (Closes: #735452) |
89 | + * armhf/el: Return "generic" subarch for unknown platforms. |
90 | + * arm64: Always return "generic" subarch. |
91 | + |
92 | + -- Colin Watson <cjwatson@debian.org> Mon, 27 Jan 2014 16:21:00 +0000 |
93 | + |
94 | +libdebian-installer (0.91) unstable; urgency=medium |
95 | + |
96 | + * mips, mipsel: rewrite subarch-mips-linux.c: |
97 | + - Use a regex system instead of a two level lookup to provide more |
98 | + flexibility. |
99 | + - Use subarch-mips-linux.c for mipsel, as more and more systems are |
100 | + bi-endian. |
101 | + - Remove non-supported platforms. |
102 | + - Add support for Cavium Octeon platforms. |
103 | + - Detect more Loongson 2E and 2F machines. |
104 | + |
105 | + -- Aurelien Jarno <aurel32@debian.org> Sat, 28 Dec 2013 09:50:51 +0100 |
106 | + |
107 | +libdebian-installer (0.90) unstable; urgency=medium |
108 | + |
109 | + * Add support for Loongson 3A platforms. |
110 | + |
111 | + -- Aurelien Jarno <aurel32@debian.org> Fri, 27 Dec 2013 20:27:38 +0100 |
112 | + |
113 | +libdebian-installer (0.89) unstable; urgency=low |
114 | + |
115 | + * Add support for EXYNOS5440 platforms |
116 | + * Add support for Calxeda Highbank and Midway platforms |
117 | + * Add support for arm64 |
118 | + * Add support for virt subarch for arm32/arm64 guests |
119 | + * Add support for the ARMv8 foundation model |
120 | + * Add support for Applied Micro X-Gene systems |
121 | + |
122 | + -- dann frazier <dannf@debian.org> Mon, 23 Dec 2013 13:43:25 -0700 |
123 | + |
124 | +libdebian-installer (0.88ubuntu6) utopic; urgency=medium |
125 | + |
126 | + * subarch-powerpc-linux.c: Pretend "PowerNV" is "chrp_ibm" for now. |
127 | + |
128 | + -- Adam Conrad <adconrad@ubuntu.com> Tue, 07 Oct 2014 17:46:52 -0600 |
129 | + |
130 | +libdebian-installer (0.88ubuntu5) trusty; urgency=medium |
131 | + |
132 | + * Add support for HP ProLiant m800 Server Cartridge (keystone) |
133 | + |
134 | + -- Manoj Iyer <manoj.iyer@canonical.com> Thu, 19 Jun 2014 12:04:30 -0500 |
135 | + |
136 | libdebian-installer (0.88ubuntu4) trusty; urgency=medium |
137 | |
138 | * Report the Calxeda ECX-2000 as generic-lpae, not generic, to match |
139 | |
140 | === modified file 'debian/control' |
141 | --- debian/control 2013-11-14 22:09:38 +0000 |
142 | +++ debian/control 2015-01-28 21:45:05 +0000 |
143 | @@ -3,9 +3,9 @@ |
144 | Priority: optional |
145 | Maintainer: Ubuntu Installer Team <ubuntu-installer@lists.ubuntu.com> |
146 | XSBC-Original-Maintainer: Debian Install System Team <debian-boot@lists.debian.org> |
147 | -Uploaders: Bastian Blank <waldi@debian.org>, Colin Watson <cjwatson@debian.org>, Christian Perrier <bubulle@debian.org> |
148 | +Uploaders: Bastian Blank <waldi@debian.org>, Colin Watson <cjwatson@debian.org>, Christian Perrier <bubulle@debian.org>, Steve McIntyre <93sam@debian.org> |
149 | Build-Depends: dpkg-dev (>= 1.13.5), debhelper (>= 9), dh-autoreconf, doxygen |
150 | -Standards-Version: 3.9.4 |
151 | +Standards-Version: 3.9.5 |
152 | XS-Debian-Vcs-Browser: http://anonscm.debian.org/gitweb/?p=d-i/libdebian-installer.git |
153 | XS-Debian-Vcs-Git: git://anonscm.debian.org/d-i/libdebian-installer.git |
154 | Vcs-Bzr: http://bazaar.launchpad.net/~ubuntu-core-dev/libdebian-installer/ubuntu |
155 | |
156 | === modified file 'doc/Doxyfile.in' |
157 | --- doc/Doxyfile.in 2003-11-19 09:24:14 +0000 |
158 | +++ doc/Doxyfile.in 2015-01-28 21:45:05 +0000 |
159 | @@ -1,1078 +1,2306 @@ |
160 | -# Doxyfile 1.3.4 |
161 | +# Doxyfile 1.8.6 |
162 | |
163 | # This file describes the settings to be used by the documentation system |
164 | -# doxygen (www.doxygen.org) for a project |
165 | -# |
166 | -# All text after a hash (#) is considered a comment and will be ignored |
167 | +# doxygen (www.doxygen.org) for a project. |
168 | +# |
169 | +# All text after a double hash (##) is considered a comment and is placed in |
170 | +# front of the TAG it is preceding. |
171 | +# |
172 | +# All text after a single hash (#) is considered a comment and will be ignored. |
173 | # The format is: |
174 | -# TAG = value [value, ...] |
175 | -# For lists items can also be appended using: |
176 | -# TAG += value [value, ...] |
177 | -# Values that contain spaces should be placed between quotes (" ") |
178 | +# TAG = value [value, ...] |
179 | +# For lists, items can also be appended using: |
180 | +# TAG += value [value, ...] |
181 | +# Values that contain spaces should be placed between quotes (\" \"). |
182 | |
183 | #--------------------------------------------------------------------------- |
184 | # Project related configuration options |
185 | #--------------------------------------------------------------------------- |
186 | |
187 | -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
188 | -# by quotes) that should identify the project. |
189 | +# This tag specifies the encoding used for all characters in the config file |
190 | +# that follow. The default is UTF-8 which is also the encoding used for all text |
191 | +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
192 | +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
193 | +# for the list of possible encodings. |
194 | +# The default value is: UTF-8. |
195 | + |
196 | +DOXYFILE_ENCODING = UTF-8 |
197 | + |
198 | +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by |
199 | +# double-quotes, unless you are using Doxywizard) that should identify the |
200 | +# project for which the documentation is generated. This name is used in the |
201 | +# title of most generated pages and in a few other places. |
202 | +# The default value is: My Project. |
203 | |
204 | PROJECT_NAME = libdebian-installer |
205 | |
206 | -# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
207 | -# This could be handy for archiving the generated documentation or |
208 | -# if some version control system is used. |
209 | - |
210 | -PROJECT_NUMBER = |
211 | - |
212 | -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
213 | -# base path where the generated documentation will be put. |
214 | -# If a relative path is entered, it will be relative to the location |
215 | -# where doxygen was started. If left blank the current directory will be used. |
216 | +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This |
217 | +# could be handy for archiving the generated documentation or if some version |
218 | +# control system is used. |
219 | + |
220 | +PROJECT_NUMBER = |
221 | + |
222 | +# Using the PROJECT_BRIEF tag one can provide an optional one line description |
223 | +# for a project that appears at the top of each page and should give viewer a |
224 | +# quick idea about the purpose of the project. Keep the description short. |
225 | + |
226 | +PROJECT_BRIEF = |
227 | + |
228 | +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in |
229 | +# the documentation. The maximum height of the logo should not exceed 55 pixels |
230 | +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo |
231 | +# to the output directory. |
232 | + |
233 | +PROJECT_LOGO = |
234 | + |
235 | +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
236 | +# into which the generated documentation will be written. If a relative path is |
237 | +# entered, it will be relative to the location where doxygen was started. If |
238 | +# left blank the current directory will be used. |
239 | |
240 | OUTPUT_DIRECTORY = . |
241 | |
242 | -# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
243 | -# documentation generated by doxygen is written. Doxygen will use this |
244 | -# information to generate all constant output in the proper language. |
245 | -# The default language is English, other supported languages are: |
246 | -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, |
247 | -# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en |
248 | -# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, |
249 | -# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
250 | +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- |
251 | +# directories (in 2 levels) under the output directory of each output format and |
252 | +# will distribute the generated files over these directories. Enabling this |
253 | +# option can be useful when feeding doxygen a huge amount of source files, where |
254 | +# putting all generated files in the same directory would otherwise causes |
255 | +# performance problems for the file system. |
256 | +# The default value is: NO. |
257 | + |
258 | +CREATE_SUBDIRS = NO |
259 | + |
260 | +# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
261 | +# documentation generated by doxygen is written. Doxygen will use this |
262 | +# information to generate all constant output in the proper language. |
263 | +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, |
264 | +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), |
265 | +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, |
266 | +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), |
267 | +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, |
268 | +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, |
269 | +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, |
270 | +# Ukrainian and Vietnamese. |
271 | +# The default value is: English. |
272 | |
273 | OUTPUT_LANGUAGE = English |
274 | |
275 | -# This tag can be used to specify the encoding used in the generated output. |
276 | -# The encoding is not always determined by the language that is chosen, |
277 | -# but also whether or not the output is meant for Windows or non-Windows users. |
278 | -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
279 | -# forces the Windows encoding (this is the default for the Windows binary), |
280 | -# whereas setting the tag to NO uses a Unix-style encoding (the default for |
281 | -# all platforms other than Windows). |
282 | - |
283 | -USE_WINDOWS_ENCODING = NO |
284 | - |
285 | -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
286 | -# include brief member descriptions after the members that are listed in |
287 | -# the file and class documentation (similar to JavaDoc). |
288 | -# Set to NO to disable this. |
289 | +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member |
290 | +# descriptions after the members that are listed in the file and class |
291 | +# documentation (similar to Javadoc). Set to NO to disable this. |
292 | +# The default value is: YES. |
293 | |
294 | BRIEF_MEMBER_DESC = YES |
295 | |
296 | -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
297 | -# the brief description of a member or function before the detailed description. |
298 | -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
299 | +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief |
300 | +# description of a member or function before the detailed description |
301 | +# |
302 | +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
303 | # brief descriptions will be completely suppressed. |
304 | +# The default value is: YES. |
305 | |
306 | REPEAT_BRIEF = YES |
307 | |
308 | -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
309 | -# Doxygen will generate a detailed section even if there is only a brief |
310 | +# This tag implements a quasi-intelligent brief description abbreviator that is |
311 | +# used to form the text in various listings. Each string in this list, if found |
312 | +# as the leading text of the brief description, will be stripped from the text |
313 | +# and the result, after processing the whole list, is used as the annotated |
314 | +# text. Otherwise, the brief description is used as-is. If left blank, the |
315 | +# following values are used ($name is automatically replaced with the name of |
316 | +# the entity):The $name class, The $name widget, The $name file, is, provides, |
317 | +# specifies, contains, represents, a, an and the. |
318 | + |
319 | +ABBREVIATE_BRIEF = |
320 | + |
321 | +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
322 | +# doxygen will generate a detailed section even if there is only a brief |
323 | # description. |
324 | +# The default value is: NO. |
325 | |
326 | ALWAYS_DETAILED_SEC = NO |
327 | |
328 | -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited |
329 | -# members of a class in the documentation of that class as if those members were |
330 | -# ordinary class members. Constructors, destructors and assignment operators of |
331 | -# the base classes will not be shown. |
332 | +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
333 | +# inherited members of a class in the documentation of that class as if those |
334 | +# members were ordinary class members. Constructors, destructors and assignment |
335 | +# operators of the base classes will not be shown. |
336 | +# The default value is: NO. |
337 | |
338 | INLINE_INHERITED_MEMB = YES |
339 | |
340 | -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
341 | -# path before files name in the file list and in the header files. If set |
342 | -# to NO the shortest path that makes the file name unique will be used. |
343 | +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path |
344 | +# before files name in the file list and in the header files. If set to NO the |
345 | +# shortest path that makes the file name unique will be used |
346 | +# The default value is: YES. |
347 | |
348 | FULL_PATH_NAMES = NO |
349 | |
350 | -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
351 | -# can be used to strip a user-defined part of the path. Stripping is |
352 | -# only done if one of the specified strings matches the left-hand part of |
353 | -# the path. It is allowed to use relative paths in the argument list. |
354 | - |
355 | -STRIP_FROM_PATH = |
356 | - |
357 | -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
358 | -# (but less readable) file names. This can be useful is your file systems |
359 | -# doesn't support long names like on DOS, Mac, or CD-ROM. |
360 | +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. |
361 | +# Stripping is only done if one of the specified strings matches the left-hand |
362 | +# part of the path. The tag can be used to show relative paths in the file list. |
363 | +# If left blank the directory from which doxygen is run is used as the path to |
364 | +# strip. |
365 | +# |
366 | +# Note that you can specify absolute paths here, but also relative paths, which |
367 | +# will be relative from the directory where doxygen is started. |
368 | +# This tag requires that the tag FULL_PATH_NAMES is set to YES. |
369 | + |
370 | +STRIP_FROM_PATH = |
371 | + |
372 | +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the |
373 | +# path mentioned in the documentation of a class, which tells the reader which |
374 | +# header file to include in order to use a class. If left blank only the name of |
375 | +# the header file containing the class definition is used. Otherwise one should |
376 | +# specify the list of include paths that are normally passed to the compiler |
377 | +# using the -I flag. |
378 | + |
379 | +STRIP_FROM_INC_PATH = |
380 | + |
381 | +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
382 | +# less readable) file names. This can be useful is your file systems doesn't |
383 | +# support long names like on DOS, Mac, or CD-ROM. |
384 | +# The default value is: NO. |
385 | |
386 | SHORT_NAMES = NO |
387 | |
388 | -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
389 | -# will interpret the first line (until the first dot) of a JavaDoc-style |
390 | -# comment as the brief description. If set to NO, the JavaDoc |
391 | -# comments will behave just like the Qt-style comments (thus requiring an |
392 | -# explict @brief command for a brief description. |
393 | +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the |
394 | +# first line (until the first dot) of a Javadoc-style comment as the brief |
395 | +# description. If set to NO, the Javadoc-style will behave just like regular Qt- |
396 | +# style comments (thus requiring an explicit @brief command for a brief |
397 | +# description.) |
398 | +# The default value is: NO. |
399 | |
400 | JAVADOC_AUTOBRIEF = NO |
401 | |
402 | -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
403 | -# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
404 | -# comments) as a brief description. This used to be the default behaviour. |
405 | -# The new default is to treat a multi-line C++ comment block as a detailed |
406 | -# description. Set this tag to YES if you prefer the old behaviour instead. |
407 | +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
408 | +# line (until the first dot) of a Qt-style comment as the brief description. If |
409 | +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
410 | +# requiring an explicit \brief command for a brief description.) |
411 | +# The default value is: NO. |
412 | + |
413 | +QT_AUTOBRIEF = NO |
414 | + |
415 | +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a |
416 | +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as |
417 | +# a brief description. This used to be the default behavior. The new default is |
418 | +# to treat a multi-line C++ comment block as a detailed description. Set this |
419 | +# tag to YES if you prefer the old behavior instead. |
420 | +# |
421 | +# Note that setting this tag to YES also means that rational rose comments are |
422 | +# not recognized any more. |
423 | +# The default value is: NO. |
424 | |
425 | MULTILINE_CPP_IS_BRIEF = NO |
426 | |
427 | -# If the DETAILS_AT_TOP tag is set to YES then Doxygen |
428 | -# will output the detailed description near the top, like JavaDoc. |
429 | -# If set to NO, the detailed description appears after the member |
430 | -# documentation. |
431 | - |
432 | -DETAILS_AT_TOP = NO |
433 | - |
434 | -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
435 | -# member inherits the documentation from any documented member that it |
436 | -# reimplements. |
437 | +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
438 | +# documentation from any documented member that it re-implements. |
439 | +# The default value is: YES. |
440 | |
441 | INHERIT_DOCS = YES |
442 | |
443 | -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
444 | -# tag is set to YES, then doxygen will reuse the documentation of the first |
445 | -# member in the group (if any) for the other members of the group. By default |
446 | -# all members of a group must be documented explicitly. |
447 | - |
448 | -DISTRIBUTE_GROUP_DOC = NO |
449 | - |
450 | -# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
451 | -# Doxygen uses this value to replace tabs by spaces in code fragments. |
452 | +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a |
453 | +# new page for each member. If set to NO, the documentation of a member will be |
454 | +# part of the file/class/namespace that contains it. |
455 | +# The default value is: NO. |
456 | + |
457 | +SEPARATE_MEMBER_PAGES = NO |
458 | + |
459 | +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
460 | +# uses this value to replace tabs by spaces in code fragments. |
461 | +# Minimum value: 1, maximum value: 16, default value: 4. |
462 | |
463 | TAB_SIZE = 8 |
464 | |
465 | -# This tag can be used to specify a number of aliases that acts |
466 | -# as commands in the documentation. An alias has the form "name=value". |
467 | -# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
468 | -# put the command \sideeffect (or @sideeffect) in the documentation, which |
469 | -# will result in a user-defined paragraph with heading "Side Effects:". |
470 | -# You can put \n's in the value part of an alias to insert newlines. |
471 | - |
472 | -ALIASES = |
473 | - |
474 | -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
475 | -# only. Doxygen will then generate output that is more tailored for C. |
476 | -# For instance, some of the names that are used will be different. The list |
477 | -# of all members will be omitted, etc. |
478 | +# This tag can be used to specify a number of aliases that act as commands in |
479 | +# the documentation. An alias has the form: |
480 | +# name=value |
481 | +# For example adding |
482 | +# "sideeffect=@par Side Effects:\n" |
483 | +# will allow you to put the command \sideeffect (or @sideeffect) in the |
484 | +# documentation, which will result in a user-defined paragraph with heading |
485 | +# "Side Effects:". You can put \n's in the value part of an alias to insert |
486 | +# newlines. |
487 | + |
488 | +ALIASES = |
489 | + |
490 | +# This tag can be used to specify a number of word-keyword mappings (TCL only). |
491 | +# A mapping has the form "name=value". For example adding "class=itcl::class" |
492 | +# will allow you to use the command class in the itcl::class meaning. |
493 | + |
494 | +TCL_SUBST = |
495 | + |
496 | +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
497 | +# only. Doxygen will then generate output that is more tailored for C. For |
498 | +# instance, some of the names that are used will be different. The list of all |
499 | +# members will be omitted, etc. |
500 | +# The default value is: NO. |
501 | |
502 | OPTIMIZE_OUTPUT_FOR_C = YES |
503 | |
504 | -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources |
505 | -# only. Doxygen will then generate output that is more tailored for Java. |
506 | -# For instance, namespaces will be presented as packages, qualified scopes |
507 | -# will look different, etc. |
508 | +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or |
509 | +# Python sources only. Doxygen will then generate output that is more tailored |
510 | +# for that language. For instance, namespaces will be presented as packages, |
511 | +# qualified scopes will look different, etc. |
512 | +# The default value is: NO. |
513 | |
514 | OPTIMIZE_OUTPUT_JAVA = NO |
515 | |
516 | -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
517 | -# the same type (for instance a group of public functions) to be put as a |
518 | -# subgroup of that type (e.g. under the Public Functions section). Set it to |
519 | -# NO to prevent subgrouping. Alternatively, this can be done per class using |
520 | -# the \nosubgrouping command. |
521 | +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
522 | +# sources. Doxygen will then generate output that is tailored for Fortran. |
523 | +# The default value is: NO. |
524 | + |
525 | +OPTIMIZE_FOR_FORTRAN = NO |
526 | + |
527 | +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
528 | +# sources. Doxygen will then generate output that is tailored for VHDL. |
529 | +# The default value is: NO. |
530 | + |
531 | +OPTIMIZE_OUTPUT_VHDL = NO |
532 | + |
533 | +# Doxygen selects the parser to use depending on the extension of the files it |
534 | +# parses. With this tag you can assign which parser to use for a given |
535 | +# extension. Doxygen has a built-in mapping, but you can override or extend it |
536 | +# using this tag. The format is ext=language, where ext is a file extension, and |
537 | +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
538 | +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make |
539 | +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
540 | +# (default is Fortran), use: inc=Fortran f=C. |
541 | +# |
542 | +# Note For files without extension you can use no_extension as a placeholder. |
543 | +# |
544 | +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
545 | +# the files are not read by doxygen. |
546 | + |
547 | +EXTENSION_MAPPING = |
548 | + |
549 | +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
550 | +# according to the Markdown format, which allows for more readable |
551 | +# documentation. See http://daringfireball.net/projects/markdown/ for details. |
552 | +# The output of markdown processing is further processed by doxygen, so you can |
553 | +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
554 | +# case of backward compatibilities issues. |
555 | +# The default value is: YES. |
556 | + |
557 | +MARKDOWN_SUPPORT = YES |
558 | + |
559 | +# When enabled doxygen tries to link words that correspond to documented |
560 | +# classes, or namespaces to their corresponding documentation. Such a link can |
561 | +# be prevented in individual cases by by putting a % sign in front of the word |
562 | +# or globally by setting AUTOLINK_SUPPORT to NO. |
563 | +# The default value is: YES. |
564 | + |
565 | +AUTOLINK_SUPPORT = YES |
566 | + |
567 | +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
568 | +# to include (a tag file for) the STL sources as input, then you should set this |
569 | +# tag to YES in order to let doxygen match functions declarations and |
570 | +# definitions whose arguments contain STL classes (e.g. func(std::string); |
571 | +# versus func(std::string) {}). This also make the inheritance and collaboration |
572 | +# diagrams that involve STL classes more complete and accurate. |
573 | +# The default value is: NO. |
574 | + |
575 | +BUILTIN_STL_SUPPORT = NO |
576 | + |
577 | +# If you use Microsoft's C++/CLI language, you should set this option to YES to |
578 | +# enable parsing support. |
579 | +# The default value is: NO. |
580 | + |
581 | +CPP_CLI_SUPPORT = NO |
582 | + |
583 | +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
584 | +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
585 | +# will parse them like normal C++ but will assume all classes use public instead |
586 | +# of private inheritance when no explicit protection keyword is present. |
587 | +# The default value is: NO. |
588 | + |
589 | +SIP_SUPPORT = NO |
590 | + |
591 | +# For Microsoft's IDL there are propget and propput attributes to indicate |
592 | +# getter and setter methods for a property. Setting this option to YES will make |
593 | +# doxygen to replace the get and set methods by a property in the documentation. |
594 | +# This will only work if the methods are indeed getting or setting a simple |
595 | +# type. If this is not the case, or you want to show the methods anyway, you |
596 | +# should set this option to NO. |
597 | +# The default value is: YES. |
598 | + |
599 | +IDL_PROPERTY_SUPPORT = YES |
600 | + |
601 | +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
602 | +# tag is set to YES, then doxygen will reuse the documentation of the first |
603 | +# member in the group (if any) for the other members of the group. By default |
604 | +# all members of a group must be documented explicitly. |
605 | +# The default value is: NO. |
606 | + |
607 | +DISTRIBUTE_GROUP_DOC = NO |
608 | + |
609 | +# Set the SUBGROUPING tag to YES to allow class member groups of the same type |
610 | +# (for instance a group of public functions) to be put as a subgroup of that |
611 | +# type (e.g. under the Public Functions section). Set it to NO to prevent |
612 | +# subgrouping. Alternatively, this can be done per class using the |
613 | +# \nosubgrouping command. |
614 | +# The default value is: YES. |
615 | |
616 | SUBGROUPING = YES |
617 | |
618 | +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions |
619 | +# are shown inside the group in which they are included (e.g. using \ingroup) |
620 | +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX |
621 | +# and RTF). |
622 | +# |
623 | +# Note that this feature does not work in combination with |
624 | +# SEPARATE_MEMBER_PAGES. |
625 | +# The default value is: NO. |
626 | + |
627 | +INLINE_GROUPED_CLASSES = NO |
628 | + |
629 | +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions |
630 | +# with only public data fields or simple typedef fields will be shown inline in |
631 | +# the documentation of the scope in which they are defined (i.e. file, |
632 | +# namespace, or group documentation), provided this scope is documented. If set |
633 | +# to NO, structs, classes, and unions are shown on a separate page (for HTML and |
634 | +# Man pages) or section (for LaTeX and RTF). |
635 | +# The default value is: NO. |
636 | + |
637 | +INLINE_SIMPLE_STRUCTS = NO |
638 | + |
639 | +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or |
640 | +# enum is documented as struct, union, or enum with the name of the typedef. So |
641 | +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
642 | +# with name TypeT. When disabled the typedef will appear as a member of a file, |
643 | +# namespace, or class. And the struct will be named TypeS. This can typically be |
644 | +# useful for C code in case the coding convention dictates that all compound |
645 | +# types are typedef'ed and only the typedef is referenced, never the tag name. |
646 | +# The default value is: NO. |
647 | + |
648 | +TYPEDEF_HIDES_STRUCT = NO |
649 | + |
650 | +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This |
651 | +# cache is used to resolve symbols given their name and scope. Since this can be |
652 | +# an expensive process and often the same symbol appears multiple times in the |
653 | +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small |
654 | +# doxygen will become slower. If the cache is too large, memory is wasted. The |
655 | +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range |
656 | +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 |
657 | +# symbols. At the end of a run doxygen will report the cache usage and suggest |
658 | +# the optimal cache size from a speed point of view. |
659 | +# Minimum value: 0, maximum value: 9, default value: 0. |
660 | + |
661 | +LOOKUP_CACHE_SIZE = 0 |
662 | + |
663 | #--------------------------------------------------------------------------- |
664 | # Build related configuration options |
665 | #--------------------------------------------------------------------------- |
666 | |
667 | -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
668 | -# documentation are documented, even if no documentation was available. |
669 | -# Private class members and static file members will be hidden unless |
670 | -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
671 | +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
672 | +# documentation are documented, even if no documentation was available. Private |
673 | +# class members and static file members will be hidden unless the |
674 | +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
675 | +# Note: This will also disable the warnings about undocumented members that are |
676 | +# normally produced when WARNINGS is set to YES. |
677 | +# The default value is: NO. |
678 | |
679 | EXTRACT_ALL = NO |
680 | |
681 | -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
682 | -# will be included in the documentation. |
683 | +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will |
684 | +# be included in the documentation. |
685 | +# The default value is: NO. |
686 | |
687 | EXTRACT_PRIVATE = NO |
688 | |
689 | -# If the EXTRACT_STATIC tag is set to YES all static members of a file |
690 | -# will be included in the documentation. |
691 | +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
692 | +# scope will be included in the documentation. |
693 | +# The default value is: NO. |
694 | + |
695 | +EXTRACT_PACKAGE = NO |
696 | + |
697 | +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be |
698 | +# included in the documentation. |
699 | +# The default value is: NO. |
700 | |
701 | EXTRACT_STATIC = YES |
702 | |
703 | -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
704 | -# defined locally in source files will be included in the documentation. |
705 | -# If set to NO only classes defined in header files are included. |
706 | +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined |
707 | +# locally in source files will be included in the documentation. If set to NO |
708 | +# only classes defined in header files are included. Does not have any effect |
709 | +# for Java sources. |
710 | +# The default value is: YES. |
711 | |
712 | EXTRACT_LOCAL_CLASSES = YES |
713 | |
714 | -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
715 | -# undocumented members of documented classes, files or namespaces. |
716 | -# If set to NO (the default) these members will be included in the |
717 | -# various overviews, but no documentation section is generated. |
718 | -# This option has no effect if EXTRACT_ALL is enabled. |
719 | +# This flag is only useful for Objective-C code. When set to YES local methods, |
720 | +# which are defined in the implementation section but not in the interface are |
721 | +# included in the documentation. If set to NO only methods in the interface are |
722 | +# included. |
723 | +# The default value is: NO. |
724 | + |
725 | +EXTRACT_LOCAL_METHODS = NO |
726 | + |
727 | +# If this flag is set to YES, the members of anonymous namespaces will be |
728 | +# extracted and appear in the documentation as a namespace called |
729 | +# 'anonymous_namespace{file}', where file will be replaced with the base name of |
730 | +# the file that contains the anonymous namespace. By default anonymous namespace |
731 | +# are hidden. |
732 | +# The default value is: NO. |
733 | + |
734 | +EXTRACT_ANON_NSPACES = NO |
735 | + |
736 | +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
737 | +# undocumented members inside documented classes or files. If set to NO these |
738 | +# members will be included in the various overviews, but no documentation |
739 | +# section is generated. This option has no effect if EXTRACT_ALL is enabled. |
740 | +# The default value is: NO. |
741 | |
742 | HIDE_UNDOC_MEMBERS = NO |
743 | |
744 | -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
745 | -# undocumented classes that are normally visible in the class hierarchy. |
746 | -# If set to NO (the default) these classes will be included in the various |
747 | -# overviews. This option has no effect if EXTRACT_ALL is enabled. |
748 | +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
749 | +# undocumented classes that are normally visible in the class hierarchy. If set |
750 | +# to NO these classes will be included in the various overviews. This option has |
751 | +# no effect if EXTRACT_ALL is enabled. |
752 | +# The default value is: NO. |
753 | |
754 | HIDE_UNDOC_CLASSES = NO |
755 | |
756 | -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
757 | -# friend (class|struct|union) declarations. |
758 | -# If set to NO (the default) these declarations will be included in the |
759 | -# documentation. |
760 | +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
761 | +# (class|struct|union) declarations. If set to NO these declarations will be |
762 | +# included in the documentation. |
763 | +# The default value is: NO. |
764 | |
765 | HIDE_FRIEND_COMPOUNDS = NO |
766 | |
767 | -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
768 | -# documentation blocks found inside the body of a function. |
769 | -# If set to NO (the default) these blocks will be appended to the |
770 | -# function's detailed documentation block. |
771 | +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
772 | +# documentation blocks found inside the body of a function. If set to NO these |
773 | +# blocks will be appended to the function's detailed documentation block. |
774 | +# The default value is: NO. |
775 | |
776 | HIDE_IN_BODY_DOCS = NO |
777 | |
778 | -# The INTERNAL_DOCS tag determines if documentation |
779 | -# that is typed after a \internal command is included. If the tag is set |
780 | -# to NO (the default) then the documentation will be excluded. |
781 | -# Set it to YES to include the internal documentation. |
782 | +# The INTERNAL_DOCS tag determines if documentation that is typed after a |
783 | +# \internal command is included. If the tag is set to NO then the documentation |
784 | +# will be excluded. Set it to YES to include the internal documentation. |
785 | +# The default value is: NO. |
786 | |
787 | INTERNAL_DOCS = YES |
788 | |
789 | -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
790 | -# file names in lower-case letters. If set to YES upper-case letters are also |
791 | -# allowed. This is useful if you have classes or files whose names only differ |
792 | -# in case and if your file system supports case sensitive file names. Windows |
793 | -# users are advised to set this option to NO. |
794 | +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
795 | +# names in lower-case letters. If set to YES upper-case letters are also |
796 | +# allowed. This is useful if you have classes or files whose names only differ |
797 | +# in case and if your file system supports case sensitive file names. Windows |
798 | +# and Mac users are advised to set this option to NO. |
799 | +# The default value is: system dependent. |
800 | |
801 | CASE_SENSE_NAMES = YES |
802 | |
803 | -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
804 | -# will show members with their full class and namespace scopes in the |
805 | -# documentation. If set to YES the scope will be hidden. |
806 | +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
807 | +# their full class and namespace scopes in the documentation. If set to YES the |
808 | +# scope will be hidden. |
809 | +# The default value is: NO. |
810 | |
811 | HIDE_SCOPE_NAMES = YES |
812 | |
813 | -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
814 | -# will put a list of the files that are included by a file in the documentation |
815 | -# of that file. |
816 | +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
817 | +# the files that are included by a file in the documentation of that file. |
818 | +# The default value is: YES. |
819 | |
820 | SHOW_INCLUDE_FILES = YES |
821 | |
822 | -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
823 | -# is inserted in the documentation for inline members. |
824 | +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each |
825 | +# grouped member an include statement to the documentation, telling the reader |
826 | +# which file to include in order to use the member. |
827 | +# The default value is: NO. |
828 | + |
829 | +SHOW_GROUPED_MEMB_INC = NO |
830 | + |
831 | +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include |
832 | +# files with double quotes in the documentation rather than with sharp brackets. |
833 | +# The default value is: NO. |
834 | + |
835 | +FORCE_LOCAL_INCLUDES = NO |
836 | + |
837 | +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the |
838 | +# documentation for inline members. |
839 | +# The default value is: YES. |
840 | |
841 | INLINE_INFO = YES |
842 | |
843 | -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
844 | -# will sort the (detailed) documentation of file and class members |
845 | -# alphabetically by member name. If set to NO the members will appear in |
846 | -# declaration order. |
847 | +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
848 | +# (detailed) documentation of file and class members alphabetically by member |
849 | +# name. If set to NO the members will appear in declaration order. |
850 | +# The default value is: YES. |
851 | |
852 | SORT_MEMBER_DOCS = YES |
853 | |
854 | -# The GENERATE_TODOLIST tag can be used to enable (YES) or |
855 | -# disable (NO) the todo list. This list is created by putting \todo |
856 | -# commands in the documentation. |
857 | +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
858 | +# descriptions of file, namespace and class members alphabetically by member |
859 | +# name. If set to NO the members will appear in declaration order. Note that |
860 | +# this will also influence the order of the classes in the class list. |
861 | +# The default value is: NO. |
862 | + |
863 | +SORT_BRIEF_DOCS = NO |
864 | + |
865 | +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the |
866 | +# (brief and detailed) documentation of class members so that constructors and |
867 | +# destructors are listed first. If set to NO the constructors will appear in the |
868 | +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. |
869 | +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief |
870 | +# member documentation. |
871 | +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting |
872 | +# detailed member documentation. |
873 | +# The default value is: NO. |
874 | + |
875 | +SORT_MEMBERS_CTORS_1ST = NO |
876 | + |
877 | +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy |
878 | +# of group names into alphabetical order. If set to NO the group names will |
879 | +# appear in their defined order. |
880 | +# The default value is: NO. |
881 | + |
882 | +SORT_GROUP_NAMES = NO |
883 | + |
884 | +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by |
885 | +# fully-qualified names, including namespaces. If set to NO, the class list will |
886 | +# be sorted only by class name, not including the namespace part. |
887 | +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
888 | +# Note: This option applies only to the class list, not to the alphabetical |
889 | +# list. |
890 | +# The default value is: NO. |
891 | + |
892 | +SORT_BY_SCOPE_NAME = NO |
893 | + |
894 | +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper |
895 | +# type resolution of all parameters of a function it will reject a match between |
896 | +# the prototype and the implementation of a member function even if there is |
897 | +# only one candidate or it is obvious which candidate to choose by doing a |
898 | +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still |
899 | +# accept a match between prototype and implementation in such cases. |
900 | +# The default value is: NO. |
901 | + |
902 | +STRICT_PROTO_MATCHING = NO |
903 | + |
904 | +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the |
905 | +# todo list. This list is created by putting \todo commands in the |
906 | +# documentation. |
907 | +# The default value is: YES. |
908 | |
909 | GENERATE_TODOLIST = YES |
910 | |
911 | -# The GENERATE_TESTLIST tag can be used to enable (YES) or |
912 | -# disable (NO) the test list. This list is created by putting \test |
913 | -# commands in the documentation. |
914 | +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the |
915 | +# test list. This list is created by putting \test commands in the |
916 | +# documentation. |
917 | +# The default value is: YES. |
918 | |
919 | GENERATE_TESTLIST = YES |
920 | |
921 | -# The GENERATE_BUGLIST tag can be used to enable (YES) or |
922 | -# disable (NO) the bug list. This list is created by putting \bug |
923 | -# commands in the documentation. |
924 | +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug |
925 | +# list. This list is created by putting \bug commands in the documentation. |
926 | +# The default value is: YES. |
927 | |
928 | GENERATE_BUGLIST = YES |
929 | |
930 | -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
931 | -# disable (NO) the deprecated list. This list is created by putting |
932 | -# \deprecated commands in the documentation. |
933 | +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) |
934 | +# the deprecated list. This list is created by putting \deprecated commands in |
935 | +# the documentation. |
936 | +# The default value is: YES. |
937 | |
938 | GENERATE_DEPRECATEDLIST= YES |
939 | |
940 | -# The ENABLED_SECTIONS tag can be used to enable conditional |
941 | -# documentation sections, marked by \if sectionname ... \endif. |
942 | - |
943 | -ENABLED_SECTIONS = |
944 | - |
945 | -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
946 | -# the initial value of a variable or define consists of for it to appear in |
947 | -# the documentation. If the initializer consists of more lines than specified |
948 | -# here it will be hidden. Use a value of 0 to hide initializers completely. |
949 | -# The appearance of the initializer of individual variables and defines in the |
950 | -# documentation can be controlled using \showinitializer or \hideinitializer |
951 | -# command in the documentation regardless of this setting. |
952 | +# The ENABLED_SECTIONS tag can be used to enable conditional documentation |
953 | +# sections, marked by \if <section_label> ... \endif and \cond <section_label> |
954 | +# ... \endcond blocks. |
955 | + |
956 | +ENABLED_SECTIONS = |
957 | + |
958 | +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
959 | +# initial value of a variable or macro / define can have for it to appear in the |
960 | +# documentation. If the initializer consists of more lines than specified here |
961 | +# it will be hidden. Use a value of 0 to hide initializers completely. The |
962 | +# appearance of the value of individual variables and macros / defines can be |
963 | +# controlled using \showinitializer or \hideinitializer command in the |
964 | +# documentation regardless of this setting. |
965 | +# Minimum value: 0, maximum value: 10000, default value: 30. |
966 | |
967 | MAX_INITIALIZER_LINES = 30 |
968 | |
969 | -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
970 | -# at the bottom of the documentation of classes and structs. If set to YES the |
971 | -# list will mention the files that were used to generate the documentation. |
972 | +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
973 | +# the bottom of the documentation of classes and structs. If set to YES the list |
974 | +# will mention the files that were used to generate the documentation. |
975 | +# The default value is: YES. |
976 | |
977 | SHOW_USED_FILES = NO |
978 | |
979 | -#--------------------------------------------------------------------------- |
980 | -# configuration options related to warning and progress messages |
981 | -#--------------------------------------------------------------------------- |
982 | - |
983 | -# The QUIET tag can be used to turn on/off the messages that are generated |
984 | -# by doxygen. Possible values are YES and NO. If left blank NO is used. |
985 | +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This |
986 | +# will remove the Files entry from the Quick Index and from the Folder Tree View |
987 | +# (if specified). |
988 | +# The default value is: YES. |
989 | + |
990 | +SHOW_FILES = YES |
991 | + |
992 | +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces |
993 | +# page. This will remove the Namespaces entry from the Quick Index and from the |
994 | +# Folder Tree View (if specified). |
995 | +# The default value is: YES. |
996 | + |
997 | +SHOW_NAMESPACES = YES |
998 | + |
999 | +# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
1000 | +# doxygen should invoke to get the current version for each file (typically from |
1001 | +# the version control system). Doxygen will invoke the program by executing (via |
1002 | +# popen()) the command command input-file, where command is the value of the |
1003 | +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided |
1004 | +# by doxygen. Whatever the program writes to standard output is used as the file |
1005 | +# version. For an example see the documentation. |
1006 | + |
1007 | +FILE_VERSION_FILTER = |
1008 | + |
1009 | +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
1010 | +# by doxygen. The layout file controls the global structure of the generated |
1011 | +# output files in an output format independent way. To create the layout file |
1012 | +# that represents doxygen's defaults, run doxygen with the -l option. You can |
1013 | +# optionally specify a file name after the option, if omitted DoxygenLayout.xml |
1014 | +# will be used as the name of the layout file. |
1015 | +# |
1016 | +# Note that if you run doxygen from a directory containing a file called |
1017 | +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
1018 | +# tag is left empty. |
1019 | + |
1020 | +LAYOUT_FILE = |
1021 | + |
1022 | +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
1023 | +# the reference definitions. This must be a list of .bib files. The .bib |
1024 | +# extension is automatically appended if omitted. This requires the bibtex tool |
1025 | +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
1026 | +# For LaTeX the style of the bibliography can be controlled using |
1027 | +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
1028 | +# search path. Do not use file names with spaces, bibtex cannot handle them. See |
1029 | +# also \cite for info how to create references. |
1030 | + |
1031 | +CITE_BIB_FILES = |
1032 | + |
1033 | +#--------------------------------------------------------------------------- |
1034 | +# Configuration options related to warning and progress messages |
1035 | +#--------------------------------------------------------------------------- |
1036 | + |
1037 | +# The QUIET tag can be used to turn on/off the messages that are generated to |
1038 | +# standard output by doxygen. If QUIET is set to YES this implies that the |
1039 | +# messages are off. |
1040 | +# The default value is: NO. |
1041 | |
1042 | QUIET = NO |
1043 | |
1044 | -# The WARNINGS tag can be used to turn on/off the warning messages that are |
1045 | -# generated by doxygen. Possible values are YES and NO. If left blank |
1046 | -# NO is used. |
1047 | +# The WARNINGS tag can be used to turn on/off the warning messages that are |
1048 | +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES |
1049 | +# this implies that the warnings are on. |
1050 | +# |
1051 | +# Tip: Turn warnings on while writing the documentation. |
1052 | +# The default value is: YES. |
1053 | |
1054 | WARNINGS = YES |
1055 | |
1056 | -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
1057 | -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
1058 | -# automatically be disabled. |
1059 | +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate |
1060 | +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
1061 | +# will automatically be disabled. |
1062 | +# The default value is: YES. |
1063 | |
1064 | WARN_IF_UNDOCUMENTED = YES |
1065 | |
1066 | -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
1067 | -# potential errors in the documentation, such as not documenting some |
1068 | -# parameters in a documented function, or documenting parameters that |
1069 | -# don't exist or using markup commands wrongly. |
1070 | +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
1071 | +# potential errors in the documentation, such as not documenting some parameters |
1072 | +# in a documented function, or documenting parameters that don't exist or using |
1073 | +# markup commands wrongly. |
1074 | +# The default value is: YES. |
1075 | |
1076 | WARN_IF_DOC_ERROR = YES |
1077 | |
1078 | -# The WARN_FORMAT tag determines the format of the warning messages that |
1079 | -# doxygen can produce. The string should contain the $file, $line, and $text |
1080 | -# tags, which will be replaced by the file and line number from which the |
1081 | -# warning originated and the warning text. |
1082 | +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
1083 | +# are documented, but have no documentation for their parameters or return |
1084 | +# value. If set to NO doxygen will only warn about wrong or incomplete parameter |
1085 | +# documentation, but not about the absence of documentation. |
1086 | +# The default value is: NO. |
1087 | + |
1088 | +WARN_NO_PARAMDOC = NO |
1089 | + |
1090 | +# The WARN_FORMAT tag determines the format of the warning messages that doxygen |
1091 | +# can produce. The string should contain the $file, $line, and $text tags, which |
1092 | +# will be replaced by the file and line number from which the warning originated |
1093 | +# and the warning text. Optionally the format may contain $version, which will |
1094 | +# be replaced by the version of the file (if it could be obtained via |
1095 | +# FILE_VERSION_FILTER) |
1096 | +# The default value is: $file:$line: $text. |
1097 | |
1098 | WARN_FORMAT = "$file:$line: $text" |
1099 | |
1100 | -# The WARN_LOGFILE tag can be used to specify a file to which warning |
1101 | -# and error messages should be written. If left blank the output is written |
1102 | -# to stderr. |
1103 | - |
1104 | -WARN_LOGFILE = |
1105 | - |
1106 | -#--------------------------------------------------------------------------- |
1107 | -# configuration options related to the input files |
1108 | -#--------------------------------------------------------------------------- |
1109 | - |
1110 | -# The INPUT tag can be used to specify the files and/or directories that contain |
1111 | -# documented source files. You may enter file names like "myfile.cpp" or |
1112 | -# directories like "/usr/src/myproject". Separate the files or directories |
1113 | -# with spaces. |
1114 | - |
1115 | -INPUT = @top_srcdir@/doc/libdebian-installer @top_srcdir@/include/ @top_srcdir@/src/ |
1116 | - |
1117 | -# If the value of the INPUT tag contains directories, you can use the |
1118 | -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
1119 | -# and *.h) to filter out the source-files in the directories. If left |
1120 | -# blank the following patterns are tested: |
1121 | -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
1122 | -# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc |
1123 | - |
1124 | -FILE_PATTERNS = *.c *.h |
1125 | - |
1126 | -# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
1127 | -# should be searched for input files as well. Possible values are YES and NO. |
1128 | -# If left blank NO is used. |
1129 | +# The WARN_LOGFILE tag can be used to specify a file to which warning and error |
1130 | +# messages should be written. If left blank the output is written to standard |
1131 | +# error (stderr). |
1132 | + |
1133 | +WARN_LOGFILE = |
1134 | + |
1135 | +#--------------------------------------------------------------------------- |
1136 | +# Configuration options related to the input files |
1137 | +#--------------------------------------------------------------------------- |
1138 | + |
1139 | +# The INPUT tag is used to specify the files and/or directories that contain |
1140 | +# documented source files. You may enter file names like myfile.cpp or |
1141 | +# directories like /usr/src/myproject. Separate the files or directories with |
1142 | +# spaces. |
1143 | +# Note: If this tag is empty the current directory is searched. |
1144 | + |
1145 | +INPUT = @top_srcdir@/doc/libdebian-installer \ |
1146 | + @top_srcdir@/include/ \ |
1147 | + @top_srcdir@/src/ |
1148 | + |
1149 | +# This tag can be used to specify the character encoding of the source files |
1150 | +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
1151 | +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
1152 | +# documentation (see: http://www.gnu.org/software/libiconv) for the list of |
1153 | +# possible encodings. |
1154 | +# The default value is: UTF-8. |
1155 | + |
1156 | +INPUT_ENCODING = UTF-8 |
1157 | + |
1158 | +# If the value of the INPUT tag contains directories, you can use the |
1159 | +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
1160 | +# *.h) to filter out the source-files in the directories. If left blank the |
1161 | +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, |
1162 | +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, |
1163 | +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, |
1164 | +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, |
1165 | +# *.qsf, *.as and *.js. |
1166 | + |
1167 | +FILE_PATTERNS = *.c \ |
1168 | + *.h |
1169 | + |
1170 | +# The RECURSIVE tag can be used to specify whether or not subdirectories should |
1171 | +# be searched for input files as well. |
1172 | +# The default value is: NO. |
1173 | |
1174 | RECURSIVE = YES |
1175 | |
1176 | -# The EXCLUDE tag can be used to specify files and/or directories that should |
1177 | -# excluded from the INPUT source files. This way you can easily exclude a |
1178 | +# The EXCLUDE tag can be used to specify files and/or directories that should be |
1179 | +# excluded from the INPUT source files. This way you can easily exclude a |
1180 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
1181 | - |
1182 | -EXCLUDE = |
1183 | - |
1184 | -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories |
1185 | -# that are symbolic links (a Unix filesystem feature) are excluded from the input. |
1186 | +# |
1187 | +# Note that relative paths are relative to the directory from which doxygen is |
1188 | +# run. |
1189 | + |
1190 | +EXCLUDE = |
1191 | + |
1192 | +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
1193 | +# directories that are symbolic links (a Unix file system feature) are excluded |
1194 | +# from the input. |
1195 | +# The default value is: NO. |
1196 | |
1197 | EXCLUDE_SYMLINKS = NO |
1198 | |
1199 | -# If the value of the INPUT tag contains directories, you can use the |
1200 | -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
1201 | +# If the value of the INPUT tag contains directories, you can use the |
1202 | +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
1203 | # certain files from those directories. |
1204 | - |
1205 | -EXCLUDE_PATTERNS = |
1206 | - |
1207 | -# The EXAMPLE_PATH tag can be used to specify one or more files or |
1208 | -# directories that contain example code fragments that are included (see |
1209 | -# the \include command). |
1210 | - |
1211 | -EXAMPLE_PATH = |
1212 | - |
1213 | -# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
1214 | -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
1215 | -# and *.h) to filter out the source-files in the directories. If left |
1216 | -# blank all files are included. |
1217 | - |
1218 | -EXAMPLE_PATTERNS = |
1219 | - |
1220 | -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
1221 | -# searched for input files to be used with the \include or \dontinclude |
1222 | -# commands irrespective of the value of the RECURSIVE tag. |
1223 | -# Possible values are YES and NO. If left blank NO is used. |
1224 | +# |
1225 | +# Note that the wildcards are matched against the file with absolute path, so to |
1226 | +# exclude all test directories for example use the pattern */test/* |
1227 | + |
1228 | +EXCLUDE_PATTERNS = |
1229 | + |
1230 | +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
1231 | +# (namespaces, classes, functions, etc.) that should be excluded from the |
1232 | +# output. The symbol name can be a fully qualified name, a word, or if the |
1233 | +# wildcard * is used, a substring. Examples: ANamespace, AClass, |
1234 | +# AClass::ANamespace, ANamespace::*Test |
1235 | +# |
1236 | +# Note that the wildcards are matched against the file with absolute path, so to |
1237 | +# exclude all test directories use the pattern */test/* |
1238 | + |
1239 | +EXCLUDE_SYMBOLS = |
1240 | + |
1241 | +# The EXAMPLE_PATH tag can be used to specify one or more files or directories |
1242 | +# that contain example code fragments that are included (see the \include |
1243 | +# command). |
1244 | + |
1245 | +EXAMPLE_PATH = |
1246 | + |
1247 | +# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
1248 | +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
1249 | +# *.h) to filter out the source-files in the directories. If left blank all |
1250 | +# files are included. |
1251 | + |
1252 | +EXAMPLE_PATTERNS = |
1253 | + |
1254 | +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
1255 | +# searched for input files to be used with the \include or \dontinclude commands |
1256 | +# irrespective of the value of the RECURSIVE tag. |
1257 | +# The default value is: NO. |
1258 | |
1259 | EXAMPLE_RECURSIVE = NO |
1260 | |
1261 | -# The IMAGE_PATH tag can be used to specify one or more files or |
1262 | -# directories that contain image that are included in the documentation (see |
1263 | -# the \image command). |
1264 | - |
1265 | -IMAGE_PATH = |
1266 | - |
1267 | -# The INPUT_FILTER tag can be used to specify a program that doxygen should |
1268 | -# invoke to filter for each input file. Doxygen will invoke the filter program |
1269 | -# by executing (via popen()) the command <filter> <input-file>, where <filter> |
1270 | -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
1271 | -# input file. Doxygen will then use the output that the filter program writes |
1272 | -# to standard output. |
1273 | - |
1274 | -INPUT_FILTER = |
1275 | - |
1276 | -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
1277 | -# INPUT_FILTER) will be used to filter the input files when producing source |
1278 | -# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
1279 | +# The IMAGE_PATH tag can be used to specify one or more files or directories |
1280 | +# that contain images that are to be included in the documentation (see the |
1281 | +# \image command). |
1282 | + |
1283 | +IMAGE_PATH = |
1284 | + |
1285 | +# The INPUT_FILTER tag can be used to specify a program that doxygen should |
1286 | +# invoke to filter for each input file. Doxygen will invoke the filter program |
1287 | +# by executing (via popen()) the command: |
1288 | +# |
1289 | +# <filter> <input-file> |
1290 | +# |
1291 | +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the |
1292 | +# name of an input file. Doxygen will then use the output that the filter |
1293 | +# program writes to standard output. If FILTER_PATTERNS is specified, this tag |
1294 | +# will be ignored. |
1295 | +# |
1296 | +# Note that the filter must not add or remove lines; it is applied before the |
1297 | +# code is scanned, but not when the output code is generated. If lines are added |
1298 | +# or removed, the anchors will not be placed correctly. |
1299 | + |
1300 | +INPUT_FILTER = |
1301 | + |
1302 | +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
1303 | +# basis. Doxygen will compare the file name with each pattern and apply the |
1304 | +# filter if there is a match. The filters are a list of the form: pattern=filter |
1305 | +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
1306 | +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
1307 | +# patterns match the file name, INPUT_FILTER is applied. |
1308 | + |
1309 | +FILTER_PATTERNS = |
1310 | + |
1311 | +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
1312 | +# INPUT_FILTER ) will also be used to filter the input files that are used for |
1313 | +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
1314 | +# The default value is: NO. |
1315 | |
1316 | FILTER_SOURCE_FILES = NO |
1317 | |
1318 | -#--------------------------------------------------------------------------- |
1319 | -# configuration options related to source browsing |
1320 | -#--------------------------------------------------------------------------- |
1321 | - |
1322 | -# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
1323 | -# be generated. Documented entities will be cross-referenced with these sources. |
1324 | +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
1325 | +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and |
1326 | +# it is also possible to disable source filtering for a specific pattern using |
1327 | +# *.ext= (so without naming a filter). |
1328 | +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
1329 | + |
1330 | +FILTER_SOURCE_PATTERNS = |
1331 | + |
1332 | +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
1333 | +# is part of the input, its contents will be placed on the main page |
1334 | +# (index.html). This can be useful if you have a project on for instance GitHub |
1335 | +# and want to reuse the introduction page also for the doxygen output. |
1336 | + |
1337 | +USE_MDFILE_AS_MAINPAGE = |
1338 | + |
1339 | +#--------------------------------------------------------------------------- |
1340 | +# Configuration options related to source browsing |
1341 | +#--------------------------------------------------------------------------- |
1342 | + |
1343 | +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be |
1344 | +# generated. Documented entities will be cross-referenced with these sources. |
1345 | +# |
1346 | +# Note: To get rid of all source code in the generated output, make sure that |
1347 | +# also VERBATIM_HEADERS is set to NO. |
1348 | +# The default value is: NO. |
1349 | |
1350 | SOURCE_BROWSER = NO |
1351 | |
1352 | -# Setting the INLINE_SOURCES tag to YES will include the body |
1353 | -# of functions and classes directly in the documentation. |
1354 | +# Setting the INLINE_SOURCES tag to YES will include the body of functions, |
1355 | +# classes and enums directly into the documentation. |
1356 | +# The default value is: NO. |
1357 | |
1358 | INLINE_SOURCES = YES |
1359 | |
1360 | -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
1361 | -# doxygen to hide any special comment blocks from generated source code |
1362 | -# fragments. Normal C and C++ comments will always remain visible. |
1363 | +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any |
1364 | +# special comment blocks from generated source code fragments. Normal C, C++ and |
1365 | +# Fortran comments will always remain visible. |
1366 | +# The default value is: YES. |
1367 | |
1368 | STRIP_CODE_COMMENTS = YES |
1369 | |
1370 | -# If the REFERENCED_BY_RELATION tag is set to YES (the default) |
1371 | -# then for each documented function all documented |
1372 | -# functions referencing it will be listed. |
1373 | +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
1374 | +# function all documented functions referencing it will be listed. |
1375 | +# The default value is: NO. |
1376 | |
1377 | REFERENCED_BY_RELATION = YES |
1378 | |
1379 | -# If the REFERENCES_RELATION tag is set to YES (the default) |
1380 | -# then for each documented function all documented entities |
1381 | -# called/used by that function will be listed. |
1382 | +# If the REFERENCES_RELATION tag is set to YES then for each documented function |
1383 | +# all documented entities called/used by that function will be listed. |
1384 | +# The default value is: NO. |
1385 | |
1386 | REFERENCES_RELATION = YES |
1387 | |
1388 | -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
1389 | -# will generate a verbatim copy of the header file for each class for |
1390 | -# which an include is specified. Set to NO to disable this. |
1391 | +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
1392 | +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and |
1393 | +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
1394 | +# link to the documentation. |
1395 | +# The default value is: YES. |
1396 | + |
1397 | +REFERENCES_LINK_SOURCE = YES |
1398 | + |
1399 | +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the |
1400 | +# source code will show a tooltip with additional information such as prototype, |
1401 | +# brief description and links to the definition and documentation. Since this |
1402 | +# will make the HTML file larger and loading of large files a bit slower, you |
1403 | +# can opt to disable this feature. |
1404 | +# The default value is: YES. |
1405 | +# This tag requires that the tag SOURCE_BROWSER is set to YES. |
1406 | + |
1407 | +SOURCE_TOOLTIPS = YES |
1408 | + |
1409 | +# If the USE_HTAGS tag is set to YES then the references to source code will |
1410 | +# point to the HTML generated by the htags(1) tool instead of doxygen built-in |
1411 | +# source browser. The htags tool is part of GNU's global source tagging system |
1412 | +# (see http://www.gnu.org/software/global/global.html). You will need version |
1413 | +# 4.8.6 or higher. |
1414 | +# |
1415 | +# To use it do the following: |
1416 | +# - Install the latest version of global |
1417 | +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
1418 | +# - Make sure the INPUT points to the root of the source tree |
1419 | +# - Run doxygen as normal |
1420 | +# |
1421 | +# Doxygen will invoke htags (and that will in turn invoke gtags), so these |
1422 | +# tools must be available from the command line (i.e. in the search path). |
1423 | +# |
1424 | +# The result: instead of the source browser generated by doxygen, the links to |
1425 | +# source code will now point to the output of htags. |
1426 | +# The default value is: NO. |
1427 | +# This tag requires that the tag SOURCE_BROWSER is set to YES. |
1428 | + |
1429 | +USE_HTAGS = NO |
1430 | + |
1431 | +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a |
1432 | +# verbatim copy of the header file for each class for which an include is |
1433 | +# specified. Set to NO to disable this. |
1434 | +# See also: Section \class. |
1435 | +# The default value is: YES. |
1436 | |
1437 | VERBATIM_HEADERS = YES |
1438 | |
1439 | #--------------------------------------------------------------------------- |
1440 | -# configuration options related to the alphabetical class index |
1441 | +# Configuration options related to the alphabetical class index |
1442 | #--------------------------------------------------------------------------- |
1443 | |
1444 | -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
1445 | -# of all compounds will be generated. Enable this if the project |
1446 | -# contains a lot of classes, structs, unions or interfaces. |
1447 | +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all |
1448 | +# compounds will be generated. Enable this if the project contains a lot of |
1449 | +# classes, structs, unions or interfaces. |
1450 | +# The default value is: YES. |
1451 | |
1452 | ALPHABETICAL_INDEX = NO |
1453 | |
1454 | -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
1455 | -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
1456 | -# in which this list will be split (can be a number in the range [1..20]) |
1457 | +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in |
1458 | +# which the alphabetical index list will be split. |
1459 | +# Minimum value: 1, maximum value: 20, default value: 5. |
1460 | +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
1461 | |
1462 | COLS_IN_ALPHA_INDEX = 5 |
1463 | |
1464 | -# In case all classes in a project start with a common prefix, all |
1465 | -# classes will be put under the same header in the alphabetical index. |
1466 | -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
1467 | -# should be ignored while generating the index headers. |
1468 | - |
1469 | -IGNORE_PREFIX = |
1470 | - |
1471 | -#--------------------------------------------------------------------------- |
1472 | -# configuration options related to the HTML output |
1473 | -#--------------------------------------------------------------------------- |
1474 | - |
1475 | -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
1476 | -# generate HTML output. |
1477 | +# In case all classes in a project start with a common prefix, all classes will |
1478 | +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag |
1479 | +# can be used to specify a prefix (or a list of prefixes) that should be ignored |
1480 | +# while generating the index headers. |
1481 | +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
1482 | + |
1483 | +IGNORE_PREFIX = |
1484 | + |
1485 | +#--------------------------------------------------------------------------- |
1486 | +# Configuration options related to the HTML output |
1487 | +#--------------------------------------------------------------------------- |
1488 | + |
1489 | +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output |
1490 | +# The default value is: YES. |
1491 | |
1492 | GENERATE_HTML = YES |
1493 | |
1494 | -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
1495 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1496 | -# put in front of it. If left blank `html' will be used as the default path. |
1497 | +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a |
1498 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
1499 | +# it. |
1500 | +# The default directory is: html. |
1501 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1502 | |
1503 | HTML_OUTPUT = html |
1504 | |
1505 | -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
1506 | -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
1507 | -# doxygen will generate files with .html extension. |
1508 | +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each |
1509 | +# generated HTML page (for example: .htm, .php, .asp). |
1510 | +# The default value is: .html. |
1511 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1512 | |
1513 | HTML_FILE_EXTENSION = .html |
1514 | |
1515 | -# The HTML_HEADER tag can be used to specify a personal HTML header for |
1516 | -# each generated HTML page. If it is left blank doxygen will generate a |
1517 | +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for |
1518 | +# each generated HTML page. If the tag is left blank doxygen will generate a |
1519 | # standard header. |
1520 | - |
1521 | -HTML_HEADER = |
1522 | - |
1523 | -# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
1524 | -# each generated HTML page. If it is left blank doxygen will generate a |
1525 | -# standard footer. |
1526 | - |
1527 | -HTML_FOOTER = |
1528 | - |
1529 | -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
1530 | -# style sheet that is used by each HTML page. It can be used to |
1531 | -# fine-tune the look of the HTML output. If the tag is left blank doxygen |
1532 | -# will generate a default style sheet |
1533 | - |
1534 | -HTML_STYLESHEET = |
1535 | - |
1536 | -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
1537 | -# files or namespaces will be aligned in HTML using tables. If set to |
1538 | -# NO a bullet list will be used. |
1539 | - |
1540 | -HTML_ALIGN_MEMBERS = YES |
1541 | - |
1542 | -# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
1543 | -# will be generated that can be used as input for tools like the |
1544 | -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
1545 | -# of the generated HTML documentation. |
1546 | +# |
1547 | +# To get valid HTML the header file that includes any scripts and style sheets |
1548 | +# that doxygen needs, which is dependent on the configuration options used (e.g. |
1549 | +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a |
1550 | +# default header using |
1551 | +# doxygen -w html new_header.html new_footer.html new_stylesheet.css |
1552 | +# YourConfigFile |
1553 | +# and then modify the file new_header.html. See also section "Doxygen usage" |
1554 | +# for information on how to generate the default header that doxygen normally |
1555 | +# uses. |
1556 | +# Note: The header is subject to change so you typically have to regenerate the |
1557 | +# default header when upgrading to a newer version of doxygen. For a description |
1558 | +# of the possible markers and block names see the documentation. |
1559 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1560 | + |
1561 | +HTML_HEADER = |
1562 | + |
1563 | +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
1564 | +# generated HTML page. If the tag is left blank doxygen will generate a standard |
1565 | +# footer. See HTML_HEADER for more information on how to generate a default |
1566 | +# footer and what special commands can be used inside the footer. See also |
1567 | +# section "Doxygen usage" for information on how to generate the default footer |
1568 | +# that doxygen normally uses. |
1569 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1570 | + |
1571 | +HTML_FOOTER = |
1572 | + |
1573 | +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
1574 | +# sheet that is used by each HTML page. It can be used to fine-tune the look of |
1575 | +# the HTML output. If left blank doxygen will generate a default style sheet. |
1576 | +# See also section "Doxygen usage" for information on how to generate the style |
1577 | +# sheet that doxygen normally uses. |
1578 | +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as |
1579 | +# it is more robust and this tag (HTML_STYLESHEET) will in the future become |
1580 | +# obsolete. |
1581 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1582 | + |
1583 | +HTML_STYLESHEET = |
1584 | + |
1585 | +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- |
1586 | +# defined cascading style sheet that is included after the standard style sheets |
1587 | +# created by doxygen. Using this option one can overrule certain style aspects. |
1588 | +# This is preferred over using HTML_STYLESHEET since it does not replace the |
1589 | +# standard style sheet and is therefor more robust against future updates. |
1590 | +# Doxygen will copy the style sheet file to the output directory. For an example |
1591 | +# see the documentation. |
1592 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1593 | + |
1594 | +HTML_EXTRA_STYLESHEET = |
1595 | + |
1596 | +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
1597 | +# other source files which should be copied to the HTML output directory. Note |
1598 | +# that these files will be copied to the base HTML output directory. Use the |
1599 | +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
1600 | +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the |
1601 | +# files will be copied as-is; there are no commands or markers available. |
1602 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1603 | + |
1604 | +HTML_EXTRA_FILES = |
1605 | + |
1606 | +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
1607 | +# will adjust the colors in the stylesheet and background images according to |
1608 | +# this color. Hue is specified as an angle on a colorwheel, see |
1609 | +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
1610 | +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
1611 | +# purple, and 360 is red again. |
1612 | +# Minimum value: 0, maximum value: 359, default value: 220. |
1613 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1614 | + |
1615 | +HTML_COLORSTYLE_HUE = 220 |
1616 | + |
1617 | +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
1618 | +# in the HTML output. For a value of 0 the output will use grayscales only. A |
1619 | +# value of 255 will produce the most vivid colors. |
1620 | +# Minimum value: 0, maximum value: 255, default value: 100. |
1621 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1622 | + |
1623 | +HTML_COLORSTYLE_SAT = 100 |
1624 | + |
1625 | +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the |
1626 | +# luminance component of the colors in the HTML output. Values below 100 |
1627 | +# gradually make the output lighter, whereas values above 100 make the output |
1628 | +# darker. The value divided by 100 is the actual gamma applied, so 80 represents |
1629 | +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not |
1630 | +# change the gamma. |
1631 | +# Minimum value: 40, maximum value: 240, default value: 80. |
1632 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1633 | + |
1634 | +HTML_COLORSTYLE_GAMMA = 80 |
1635 | + |
1636 | +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
1637 | +# page will contain the date and time when the page was generated. Setting this |
1638 | +# to NO can help when comparing the output of multiple runs. |
1639 | +# The default value is: YES. |
1640 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1641 | + |
1642 | +HTML_TIMESTAMP = NO |
1643 | + |
1644 | +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
1645 | +# documentation will contain sections that can be hidden and shown after the |
1646 | +# page has loaded. |
1647 | +# The default value is: NO. |
1648 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1649 | + |
1650 | +HTML_DYNAMIC_SECTIONS = NO |
1651 | + |
1652 | +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
1653 | +# shown in the various tree structured indices initially; the user can expand |
1654 | +# and collapse entries dynamically later on. Doxygen will expand the tree to |
1655 | +# such a level that at most the specified number of entries are visible (unless |
1656 | +# a fully collapsed tree already exceeds this amount). So setting the number of |
1657 | +# entries 1 will produce a full collapsed tree by default. 0 is a special value |
1658 | +# representing an infinite number of entries and will result in a full expanded |
1659 | +# tree by default. |
1660 | +# Minimum value: 0, maximum value: 9999, default value: 100. |
1661 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1662 | + |
1663 | +HTML_INDEX_NUM_ENTRIES = 100 |
1664 | + |
1665 | +# If the GENERATE_DOCSET tag is set to YES, additional index files will be |
1666 | +# generated that can be used as input for Apple's Xcode 3 integrated development |
1667 | +# environment (see: http://developer.apple.com/tools/xcode/), introduced with |
1668 | +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
1669 | +# Makefile in the HTML output directory. Running make will produce the docset in |
1670 | +# that directory and running make install will install the docset in |
1671 | +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
1672 | +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
1673 | +# for more information. |
1674 | +# The default value is: NO. |
1675 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1676 | + |
1677 | +GENERATE_DOCSET = NO |
1678 | + |
1679 | +# This tag determines the name of the docset feed. A documentation feed provides |
1680 | +# an umbrella under which multiple documentation sets from a single provider |
1681 | +# (such as a company or product suite) can be grouped. |
1682 | +# The default value is: Doxygen generated docs. |
1683 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. |
1684 | + |
1685 | +DOCSET_FEEDNAME = "Doxygen generated docs" |
1686 | + |
1687 | +# This tag specifies a string that should uniquely identify the documentation |
1688 | +# set bundle. This should be a reverse domain-name style string, e.g. |
1689 | +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
1690 | +# The default value is: org.doxygen.Project. |
1691 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. |
1692 | + |
1693 | +DOCSET_BUNDLE_ID = org.doxygen.Project |
1694 | + |
1695 | +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify |
1696 | +# the documentation publisher. This should be a reverse domain-name style |
1697 | +# string, e.g. com.mycompany.MyDocSet.documentation. |
1698 | +# The default value is: org.doxygen.Publisher. |
1699 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. |
1700 | + |
1701 | +DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
1702 | + |
1703 | +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. |
1704 | +# The default value is: Publisher. |
1705 | +# This tag requires that the tag GENERATE_DOCSET is set to YES. |
1706 | + |
1707 | +DOCSET_PUBLISHER_NAME = Publisher |
1708 | + |
1709 | +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
1710 | +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
1711 | +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
1712 | +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
1713 | +# Windows. |
1714 | +# |
1715 | +# The HTML Help Workshop contains a compiler that can convert all HTML output |
1716 | +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
1717 | +# files are now used as the Windows 98 help format, and will replace the old |
1718 | +# Windows help format (.hlp) on all Windows platforms in the future. Compressed |
1719 | +# HTML files also contain an index, a table of contents, and you can search for |
1720 | +# words in the documentation. The HTML workshop also contains a viewer for |
1721 | +# compressed HTML files. |
1722 | +# The default value is: NO. |
1723 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1724 | |
1725 | GENERATE_HTMLHELP = NO |
1726 | |
1727 | -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
1728 | -# be used to specify the file name of the resulting .chm file. You |
1729 | -# can add a path in front of the file if the result should not be |
1730 | -# written to the html output dir. |
1731 | - |
1732 | -CHM_FILE = |
1733 | - |
1734 | -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
1735 | -# be used to specify the location (absolute path including file name) of |
1736 | -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
1737 | -# the HTML help compiler on the generated index.hhp. |
1738 | - |
1739 | -HHC_LOCATION = |
1740 | - |
1741 | -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
1742 | -# controls if a separate .chi index file is generated (YES) or that |
1743 | -# it should be included in the master .chm file (NO). |
1744 | +# The CHM_FILE tag can be used to specify the file name of the resulting .chm |
1745 | +# file. You can add a path in front of the file if the result should not be |
1746 | +# written to the html output directory. |
1747 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1748 | + |
1749 | +CHM_FILE = |
1750 | + |
1751 | +# The HHC_LOCATION tag can be used to specify the location (absolute path |
1752 | +# including file name) of the HTML help compiler ( hhc.exe). If non-empty |
1753 | +# doxygen will try to run the HTML help compiler on the generated index.hhp. |
1754 | +# The file has to be specified with full path. |
1755 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1756 | + |
1757 | +HHC_LOCATION = |
1758 | + |
1759 | +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( |
1760 | +# YES) or that it should be included in the master .chm file ( NO). |
1761 | +# The default value is: NO. |
1762 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1763 | |
1764 | GENERATE_CHI = NO |
1765 | |
1766 | -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
1767 | -# controls whether a binary table of contents is generated (YES) or a |
1768 | -# normal table of contents (NO) in the .chm file. |
1769 | +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) |
1770 | +# and project file content. |
1771 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1772 | + |
1773 | +CHM_INDEX_ENCODING = |
1774 | + |
1775 | +# The BINARY_TOC flag controls whether a binary table of contents is generated ( |
1776 | +# YES) or a normal table of contents ( NO) in the .chm file. |
1777 | +# The default value is: NO. |
1778 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1779 | |
1780 | BINARY_TOC = NO |
1781 | |
1782 | -# The TOC_EXPAND flag can be set to YES to add extra items for group members |
1783 | -# to the contents of the HTML help documentation and to the tree view. |
1784 | +# The TOC_EXPAND flag can be set to YES to add extra items for group members to |
1785 | +# the table of contents of the HTML help documentation and to the tree view. |
1786 | +# The default value is: NO. |
1787 | +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1788 | |
1789 | TOC_EXPAND = YES |
1790 | |
1791 | -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
1792 | -# top of each HTML page. The value NO (the default) enables the index and |
1793 | -# the value YES disables it. |
1794 | +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
1795 | +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
1796 | +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
1797 | +# (.qch) of the generated HTML documentation. |
1798 | +# The default value is: NO. |
1799 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1800 | + |
1801 | +GENERATE_QHP = NO |
1802 | + |
1803 | +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify |
1804 | +# the file name of the resulting .qch file. The path specified is relative to |
1805 | +# the HTML output folder. |
1806 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1807 | + |
1808 | +QCH_FILE = |
1809 | + |
1810 | +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
1811 | +# Project output. For more information please see Qt Help Project / Namespace |
1812 | +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
1813 | +# The default value is: org.doxygen.Project. |
1814 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1815 | + |
1816 | +QHP_NAMESPACE = org.doxygen.Project |
1817 | + |
1818 | +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
1819 | +# Help Project output. For more information please see Qt Help Project / Virtual |
1820 | +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
1821 | +# folders). |
1822 | +# The default value is: doc. |
1823 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1824 | + |
1825 | +QHP_VIRTUAL_FOLDER = doc |
1826 | + |
1827 | +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
1828 | +# filter to add. For more information please see Qt Help Project / Custom |
1829 | +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
1830 | +# filters). |
1831 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1832 | + |
1833 | +QHP_CUST_FILTER_NAME = |
1834 | + |
1835 | +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
1836 | +# custom filter to add. For more information please see Qt Help Project / Custom |
1837 | +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
1838 | +# filters). |
1839 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1840 | + |
1841 | +QHP_CUST_FILTER_ATTRS = |
1842 | + |
1843 | +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1844 | +# project's filter section matches. Qt Help Project / Filter Attributes (see: |
1845 | +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
1846 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1847 | + |
1848 | +QHP_SECT_FILTER_ATTRS = |
1849 | + |
1850 | +# The QHG_LOCATION tag can be used to specify the location of Qt's |
1851 | +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
1852 | +# generated .qhp file. |
1853 | +# This tag requires that the tag GENERATE_QHP is set to YES. |
1854 | + |
1855 | +QHG_LOCATION = |
1856 | + |
1857 | +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
1858 | +# generated, together with the HTML files, they form an Eclipse help plugin. To |
1859 | +# install this plugin and make it available under the help contents menu in |
1860 | +# Eclipse, the contents of the directory containing the HTML and XML files needs |
1861 | +# to be copied into the plugins directory of eclipse. The name of the directory |
1862 | +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. |
1863 | +# After copying Eclipse needs to be restarted before the help appears. |
1864 | +# The default value is: NO. |
1865 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1866 | + |
1867 | +GENERATE_ECLIPSEHELP = NO |
1868 | + |
1869 | +# A unique identifier for the Eclipse help plugin. When installing the plugin |
1870 | +# the directory name containing the HTML and XML files should also have this |
1871 | +# name. Each documentation set should have its own identifier. |
1872 | +# The default value is: org.doxygen.Project. |
1873 | +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. |
1874 | + |
1875 | +ECLIPSE_DOC_ID = org.doxygen.Project |
1876 | + |
1877 | +# If you want full control over the layout of the generated HTML pages it might |
1878 | +# be necessary to disable the index and replace it with your own. The |
1879 | +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top |
1880 | +# of each HTML page. A value of NO enables the index and the value YES disables |
1881 | +# it. Since the tabs in the index contain the same information as the navigation |
1882 | +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. |
1883 | +# The default value is: NO. |
1884 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1885 | |
1886 | DISABLE_INDEX = NO |
1887 | |
1888 | -# This tag can be used to set the number of enum values (range [1..20]) |
1889 | -# that doxygen will group on one line in the generated HTML documentation. |
1890 | +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
1891 | +# structure should be generated to display hierarchical information. If the tag |
1892 | +# value is set to YES, a side panel will be generated containing a tree-like |
1893 | +# index structure (just like the one that is generated for HTML Help). For this |
1894 | +# to work a browser that supports JavaScript, DHTML, CSS and frames is required |
1895 | +# (i.e. any modern browser). Windows users are probably better off using the |
1896 | +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can |
1897 | +# further fine-tune the look of the index. As an example, the default style |
1898 | +# sheet generated by doxygen has an example that shows how to put an image at |
1899 | +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
1900 | +# the same information as the tab index, you could consider setting |
1901 | +# DISABLE_INDEX to YES when enabling this option. |
1902 | +# The default value is: NO. |
1903 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1904 | + |
1905 | +GENERATE_TREEVIEW = NO |
1906 | + |
1907 | +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
1908 | +# doxygen will group on one line in the generated HTML documentation. |
1909 | +# |
1910 | +# Note that a value of 0 will completely suppress the enum values from appearing |
1911 | +# in the overview section. |
1912 | +# Minimum value: 0, maximum value: 20, default value: 4. |
1913 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1914 | |
1915 | ENUM_VALUES_PER_LINE = 4 |
1916 | |
1917 | -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
1918 | -# generated containing a tree-like index structure (just like the one that |
1919 | -# is generated for HTML Help). For this to work a browser that supports |
1920 | -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
1921 | -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
1922 | -# probably better off using the HTML help feature. |
1923 | - |
1924 | -GENERATE_TREEVIEW = NO |
1925 | - |
1926 | -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
1927 | -# used to set the initial width (in pixels) of the frame in which the tree |
1928 | -# is shown. |
1929 | +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used |
1930 | +# to set the initial width (in pixels) of the frame in which the tree is shown. |
1931 | +# Minimum value: 0, maximum value: 1500, default value: 250. |
1932 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1933 | |
1934 | TREEVIEW_WIDTH = 250 |
1935 | |
1936 | -#--------------------------------------------------------------------------- |
1937 | -# configuration options related to the LaTeX output |
1938 | -#--------------------------------------------------------------------------- |
1939 | - |
1940 | -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
1941 | -# generate Latex output. |
1942 | +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to |
1943 | +# external symbols imported via tag files in a separate window. |
1944 | +# The default value is: NO. |
1945 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1946 | + |
1947 | +EXT_LINKS_IN_WINDOW = NO |
1948 | + |
1949 | +# Use this tag to change the font size of LaTeX formulas included as images in |
1950 | +# the HTML documentation. When you change the font size after a successful |
1951 | +# doxygen run you need to manually remove any form_*.png images from the HTML |
1952 | +# output directory to force them to be regenerated. |
1953 | +# Minimum value: 8, maximum value: 50, default value: 10. |
1954 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1955 | + |
1956 | +FORMULA_FONTSIZE = 10 |
1957 | + |
1958 | +# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
1959 | +# generated for formulas are transparent PNGs. Transparent PNGs are not |
1960 | +# supported properly for IE 6.0, but are supported on all modern browsers. |
1961 | +# |
1962 | +# Note that when changing this option you need to delete any form_*.png files in |
1963 | +# the HTML output directory before the changes have effect. |
1964 | +# The default value is: YES. |
1965 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1966 | + |
1967 | +FORMULA_TRANSPARENT = YES |
1968 | + |
1969 | +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
1970 | +# http://www.mathjax.org) which uses client side Javascript for the rendering |
1971 | +# instead of using prerendered bitmaps. Use this if you do not have LaTeX |
1972 | +# installed or if you want to formulas look prettier in the HTML output. When |
1973 | +# enabled you may also need to install MathJax separately and configure the path |
1974 | +# to it using the MATHJAX_RELPATH option. |
1975 | +# The default value is: NO. |
1976 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
1977 | + |
1978 | +USE_MATHJAX = NO |
1979 | + |
1980 | +# When MathJax is enabled you can set the default output format to be used for |
1981 | +# the MathJax output. See the MathJax site (see: |
1982 | +# http://docs.mathjax.org/en/latest/output.html) for more details. |
1983 | +# Possible values are: HTML-CSS (which is slower, but has the best |
1984 | +# compatibility), NativeMML (i.e. MathML) and SVG. |
1985 | +# The default value is: HTML-CSS. |
1986 | +# This tag requires that the tag USE_MATHJAX is set to YES. |
1987 | + |
1988 | +MATHJAX_FORMAT = HTML-CSS |
1989 | + |
1990 | +# When MathJax is enabled you need to specify the location relative to the HTML |
1991 | +# output directory using the MATHJAX_RELPATH option. The destination directory |
1992 | +# should contain the MathJax.js script. For instance, if the mathjax directory |
1993 | +# is located at the same level as the HTML output directory, then |
1994 | +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
1995 | +# Content Delivery Network so you can quickly see the result without installing |
1996 | +# MathJax. However, it is strongly recommended to install a local copy of |
1997 | +# MathJax from http://www.mathjax.org before deployment. |
1998 | +# The default value is: http://cdn.mathjax.org/mathjax/latest. |
1999 | +# This tag requires that the tag USE_MATHJAX is set to YES. |
2000 | + |
2001 | +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
2002 | + |
2003 | +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
2004 | +# extension names that should be enabled during MathJax rendering. For example |
2005 | +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
2006 | +# This tag requires that the tag USE_MATHJAX is set to YES. |
2007 | + |
2008 | +MATHJAX_EXTENSIONS = |
2009 | + |
2010 | +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
2011 | +# of code that will be used on startup of the MathJax code. See the MathJax site |
2012 | +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an |
2013 | +# example see the documentation. |
2014 | +# This tag requires that the tag USE_MATHJAX is set to YES. |
2015 | + |
2016 | +MATHJAX_CODEFILE = |
2017 | + |
2018 | +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
2019 | +# the HTML output. The underlying search engine uses javascript and DHTML and |
2020 | +# should work on any modern browser. Note that when using HTML help |
2021 | +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) |
2022 | +# there is already a search function so this one should typically be disabled. |
2023 | +# For large projects the javascript based search engine can be slow, then |
2024 | +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to |
2025 | +# search using the keyboard; to jump to the search box use <access key> + S |
2026 | +# (what the <access key> is depends on the OS and browser, but it is typically |
2027 | +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down |
2028 | +# key> to jump into the search results window, the results can be navigated |
2029 | +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel |
2030 | +# the search. The filter options can be selected when the cursor is inside the |
2031 | +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> |
2032 | +# to select a filter and <Enter> or <escape> to activate or cancel the filter |
2033 | +# option. |
2034 | +# The default value is: YES. |
2035 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
2036 | + |
2037 | +SEARCHENGINE = NO |
2038 | + |
2039 | +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
2040 | +# implemented using a web server instead of a web client using Javascript. There |
2041 | +# are two flavours of web server based searching depending on the |
2042 | +# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for |
2043 | +# searching and an index file used by the script. When EXTERNAL_SEARCH is |
2044 | +# enabled the indexing and searching needs to be provided by external tools. See |
2045 | +# the section "External Indexing and Searching" for details. |
2046 | +# The default value is: NO. |
2047 | +# This tag requires that the tag SEARCHENGINE is set to YES. |
2048 | + |
2049 | +SERVER_BASED_SEARCH = NO |
2050 | + |
2051 | +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP |
2052 | +# script for searching. Instead the search results are written to an XML file |
2053 | +# which needs to be processed by an external indexer. Doxygen will invoke an |
2054 | +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
2055 | +# search results. |
2056 | +# |
2057 | +# Doxygen ships with an example indexer ( doxyindexer) and search engine |
2058 | +# (doxysearch.cgi) which are based on the open source search engine library |
2059 | +# Xapian (see: http://xapian.org/). |
2060 | +# |
2061 | +# See the section "External Indexing and Searching" for details. |
2062 | +# The default value is: NO. |
2063 | +# This tag requires that the tag SEARCHENGINE is set to YES. |
2064 | + |
2065 | +EXTERNAL_SEARCH = NO |
2066 | + |
2067 | +# The SEARCHENGINE_URL should point to a search engine hosted by a web server |
2068 | +# which will return the search results when EXTERNAL_SEARCH is enabled. |
2069 | +# |
2070 | +# Doxygen ships with an example indexer ( doxyindexer) and search engine |
2071 | +# (doxysearch.cgi) which are based on the open source search engine library |
2072 | +# Xapian (see: http://xapian.org/). See the section "External Indexing and |
2073 | +# Searching" for details. |
2074 | +# This tag requires that the tag SEARCHENGINE is set to YES. |
2075 | + |
2076 | +SEARCHENGINE_URL = |
2077 | + |
2078 | +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
2079 | +# search data is written to a file for indexing by an external tool. With the |
2080 | +# SEARCHDATA_FILE tag the name of this file can be specified. |
2081 | +# The default file is: searchdata.xml. |
2082 | +# This tag requires that the tag SEARCHENGINE is set to YES. |
2083 | + |
2084 | +SEARCHDATA_FILE = searchdata.xml |
2085 | + |
2086 | +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the |
2087 | +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is |
2088 | +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple |
2089 | +# projects and redirect the results back to the right project. |
2090 | +# This tag requires that the tag SEARCHENGINE is set to YES. |
2091 | + |
2092 | +EXTERNAL_SEARCH_ID = |
2093 | + |
2094 | +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
2095 | +# projects other than the one defined by this configuration file, but that are |
2096 | +# all added to the same external search index. Each project needs to have a |
2097 | +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of |
2098 | +# to a relative location where the documentation can be found. The format is: |
2099 | +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
2100 | +# This tag requires that the tag SEARCHENGINE is set to YES. |
2101 | + |
2102 | +EXTRA_SEARCH_MAPPINGS = |
2103 | + |
2104 | +#--------------------------------------------------------------------------- |
2105 | +# Configuration options related to the LaTeX output |
2106 | +#--------------------------------------------------------------------------- |
2107 | + |
2108 | +# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. |
2109 | +# The default value is: YES. |
2110 | |
2111 | GENERATE_LATEX = NO |
2112 | |
2113 | -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
2114 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
2115 | -# put in front of it. If left blank `latex' will be used as the default path. |
2116 | +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a |
2117 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
2118 | +# it. |
2119 | +# The default directory is: latex. |
2120 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2121 | |
2122 | LATEX_OUTPUT = latex |
2123 | |
2124 | -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
2125 | -# invoked. If left blank `latex' will be used as the default command name. |
2126 | +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
2127 | +# invoked. |
2128 | +# |
2129 | +# Note that when enabling USE_PDFLATEX this option is only used for generating |
2130 | +# bitmaps for formulas in the HTML output, but not in the Makefile that is |
2131 | +# written to the output directory. |
2132 | +# The default file is: latex. |
2133 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2134 | |
2135 | LATEX_CMD_NAME = latex |
2136 | |
2137 | -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
2138 | -# generate index for LaTeX. If left blank `makeindex' will be used as the |
2139 | -# default command name. |
2140 | +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
2141 | +# index for LaTeX. |
2142 | +# The default file is: makeindex. |
2143 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2144 | |
2145 | MAKEINDEX_CMD_NAME = makeindex |
2146 | |
2147 | -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
2148 | -# LaTeX documents. This may be useful for small projects and may help to |
2149 | -# save some trees in general. |
2150 | +# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX |
2151 | +# documents. This may be useful for small projects and may help to save some |
2152 | +# trees in general. |
2153 | +# The default value is: NO. |
2154 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2155 | |
2156 | COMPACT_LATEX = NO |
2157 | |
2158 | -# The PAPER_TYPE tag can be used to set the paper type that is used |
2159 | -# by the printer. Possible values are: a4, a4wide, letter, legal and |
2160 | -# executive. If left blank a4wide will be used. |
2161 | +# The PAPER_TYPE tag can be used to set the paper type that is used by the |
2162 | +# printer. |
2163 | +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x |
2164 | +# 14 inches) and executive (7.25 x 10.5 inches). |
2165 | +# The default value is: a4. |
2166 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2167 | |
2168 | PAPER_TYPE = a4wide |
2169 | |
2170 | -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
2171 | -# packages that should be included in the LaTeX output. |
2172 | - |
2173 | -EXTRA_PACKAGES = |
2174 | - |
2175 | -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
2176 | -# the generated latex document. The header should contain everything until |
2177 | -# the first chapter. If it is left blank doxygen will generate a |
2178 | -# standard header. Notice: only use this tag if you know what you are doing! |
2179 | - |
2180 | -LATEX_HEADER = |
2181 | - |
2182 | -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
2183 | -# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
2184 | -# contain links (just like the HTML output) instead of page references |
2185 | -# This makes the output suitable for online browsing using a pdf viewer. |
2186 | +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
2187 | +# that should be included in the LaTeX output. To get the times font for |
2188 | +# instance you can specify |
2189 | +# EXTRA_PACKAGES=times |
2190 | +# If left blank no extra packages will be included. |
2191 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2192 | + |
2193 | +EXTRA_PACKAGES = |
2194 | + |
2195 | +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
2196 | +# generated LaTeX document. The header should contain everything until the first |
2197 | +# chapter. If it is left blank doxygen will generate a standard header. See |
2198 | +# section "Doxygen usage" for information on how to let doxygen write the |
2199 | +# default header to a separate file. |
2200 | +# |
2201 | +# Note: Only use a user-defined header if you know what you are doing! The |
2202 | +# following commands have a special meaning inside the header: $title, |
2203 | +# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will |
2204 | +# replace them by respectively the title of the page, the current date and time, |
2205 | +# only the current date, the version number of doxygen, the project name (see |
2206 | +# PROJECT_NAME), or the project number (see PROJECT_NUMBER). |
2207 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2208 | + |
2209 | +LATEX_HEADER = |
2210 | + |
2211 | +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
2212 | +# generated LaTeX document. The footer should contain everything after the last |
2213 | +# chapter. If it is left blank doxygen will generate a standard footer. |
2214 | +# |
2215 | +# Note: Only use a user-defined footer if you know what you are doing! |
2216 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2217 | + |
2218 | +LATEX_FOOTER = |
2219 | + |
2220 | +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
2221 | +# other source files which should be copied to the LATEX_OUTPUT output |
2222 | +# directory. Note that the files will be copied as-is; there are no commands or |
2223 | +# markers available. |
2224 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2225 | + |
2226 | +LATEX_EXTRA_FILES = |
2227 | + |
2228 | +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
2229 | +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
2230 | +# contain links (just like the HTML output) instead of page references. This |
2231 | +# makes the output suitable for online browsing using a PDF viewer. |
2232 | +# The default value is: YES. |
2233 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2234 | |
2235 | PDF_HYPERLINKS = NO |
2236 | |
2237 | -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
2238 | -# plain latex in the generated Makefile. Set this option to YES to get a |
2239 | +# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
2240 | +# the PDF file directly from the LaTeX files. Set this option to YES to get a |
2241 | # higher quality PDF documentation. |
2242 | +# The default value is: YES. |
2243 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2244 | |
2245 | USE_PDFLATEX = NO |
2246 | |
2247 | -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
2248 | -# command to the generated LaTeX files. This will instruct LaTeX to keep |
2249 | -# running if errors occur, instead of asking the user for help. |
2250 | -# This option is also used when generating formulas in HTML. |
2251 | +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
2252 | +# command to the generated LaTeX files. This will instruct LaTeX to keep running |
2253 | +# if errors occur, instead of asking the user for help. This option is also used |
2254 | +# when generating formulas in HTML. |
2255 | +# The default value is: NO. |
2256 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2257 | |
2258 | LATEX_BATCHMODE = NO |
2259 | |
2260 | -# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
2261 | -# include the index chapters (such as File Index, Compound Index, etc.) |
2262 | -# in the output. |
2263 | +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the |
2264 | +# index chapters (such as File Index, Compound Index, etc.) in the output. |
2265 | +# The default value is: NO. |
2266 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2267 | |
2268 | LATEX_HIDE_INDICES = NO |
2269 | |
2270 | -#--------------------------------------------------------------------------- |
2271 | -# configuration options related to the RTF output |
2272 | -#--------------------------------------------------------------------------- |
2273 | - |
2274 | -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
2275 | -# The RTF output is optimised for Word 97 and may not look very pretty with |
2276 | -# other RTF readers or editors. |
2277 | +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source |
2278 | +# code with syntax highlighting in the LaTeX output. |
2279 | +# |
2280 | +# Note that which sources are shown also depends on other settings such as |
2281 | +# SOURCE_BROWSER. |
2282 | +# The default value is: NO. |
2283 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2284 | + |
2285 | +LATEX_SOURCE_CODE = NO |
2286 | + |
2287 | +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
2288 | +# bibliography, e.g. plainnat, or ieeetr. See |
2289 | +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
2290 | +# The default value is: plain. |
2291 | +# This tag requires that the tag GENERATE_LATEX is set to YES. |
2292 | + |
2293 | +LATEX_BIB_STYLE = plain |
2294 | + |
2295 | +#--------------------------------------------------------------------------- |
2296 | +# Configuration options related to the RTF output |
2297 | +#--------------------------------------------------------------------------- |
2298 | + |
2299 | +# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The |
2300 | +# RTF output is optimized for Word 97 and may not look too pretty with other RTF |
2301 | +# readers/editors. |
2302 | +# The default value is: NO. |
2303 | |
2304 | GENERATE_RTF = NO |
2305 | |
2306 | -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
2307 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
2308 | -# put in front of it. If left blank `rtf' will be used as the default path. |
2309 | +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a |
2310 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
2311 | +# it. |
2312 | +# The default directory is: rtf. |
2313 | +# This tag requires that the tag GENERATE_RTF is set to YES. |
2314 | |
2315 | RTF_OUTPUT = rtf |
2316 | |
2317 | -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
2318 | -# RTF documents. This may be useful for small projects and may help to |
2319 | -# save some trees in general. |
2320 | +# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF |
2321 | +# documents. This may be useful for small projects and may help to save some |
2322 | +# trees in general. |
2323 | +# The default value is: NO. |
2324 | +# This tag requires that the tag GENERATE_RTF is set to YES. |
2325 | |
2326 | COMPACT_RTF = NO |
2327 | |
2328 | -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
2329 | -# will contain hyperlink fields. The RTF file will |
2330 | -# contain links (just like the HTML output) instead of page references. |
2331 | -# This makes the output suitable for online browsing using WORD or other |
2332 | -# programs which support those fields. |
2333 | -# Note: wordpad (write) and others do not support links. |
2334 | +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will |
2335 | +# contain hyperlink fields. The RTF file will contain links (just like the HTML |
2336 | +# output) instead of page references. This makes the output suitable for online |
2337 | +# browsing using Word or some other Word compatible readers that support those |
2338 | +# fields. |
2339 | +# |
2340 | +# Note: WordPad (write) and others do not support links. |
2341 | +# The default value is: NO. |
2342 | +# This tag requires that the tag GENERATE_RTF is set to YES. |
2343 | |
2344 | RTF_HYPERLINKS = NO |
2345 | |
2346 | -# Load stylesheet definitions from file. Syntax is similar to doxygen's |
2347 | -# config file, i.e. a series of assigments. You only have to provide |
2348 | -# replacements, missing definitions are set to their default value. |
2349 | - |
2350 | -RTF_STYLESHEET_FILE = |
2351 | - |
2352 | -# Set optional variables used in the generation of an rtf document. |
2353 | -# Syntax is similar to doxygen's config file. |
2354 | - |
2355 | -RTF_EXTENSIONS_FILE = |
2356 | - |
2357 | -#--------------------------------------------------------------------------- |
2358 | -# configuration options related to the man page output |
2359 | -#--------------------------------------------------------------------------- |
2360 | - |
2361 | -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
2362 | -# generate man pages |
2363 | +# Load stylesheet definitions from file. Syntax is similar to doxygen's config |
2364 | +# file, i.e. a series of assignments. You only have to provide replacements, |
2365 | +# missing definitions are set to their default value. |
2366 | +# |
2367 | +# See also section "Doxygen usage" for information on how to generate the |
2368 | +# default style sheet that doxygen normally uses. |
2369 | +# This tag requires that the tag GENERATE_RTF is set to YES. |
2370 | + |
2371 | +RTF_STYLESHEET_FILE = |
2372 | + |
2373 | +# Set optional variables used in the generation of an RTF document. Syntax is |
2374 | +# similar to doxygen's config file. A template extensions file can be generated |
2375 | +# using doxygen -e rtf extensionFile. |
2376 | +# This tag requires that the tag GENERATE_RTF is set to YES. |
2377 | + |
2378 | +RTF_EXTENSIONS_FILE = |
2379 | + |
2380 | +#--------------------------------------------------------------------------- |
2381 | +# Configuration options related to the man page output |
2382 | +#--------------------------------------------------------------------------- |
2383 | + |
2384 | +# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for |
2385 | +# classes and files. |
2386 | +# The default value is: NO. |
2387 | |
2388 | GENERATE_MAN = NO |
2389 | |
2390 | -# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
2391 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
2392 | -# put in front of it. If left blank `man' will be used as the default path. |
2393 | +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a |
2394 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
2395 | +# it. A directory man3 will be created inside the directory specified by |
2396 | +# MAN_OUTPUT. |
2397 | +# The default directory is: man. |
2398 | +# This tag requires that the tag GENERATE_MAN is set to YES. |
2399 | |
2400 | MAN_OUTPUT = man |
2401 | |
2402 | -# The MAN_EXTENSION tag determines the extension that is added to |
2403 | -# the generated man pages (default is the subroutine's section .3) |
2404 | +# The MAN_EXTENSION tag determines the extension that is added to the generated |
2405 | +# man pages. In case the manual section does not start with a number, the number |
2406 | +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is |
2407 | +# optional. |
2408 | +# The default value is: .3. |
2409 | +# This tag requires that the tag GENERATE_MAN is set to YES. |
2410 | |
2411 | MAN_EXTENSION = .3 |
2412 | |
2413 | -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
2414 | -# then it will generate one additional man file for each entity |
2415 | -# documented in the real man page(s). These additional files |
2416 | -# only source the real man page, but without them the man command |
2417 | -# would be unable to find the correct page. The default is NO. |
2418 | +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
2419 | +# will generate one additional man file for each entity documented in the real |
2420 | +# man page(s). These additional files only source the real man page, but without |
2421 | +# them the man command would be unable to find the correct page. |
2422 | +# The default value is: NO. |
2423 | +# This tag requires that the tag GENERATE_MAN is set to YES. |
2424 | |
2425 | MAN_LINKS = NO |
2426 | |
2427 | #--------------------------------------------------------------------------- |
2428 | -# configuration options related to the XML output |
2429 | +# Configuration options related to the XML output |
2430 | #--------------------------------------------------------------------------- |
2431 | |
2432 | -# If the GENERATE_XML tag is set to YES Doxygen will |
2433 | -# generate an XML file that captures the structure of |
2434 | -# the code including all documentation. Note that this |
2435 | -# feature is still experimental and incomplete at the |
2436 | -# moment. |
2437 | +# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that |
2438 | +# captures the structure of the code including all documentation. |
2439 | +# The default value is: NO. |
2440 | |
2441 | GENERATE_XML = NO |
2442 | |
2443 | -# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
2444 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
2445 | -# put in front of it. If left blank `xml' will be used as the default path. |
2446 | +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a |
2447 | +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
2448 | +# it. |
2449 | +# The default directory is: xml. |
2450 | +# This tag requires that the tag GENERATE_XML is set to YES. |
2451 | |
2452 | XML_OUTPUT = xml |
2453 | |
2454 | -# The XML_SCHEMA tag can be used to specify an XML schema, |
2455 | -# which can be used by a validating XML parser to check the |
2456 | -# syntax of the XML files. |
2457 | - |
2458 | -XML_SCHEMA = |
2459 | - |
2460 | -# The XML_DTD tag can be used to specify an XML DTD, |
2461 | -# which can be used by a validating XML parser to check the |
2462 | -# syntax of the XML files. |
2463 | - |
2464 | -XML_DTD = |
2465 | - |
2466 | -#--------------------------------------------------------------------------- |
2467 | -# configuration options for the AutoGen Definitions output |
2468 | -#--------------------------------------------------------------------------- |
2469 | - |
2470 | -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
2471 | -# generate an AutoGen Definitions (see autogen.sf.net) file |
2472 | -# that captures the structure of the code including all |
2473 | -# documentation. Note that this feature is still experimental |
2474 | -# and incomplete at the moment. |
2475 | +# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a |
2476 | +# validating XML parser to check the syntax of the XML files. |
2477 | +# This tag requires that the tag GENERATE_XML is set to YES. |
2478 | + |
2479 | +XML_SCHEMA = |
2480 | + |
2481 | +# The XML_DTD tag can be used to specify a XML DTD, which can be used by a |
2482 | +# validating XML parser to check the syntax of the XML files. |
2483 | +# This tag requires that the tag GENERATE_XML is set to YES. |
2484 | + |
2485 | +XML_DTD = |
2486 | + |
2487 | +# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program |
2488 | +# listings (including syntax highlighting and cross-referencing information) to |
2489 | +# the XML output. Note that enabling this will significantly increase the size |
2490 | +# of the XML output. |
2491 | +# The default value is: YES. |
2492 | +# This tag requires that the tag GENERATE_XML is set to YES. |
2493 | + |
2494 | +XML_PROGRAMLISTING = YES |
2495 | + |
2496 | +#--------------------------------------------------------------------------- |
2497 | +# Configuration options related to the DOCBOOK output |
2498 | +#--------------------------------------------------------------------------- |
2499 | + |
2500 | +# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files |
2501 | +# that can be used to generate PDF. |
2502 | +# The default value is: NO. |
2503 | + |
2504 | +GENERATE_DOCBOOK = NO |
2505 | + |
2506 | +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. |
2507 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in |
2508 | +# front of it. |
2509 | +# The default directory is: docbook. |
2510 | +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
2511 | + |
2512 | +DOCBOOK_OUTPUT = docbook |
2513 | + |
2514 | +#--------------------------------------------------------------------------- |
2515 | +# Configuration options for the AutoGen Definitions output |
2516 | +#--------------------------------------------------------------------------- |
2517 | + |
2518 | +# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen |
2519 | +# Definitions (see http://autogen.sf.net) file that captures the structure of |
2520 | +# the code including all documentation. Note that this feature is still |
2521 | +# experimental and incomplete at the moment. |
2522 | +# The default value is: NO. |
2523 | |
2524 | GENERATE_AUTOGEN_DEF = NO |
2525 | |
2526 | #--------------------------------------------------------------------------- |
2527 | -# configuration options related to the Perl module output |
2528 | +# Configuration options related to the Perl module output |
2529 | #--------------------------------------------------------------------------- |
2530 | |
2531 | -# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
2532 | -# generate a Perl module file that captures the structure of |
2533 | -# the code including all documentation. Note that this |
2534 | -# feature is still experimental and incomplete at the |
2535 | -# moment. |
2536 | +# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module |
2537 | +# file that captures the structure of the code including all documentation. |
2538 | +# |
2539 | +# Note that this feature is still experimental and incomplete at the moment. |
2540 | +# The default value is: NO. |
2541 | |
2542 | GENERATE_PERLMOD = NO |
2543 | |
2544 | -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
2545 | -# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
2546 | -# to generate PDF and DVI output from the Perl module output. |
2547 | +# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary |
2548 | +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
2549 | +# output from the Perl module output. |
2550 | +# The default value is: NO. |
2551 | +# This tag requires that the tag GENERATE_PERLMOD is set to YES. |
2552 | |
2553 | PERLMOD_LATEX = NO |
2554 | |
2555 | -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
2556 | -# nicely formatted so it can be parsed by a human reader. This is useful |
2557 | -# if you want to understand what is going on. On the other hand, if this |
2558 | -# tag is set to NO the size of the Perl module output will be much smaller |
2559 | -# and Perl will parse it just the same. |
2560 | +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely |
2561 | +# formatted so it can be parsed by a human reader. This is useful if you want to |
2562 | +# understand what is going on. On the other hand, if this tag is set to NO the |
2563 | +# size of the Perl module output will be much smaller and Perl will parse it |
2564 | +# just the same. |
2565 | +# The default value is: YES. |
2566 | +# This tag requires that the tag GENERATE_PERLMOD is set to YES. |
2567 | |
2568 | PERLMOD_PRETTY = YES |
2569 | |
2570 | -# The names of the make variables in the generated doxyrules.make file |
2571 | -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
2572 | -# This is useful so different doxyrules.make files included by the same |
2573 | -# Makefile don't overwrite each other's variables. |
2574 | - |
2575 | -PERLMOD_MAKEVAR_PREFIX = |
2576 | - |
2577 | -#--------------------------------------------------------------------------- |
2578 | -# Configuration options related to the preprocessor |
2579 | -#--------------------------------------------------------------------------- |
2580 | - |
2581 | -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
2582 | -# evaluate all C-preprocessor directives found in the sources and include |
2583 | -# files. |
2584 | +# The names of the make variables in the generated doxyrules.make file are |
2585 | +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful |
2586 | +# so different doxyrules.make files included by the same Makefile don't |
2587 | +# overwrite each other's variables. |
2588 | +# This tag requires that the tag GENERATE_PERLMOD is set to YES. |
2589 | + |
2590 | +PERLMOD_MAKEVAR_PREFIX = |
2591 | + |
2592 | +#--------------------------------------------------------------------------- |
2593 | +# Configuration options related to the preprocessor |
2594 | +#--------------------------------------------------------------------------- |
2595 | + |
2596 | +# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all |
2597 | +# C-preprocessor directives found in the sources and include files. |
2598 | +# The default value is: YES. |
2599 | |
2600 | ENABLE_PREPROCESSING = YES |
2601 | |
2602 | -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
2603 | -# names in the source code. If set to NO (the default) only conditional |
2604 | -# compilation will be performed. Macro expansion can be done in a controlled |
2605 | -# way by setting EXPAND_ONLY_PREDEF to YES. |
2606 | +# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names |
2607 | +# in the source code. If set to NO only conditional compilation will be |
2608 | +# performed. Macro expansion can be done in a controlled way by setting |
2609 | +# EXPAND_ONLY_PREDEF to YES. |
2610 | +# The default value is: NO. |
2611 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2612 | |
2613 | MACRO_EXPANSION = NO |
2614 | |
2615 | -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
2616 | -# then the macro expansion is limited to the macros specified with the |
2617 | -# PREDEFINED and EXPAND_AS_PREDEFINED tags. |
2618 | +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then |
2619 | +# the macro expansion is limited to the macros specified with the PREDEFINED and |
2620 | +# EXPAND_AS_DEFINED tags. |
2621 | +# The default value is: NO. |
2622 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2623 | |
2624 | EXPAND_ONLY_PREDEF = NO |
2625 | |
2626 | -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
2627 | -# in the INCLUDE_PATH (see below) will be search if a #include is found. |
2628 | +# If the SEARCH_INCLUDES tag is set to YES the includes files in the |
2629 | +# INCLUDE_PATH will be searched if a #include is found. |
2630 | +# The default value is: YES. |
2631 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2632 | |
2633 | SEARCH_INCLUDES = YES |
2634 | |
2635 | -# The INCLUDE_PATH tag can be used to specify one or more directories that |
2636 | -# contain include files that are not input files but should be processed by |
2637 | -# the preprocessor. |
2638 | +# The INCLUDE_PATH tag can be used to specify one or more directories that |
2639 | +# contain include files that are not input files but should be processed by the |
2640 | +# preprocessor. |
2641 | +# This tag requires that the tag SEARCH_INCLUDES is set to YES. |
2642 | |
2643 | INCLUDE_PATH = ../include/ |
2644 | |
2645 | -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
2646 | -# patterns (like *.h and *.hpp) to filter out the header-files in the |
2647 | -# directories. If left blank, the patterns specified with FILE_PATTERNS will |
2648 | -# be used. |
2649 | +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
2650 | +# patterns (like *.h and *.hpp) to filter out the header-files in the |
2651 | +# directories. If left blank, the patterns specified with FILE_PATTERNS will be |
2652 | +# used. |
2653 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2654 | |
2655 | INCLUDE_FILE_PATTERNS = *.h |
2656 | |
2657 | -# The PREDEFINED tag can be used to specify one or more macro names that |
2658 | -# are defined before the preprocessor is started (similar to the -D option of |
2659 | -# gcc). The argument of the tag is a list of macros of the form: name |
2660 | -# or name=definition (no spaces). If the definition and the = are |
2661 | -# omitted =1 is assumed. |
2662 | - |
2663 | -PREDEFINED = |
2664 | - |
2665 | -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
2666 | -# this tag can be used to specify a list of macro names that should be expanded. |
2667 | -# The macro definition that is found in the sources will be used. |
2668 | -# Use the PREDEFINED tag if you want to use a different macro definition. |
2669 | - |
2670 | -EXPAND_AS_DEFINED = |
2671 | - |
2672 | -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
2673 | -# doxygen's preprocessor will remove all function-like macros that are alone |
2674 | -# on a line, have an all uppercase name, and do not end with a semicolon. Such |
2675 | -# function macros are typically used for boiler-plate code, and will confuse the |
2676 | -# parser if not removed. |
2677 | +# The PREDEFINED tag can be used to specify one or more macro names that are |
2678 | +# defined before the preprocessor is started (similar to the -D option of e.g. |
2679 | +# gcc). The argument of the tag is a list of macros of the form: name or |
2680 | +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" |
2681 | +# is assumed. To prevent a macro definition from being undefined via #undef or |
2682 | +# recursively expanded use the := operator instead of the = operator. |
2683 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2684 | + |
2685 | +PREDEFINED = |
2686 | + |
2687 | +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
2688 | +# tag can be used to specify a list of macro names that should be expanded. The |
2689 | +# macro definition that is found in the sources will be used. Use the PREDEFINED |
2690 | +# tag if you want to use a different macro definition that overrules the |
2691 | +# definition found in the source code. |
2692 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2693 | + |
2694 | +EXPAND_AS_DEFINED = |
2695 | + |
2696 | +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
2697 | +# remove all refrences to function-like macros that are alone on a line, have an |
2698 | +# all uppercase name, and do not end with a semicolon. Such function macros are |
2699 | +# typically used for boiler-plate code, and will confuse the parser if not |
2700 | +# removed. |
2701 | +# The default value is: YES. |
2702 | +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2703 | |
2704 | SKIP_FUNCTION_MACROS = YES |
2705 | |
2706 | #--------------------------------------------------------------------------- |
2707 | -# Configuration::addtions related to external references |
2708 | +# Configuration options related to external references |
2709 | #--------------------------------------------------------------------------- |
2710 | |
2711 | -# The TAGFILES option can be used to specify one or more tagfiles. |
2712 | -# Optionally an initial location of the external documentation |
2713 | -# can be added for each tagfile. The format of a tag file without |
2714 | -# this location is as follows: |
2715 | -# TAGFILES = file1 file2 ... |
2716 | -# Adding location for the tag files is done as follows: |
2717 | -# TAGFILES = file1=loc1 "file2 = loc2" ... |
2718 | -# where "loc1" and "loc2" can be relative or absolute paths or |
2719 | -# URLs. If a location is present for each tag, the installdox tool |
2720 | -# does not have to be run to correct the links. |
2721 | -# Note that each tag file must have a unique name |
2722 | -# (where the name does NOT include the path) |
2723 | -# If a tag file is not located in the directory in which doxygen |
2724 | -# is run, you must also specify the path to the tagfile here. |
2725 | - |
2726 | -TAGFILES = |
2727 | - |
2728 | -# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
2729 | -# a tag file that is based on the input files it reads. |
2730 | - |
2731 | -GENERATE_TAGFILE = |
2732 | - |
2733 | -# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
2734 | -# in the class index. If set to NO only the inherited external classes |
2735 | -# will be listed. |
2736 | +# The TAGFILES tag can be used to specify one or more tag files. For each tag |
2737 | +# file the location of the external documentation should be added. The format of |
2738 | +# a tag file without this location is as follows: |
2739 | +# TAGFILES = file1 file2 ... |
2740 | +# Adding location for the tag files is done as follows: |
2741 | +# TAGFILES = file1=loc1 "file2 = loc2" ... |
2742 | +# where loc1 and loc2 can be relative or absolute paths or URLs. See the |
2743 | +# section "Linking to external documentation" for more information about the use |
2744 | +# of tag files. |
2745 | +# Note: Each tag file must have an unique name (where the name does NOT include |
2746 | +# the path). If a tag file is not located in the directory in which doxygen is |
2747 | +# run, you must also specify the path to the tagfile here. |
2748 | + |
2749 | +TAGFILES = |
2750 | + |
2751 | +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
2752 | +# tag file that is based on the input files it reads. See section "Linking to |
2753 | +# external documentation" for more information about the usage of tag files. |
2754 | + |
2755 | +GENERATE_TAGFILE = |
2756 | + |
2757 | +# If the ALLEXTERNALS tag is set to YES all external class will be listed in the |
2758 | +# class index. If set to NO only the inherited external classes will be listed. |
2759 | +# The default value is: NO. |
2760 | |
2761 | ALLEXTERNALS = NO |
2762 | |
2763 | -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
2764 | -# in the modules index. If set to NO, only the current project's groups will |
2765 | +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in |
2766 | +# the modules index. If set to NO, only the current project's groups will be |
2767 | +# listed. |
2768 | +# The default value is: YES. |
2769 | + |
2770 | +EXTERNAL_GROUPS = YES |
2771 | + |
2772 | +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in |
2773 | +# the related pages index. If set to NO, only the current project's pages will |
2774 | # be listed. |
2775 | - |
2776 | -EXTERNAL_GROUPS = YES |
2777 | - |
2778 | -# The PERL_PATH should be the absolute path and name of the perl script |
2779 | -# interpreter (i.e. the result of `which perl'). |
2780 | +# The default value is: YES. |
2781 | + |
2782 | +EXTERNAL_PAGES = YES |
2783 | + |
2784 | +# The PERL_PATH should be the absolute path and name of the perl script |
2785 | +# interpreter (i.e. the result of 'which perl'). |
2786 | +# The default file (with absolute path) is: /usr/bin/perl. |
2787 | |
2788 | PERL_PATH = /usr/bin/perl |
2789 | |
2790 | #--------------------------------------------------------------------------- |
2791 | -# Configuration options related to the dot tool |
2792 | +# Configuration options related to the dot tool |
2793 | #--------------------------------------------------------------------------- |
2794 | |
2795 | -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
2796 | -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or |
2797 | -# super classes. Setting the tag to NO turns the diagrams off. Note that this |
2798 | -# option is superceded by the HAVE_DOT option below. This is only a fallback. It is |
2799 | -# recommended to install and use dot, since it yields more powerful graphs. |
2800 | +# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram |
2801 | +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
2802 | +# NO turns the diagrams off. Note that this option also works with HAVE_DOT |
2803 | +# disabled, but it is recommended to install and use dot, since it yields more |
2804 | +# powerful graphs. |
2805 | +# The default value is: YES. |
2806 | |
2807 | CLASS_DIAGRAMS = YES |
2808 | |
2809 | -# If set to YES, the inheritance and collaboration graphs will hide |
2810 | -# inheritance and usage relations if the target is undocumented |
2811 | -# or is not a class. |
2812 | +# You can define message sequence charts within doxygen comments using the \msc |
2813 | +# command. Doxygen will then run the mscgen tool (see: |
2814 | +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
2815 | +# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
2816 | +# the mscgen tool resides. If left empty the tool is assumed to be found in the |
2817 | +# default search path. |
2818 | + |
2819 | +MSCGEN_PATH = |
2820 | + |
2821 | +# You can include diagrams made with dia in doxygen documentation. Doxygen will |
2822 | +# then run dia to produce the diagram and insert it in the documentation. The |
2823 | +# DIA_PATH tag allows you to specify the directory where the dia binary resides. |
2824 | +# If left empty dia is assumed to be found in the default search path. |
2825 | + |
2826 | +DIA_PATH = |
2827 | + |
2828 | +# If set to YES, the inheritance and collaboration graphs will hide inheritance |
2829 | +# and usage relations if the target is undocumented or is not a class. |
2830 | +# The default value is: YES. |
2831 | |
2832 | HIDE_UNDOC_RELATIONS = YES |
2833 | |
2834 | -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
2835 | -# available from the path. This tool is part of Graphviz, a graph visualization |
2836 | -# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
2837 | -# have no effect if this option is set to NO (the default) |
2838 | +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
2839 | +# available from the path. This tool is part of Graphviz (see: |
2840 | +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
2841 | +# Bell Labs. The other options in this section have no effect if this option is |
2842 | +# set to NO |
2843 | +# The default value is: NO. |
2844 | |
2845 | HAVE_DOT = NO |
2846 | |
2847 | -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
2848 | -# will generate a graph for each documented class showing the direct and |
2849 | -# indirect inheritance relations. Setting this tag to YES will force the |
2850 | -# the CLASS_DIAGRAMS tag to NO. |
2851 | +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed |
2852 | +# to run in parallel. When set to 0 doxygen will base this on the number of |
2853 | +# processors available in the system. You can set it explicitly to a value |
2854 | +# larger than 0 to get control over the balance between CPU load and processing |
2855 | +# speed. |
2856 | +# Minimum value: 0, maximum value: 32, default value: 0. |
2857 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2858 | + |
2859 | +DOT_NUM_THREADS = 0 |
2860 | + |
2861 | +# When you want a differently looking font n the dot files that doxygen |
2862 | +# generates you can specify the font name using DOT_FONTNAME. You need to make |
2863 | +# sure dot is able to find the font, which can be done by putting it in a |
2864 | +# standard location or by setting the DOTFONTPATH environment variable or by |
2865 | +# setting DOT_FONTPATH to the directory containing the font. |
2866 | +# The default value is: Helvetica. |
2867 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2868 | + |
2869 | +DOT_FONTNAME = Helvetica |
2870 | + |
2871 | +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of |
2872 | +# dot graphs. |
2873 | +# Minimum value: 4, maximum value: 24, default value: 10. |
2874 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2875 | + |
2876 | +DOT_FONTSIZE = 10 |
2877 | + |
2878 | +# By default doxygen will tell dot to use the default font as specified with |
2879 | +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set |
2880 | +# the path where dot can find it using this tag. |
2881 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2882 | + |
2883 | +DOT_FONTPATH = |
2884 | + |
2885 | +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
2886 | +# each documented class showing the direct and indirect inheritance relations. |
2887 | +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. |
2888 | +# The default value is: YES. |
2889 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2890 | |
2891 | CLASS_GRAPH = YES |
2892 | |
2893 | -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
2894 | -# will generate a graph for each documented class showing the direct and |
2895 | -# indirect implementation dependencies (inheritance, containment, and |
2896 | -# class references variables) of the class with other documented classes. |
2897 | +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
2898 | +# graph for each documented class showing the direct and indirect implementation |
2899 | +# dependencies (inheritance, containment, and class references variables) of the |
2900 | +# class with other documented classes. |
2901 | +# The default value is: YES. |
2902 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2903 | |
2904 | COLLABORATION_GRAPH = YES |
2905 | |
2906 | -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
2907 | -# collaboration diagrams in a style similiar to the OMG's Unified Modeling |
2908 | +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
2909 | +# groups, showing the direct groups dependencies. |
2910 | +# The default value is: YES. |
2911 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2912 | + |
2913 | +GROUP_GRAPHS = YES |
2914 | + |
2915 | +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
2916 | +# collaboration diagrams in a style similar to the OMG's Unified Modeling |
2917 | # Language. |
2918 | +# The default value is: NO. |
2919 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2920 | |
2921 | UML_LOOK = NO |
2922 | |
2923 | -# If set to YES, the inheritance and collaboration graphs will show the |
2924 | -# relations between templates and their instances. |
2925 | +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the |
2926 | +# class node. If there are many fields or methods and many nodes the graph may |
2927 | +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the |
2928 | +# number of items for each type to make the size more manageable. Set this to 0 |
2929 | +# for no limit. Note that the threshold may be exceeded by 50% before the limit |
2930 | +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, |
2931 | +# but if the number exceeds 15, the total amount of fields shown is limited to |
2932 | +# 10. |
2933 | +# Minimum value: 0, maximum value: 100, default value: 10. |
2934 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2935 | + |
2936 | +UML_LIMIT_NUM_FIELDS = 10 |
2937 | + |
2938 | +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
2939 | +# collaboration graphs will show the relations between templates and their |
2940 | +# instances. |
2941 | +# The default value is: NO. |
2942 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2943 | |
2944 | TEMPLATE_RELATIONS = NO |
2945 | |
2946 | -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
2947 | -# tags are set to YES then doxygen will generate a graph for each documented |
2948 | -# file showing the direct and indirect include dependencies of the file with |
2949 | -# other documented files. |
2950 | +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
2951 | +# YES then doxygen will generate a graph for each documented file showing the |
2952 | +# direct and indirect include dependencies of the file with other documented |
2953 | +# files. |
2954 | +# The default value is: YES. |
2955 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2956 | |
2957 | INCLUDE_GRAPH = YES |
2958 | |
2959 | -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
2960 | -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
2961 | -# documented header file showing the documented files that directly or |
2962 | -# indirectly include this file. |
2963 | +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
2964 | +# set to YES then doxygen will generate a graph for each documented file showing |
2965 | +# the direct and indirect include dependencies of the file with other documented |
2966 | +# files. |
2967 | +# The default value is: YES. |
2968 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2969 | |
2970 | INCLUDED_BY_GRAPH = YES |
2971 | |
2972 | -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
2973 | -# generate a call dependency graph for every global function or class method. |
2974 | -# Note that enabling this option will significantly increase the time of a run. |
2975 | -# So in most cases it will be better to enable call graphs for selected |
2976 | +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call |
2977 | +# dependency graph for every global function or class method. |
2978 | +# |
2979 | +# Note that enabling this option will significantly increase the time of a run. |
2980 | +# So in most cases it will be better to enable call graphs for selected |
2981 | # functions only using the \callgraph command. |
2982 | +# The default value is: NO. |
2983 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2984 | |
2985 | CALL_GRAPH = NO |
2986 | |
2987 | -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
2988 | -# will graphical hierarchy of all classes instead of a textual one. |
2989 | +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller |
2990 | +# dependency graph for every global function or class method. |
2991 | +# |
2992 | +# Note that enabling this option will significantly increase the time of a run. |
2993 | +# So in most cases it will be better to enable caller graphs for selected |
2994 | +# functions only using the \callergraph command. |
2995 | +# The default value is: NO. |
2996 | +# This tag requires that the tag HAVE_DOT is set to YES. |
2997 | + |
2998 | +CALLER_GRAPH = NO |
2999 | + |
3000 | +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical |
3001 | +# hierarchy of all classes instead of a textual one. |
3002 | +# The default value is: YES. |
3003 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3004 | |
3005 | GRAPHICAL_HIERARCHY = YES |
3006 | |
3007 | -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
3008 | -# generated by dot. Possible values are png, jpg, or gif |
3009 | -# If left blank png will be used. |
3010 | +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
3011 | +# dependencies a directory has on other directories in a graphical way. The |
3012 | +# dependency relations are determined by the #include relations between the |
3013 | +# files in the directories. |
3014 | +# The default value is: YES. |
3015 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3016 | + |
3017 | +DIRECTORY_GRAPH = YES |
3018 | + |
3019 | +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
3020 | +# generated by dot. |
3021 | +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
3022 | +# to make the SVG files visible in IE 9+ (other browsers do not have this |
3023 | +# requirement). |
3024 | +# Possible values are: png, jpg, gif and svg. |
3025 | +# The default value is: png. |
3026 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3027 | |
3028 | DOT_IMAGE_FORMAT = png |
3029 | |
3030 | -# The tag DOT_PATH can be used to specify the path where the dot tool can be |
3031 | -# found. If left blank, it is assumed the dot tool can be found on the path. |
3032 | - |
3033 | -DOT_PATH = |
3034 | - |
3035 | -# The DOTFILE_DIRS tag can be used to specify one or more directories that |
3036 | -# contain dot files that are included in the documentation (see the |
3037 | -# \dotfile command). |
3038 | - |
3039 | -DOTFILE_DIRS = |
3040 | - |
3041 | -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
3042 | -# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
3043 | -# this value, doxygen will try to truncate the graph, so that it fits within |
3044 | -# the specified constraint. Beware that most browsers cannot cope with very |
3045 | -# large images. |
3046 | - |
3047 | -MAX_DOT_GRAPH_WIDTH = 1024 |
3048 | - |
3049 | -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
3050 | -# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
3051 | -# this value, doxygen will try to truncate the graph, so that it fits within |
3052 | -# the specified constraint. Beware that most browsers cannot cope with very |
3053 | -# large images. |
3054 | - |
3055 | -MAX_DOT_GRAPH_HEIGHT = 1024 |
3056 | - |
3057 | -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
3058 | -# graphs generated by dot. A depth value of 3 means that only nodes reachable |
3059 | -# from the root by following a path via at most 3 edges will be shown. Nodes that |
3060 | -# lay further from the root node will be omitted. Note that setting this option to |
3061 | -# 1 or 2 may greatly reduce the computation time needed for large code bases. Also |
3062 | -# note that a graph may be further truncated if the graph's image dimensions are |
3063 | -# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). |
3064 | -# If 0 is used for the depth value (the default), the graph is not depth-constrained. |
3065 | +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
3066 | +# enable generation of interactive SVG images that allow zooming and panning. |
3067 | +# |
3068 | +# Note that this requires a modern browser other than Internet Explorer. Tested |
3069 | +# and working are Firefox, Chrome, Safari, and Opera. |
3070 | +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make |
3071 | +# the SVG files visible. Older versions of IE do not have SVG support. |
3072 | +# The default value is: NO. |
3073 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3074 | + |
3075 | +INTERACTIVE_SVG = NO |
3076 | + |
3077 | +# The DOT_PATH tag can be used to specify the path where the dot tool can be |
3078 | +# found. If left blank, it is assumed the dot tool can be found in the path. |
3079 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3080 | + |
3081 | +DOT_PATH = |
3082 | + |
3083 | +# The DOTFILE_DIRS tag can be used to specify one or more directories that |
3084 | +# contain dot files that are included in the documentation (see the \dotfile |
3085 | +# command). |
3086 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3087 | + |
3088 | +DOTFILE_DIRS = |
3089 | + |
3090 | +# The MSCFILE_DIRS tag can be used to specify one or more directories that |
3091 | +# contain msc files that are included in the documentation (see the \mscfile |
3092 | +# command). |
3093 | + |
3094 | +MSCFILE_DIRS = |
3095 | + |
3096 | +# The DIAFILE_DIRS tag can be used to specify one or more directories that |
3097 | +# contain dia files that are included in the documentation (see the \diafile |
3098 | +# command). |
3099 | + |
3100 | +DIAFILE_DIRS = |
3101 | + |
3102 | +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
3103 | +# that will be shown in the graph. If the number of nodes in a graph becomes |
3104 | +# larger than this value, doxygen will truncate the graph, which is visualized |
3105 | +# by representing a node as a red box. Note that doxygen if the number of direct |
3106 | +# children of the root node in a graph is already larger than |
3107 | +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
3108 | +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
3109 | +# Minimum value: 0, maximum value: 10000, default value: 50. |
3110 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3111 | + |
3112 | +DOT_GRAPH_MAX_NODES = 50 |
3113 | + |
3114 | +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs |
3115 | +# generated by dot. A depth value of 3 means that only nodes reachable from the |
3116 | +# root by following a path via at most 3 edges will be shown. Nodes that lay |
3117 | +# further from the root node will be omitted. Note that setting this option to 1 |
3118 | +# or 2 may greatly reduce the computation time needed for large code bases. Also |
3119 | +# note that the size of a graph can be further restricted by |
3120 | +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
3121 | +# Minimum value: 0, maximum value: 1000, default value: 0. |
3122 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3123 | |
3124 | MAX_DOT_GRAPH_DEPTH = 0 |
3125 | |
3126 | -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
3127 | -# generate a legend page explaining the meaning of the various boxes and |
3128 | -# arrows in the dot generated graphs. |
3129 | +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
3130 | +# background. This is disabled by default, because dot on Windows does not seem |
3131 | +# to support this out of the box. |
3132 | +# |
3133 | +# Warning: Depending on the platform used, enabling this option may lead to |
3134 | +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
3135 | +# read). |
3136 | +# The default value is: NO. |
3137 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3138 | + |
3139 | +DOT_TRANSPARENT = NO |
3140 | + |
3141 | +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
3142 | +# files in one run (i.e. multiple -o and -T options on the command line). This |
3143 | +# makes dot run faster, but since only newer versions of dot (>1.8.10) support |
3144 | +# this, this feature is disabled by default. |
3145 | +# The default value is: NO. |
3146 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3147 | + |
3148 | +DOT_MULTI_TARGETS = YES |
3149 | + |
3150 | +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
3151 | +# explaining the meaning of the various boxes and arrows in the dot generated |
3152 | +# graphs. |
3153 | +# The default value is: YES. |
3154 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3155 | |
3156 | GENERATE_LEGEND = YES |
3157 | |
3158 | -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
3159 | -# remove the intermediate dot files that are used to generate |
3160 | -# the various graphs. |
3161 | +# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot |
3162 | +# files that are used to generate the various graphs. |
3163 | +# The default value is: YES. |
3164 | +# This tag requires that the tag HAVE_DOT is set to YES. |
3165 | |
3166 | DOT_CLEANUP = YES |
3167 | - |
3168 | -#--------------------------------------------------------------------------- |
3169 | -# Configuration::addtions related to the search engine |
3170 | -#--------------------------------------------------------------------------- |
3171 | - |
3172 | -# The SEARCHENGINE tag specifies whether or not a search engine should be |
3173 | -# used. If set to NO the values of all tags below this one will be ignored. |
3174 | - |
3175 | -SEARCHENGINE = NO |
3176 | |
3177 | === added file 'include/debian-installer/system/efi.h' |
3178 | --- include/debian-installer/system/efi.h 1970-01-01 00:00:00 +0000 |
3179 | +++ include/debian-installer/system/efi.h 2015-01-28 21:45:05 +0000 |
3180 | @@ -0,0 +1,34 @@ |
3181 | +/* |
3182 | + * efi.h |
3183 | + * |
3184 | + * Copyright (C) 2014 Ian Campbell <ijc@hellion.org.uk> |
3185 | + * |
3186 | + * This program is free software; you can redistribute it and/or modify |
3187 | + * it under the terms of the GNU General Public License as published by |
3188 | + * the Free Software Foundation; either version 2 of the License, or |
3189 | + * (at your option) any later version. |
3190 | + * |
3191 | + * This program is distributed in the hope that it will be useful, |
3192 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
3193 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3194 | + * GNU General Public License for more details. |
3195 | + * |
3196 | + * You should have received a copy of the GNU General Public License |
3197 | + * along with this program. If not, see <http://www.gnu.org/licenses/>. |
3198 | + */ |
3199 | + |
3200 | +#ifndef DEBIAN_INSTALLER__SYSTEM__EFI_H |
3201 | +#define DEBIAN_INSTALLER__SYSTEM__EFI_H |
3202 | + |
3203 | +/** |
3204 | + * @addtogroup di_system_utils |
3205 | + * @{ |
3206 | + */ |
3207 | + |
3208 | +/** |
3209 | + * Checks if ystem is EFI based. |
3210 | + */ |
3211 | +int di_system_is_efi(void); |
3212 | + |
3213 | +/** @} */ |
3214 | +#endif |
3215 | |
3216 | === modified file 'include/debian-installer/system/subarch.h' |
3217 | --- include/debian-installer/system/subarch.h 2011-03-02 17:11:54 +0000 |
3218 | +++ include/debian-installer/system/subarch.h 2015-01-28 21:45:05 +0000 |
3219 | @@ -21,7 +21,7 @@ |
3220 | #ifndef DEBIAN_INSTALLER__SYSTEM__SUBARCH_H |
3221 | #define DEBIAN_INSTALLER__SYSTEM__SUBARCH_H |
3222 | |
3223 | -#ifdef __ARMEL__ |
3224 | +#if defined(__ARMEL__) |
3225 | #define DI_SYSTEM_SUBARCH_CAN_GUESS 1 |
3226 | #endif |
3227 | |
3228 | |
3229 | === modified file 'src/system/Makefile.am' |
3230 | --- src/system/Makefile.am 2014-01-27 13:53:58 +0000 |
3231 | +++ src/system/Makefile.am 2015-01-28 21:45:05 +0000 |
3232 | @@ -6,6 +6,7 @@ |
3233 | libsystem_la_SOURCES = \ |
3234 | devfs.c \ |
3235 | dpkg.c \ |
3236 | + efi.c \ |
3237 | packages.c \ |
3238 | prebaseconfig.c \ |
3239 | utils.c |
3240 | @@ -13,6 +14,7 @@ |
3241 | EXTRA_libsystem_la_SOURCES = \ |
3242 | subarch-generic.c \ |
3243 | subarch-arm-linux.c \ |
3244 | + subarch-arm64-linux.c \ |
3245 | subarch-armeb-linux.c \ |
3246 | subarch-armel-linux.c \ |
3247 | subarch-armhf-linux.c \ |
3248 | @@ -20,6 +22,7 @@ |
3249 | subarch-mips-linux.c \ |
3250 | subarch-mipsel-linux.c \ |
3251 | subarch-powerpc-linux.c \ |
3252 | + subarch-ppc64-linux.c \ |
3253 | subarch-ppc64el-linux.c \ |
3254 | subarch-sh4-linux.c \ |
3255 | subarch-sparc-linux.c \ |
3256 | |
3257 | === added file 'src/system/efi.c' |
3258 | --- src/system/efi.c 1970-01-01 00:00:00 +0000 |
3259 | +++ src/system/efi.c 2015-01-28 21:45:05 +0000 |
3260 | @@ -0,0 +1,42 @@ |
3261 | +/* |
3262 | + * efi.c |
3263 | + * |
3264 | + * Copyright (C) 2012 Steve McIntyre <steve@einval.com> |
3265 | + * |
3266 | + * This program is free software; you can redistribute it and/or modify |
3267 | + * it under the terms of the GNU General Public License as published by |
3268 | + * the Free Software Foundation; either version 2 of the License, or |
3269 | + * (at your option) any later version. |
3270 | + * |
3271 | + * This program is distributed in the hope that it will be useful, |
3272 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
3273 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3274 | + * GNU General Public License for more details. |
3275 | + * |
3276 | + * You should have received a copy of the GNU General Public License |
3277 | + * along with this program; if not, write to the Free Software |
3278 | + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. |
3279 | + */ |
3280 | + |
3281 | +#include <unistd.h> |
3282 | + |
3283 | +#include <debian-installer/system/efi.h> |
3284 | + |
3285 | +/* Are we on an EFI system? Check to see if /sys/firmware/efi |
3286 | + * exists */ |
3287 | +int di_system_is_efi(void) |
3288 | +{ |
3289 | + int ret = access("/sys/firmware/efi", R_OK); |
3290 | + if (ret == 0) |
3291 | + { |
3292 | + /* Have we been told to ignore EFI in partman-efi? */ |
3293 | + ret = access("/var/lib/partman/ignore_uefi", R_OK); |
3294 | + if (ret == 0) |
3295 | + return 0; |
3296 | + else |
3297 | + return 1; |
3298 | + } |
3299 | + else |
3300 | + return 0; |
3301 | +} |
3302 | + |
3303 | |
3304 | === modified file 'src/system/subarch-arm-linux.c' |
3305 | --- src/system/subarch-arm-linux.c 2014-03-20 13:49:35 +0000 |
3306 | +++ src/system/subarch-arm-linux.c 2015-01-28 21:45:05 +0000 |
3307 | @@ -12,12 +12,9 @@ |
3308 | char *ret; |
3309 | }; |
3310 | |
3311 | +/* Do not add new armhf platforms here */ |
3312 | static const char *supported_generic_subarches[] = { |
3313 | - "armadaxp", |
3314 | "dove", |
3315 | - "exynos5", |
3316 | - "generic", |
3317 | - "keystone", |
3318 | "omap", |
3319 | "omap4", |
3320 | "mx51", |
3321 | @@ -27,6 +24,7 @@ |
3322 | }; |
3323 | |
3324 | static struct map map_hardware[] = { |
3325 | + /* armel */ |
3326 | { "Acorn-RiscPC" , "rpc" }, |
3327 | { "EBSA285" , "netwinder" }, |
3328 | { "Rebel-NetWinder" , "netwinder" }, |
3329 | @@ -34,8 +32,6 @@ |
3330 | { "co-EBSA285" , "netwinder" }, |
3331 | { "Compaq-PersonalServer" , "netwinder" }, |
3332 | { "Freescale MX51 Babbage Board", "imx51" }, /* iMX51 reference hardware. */ |
3333 | - { "Marvell Armada XP Development Board", "armadaxp" }, /* Marvell ArmadaXP development board SoC */ |
3334 | - { "Marvell DB-MV88F6781-BP Development Board", "dove" }, /* Marvell Dove SoC */ |
3335 | { "ADS" , "ads" }, /* Matches only ADS boards. Put any exceptions before. */ |
3336 | { "Applied Data Systems" , "ads" }, /* More ADS boards. */ |
3337 | { "HP t5325 Thin Client", "kirkwood" }, |
3338 | @@ -64,6 +60,8 @@ |
3339 | { "QNAP TS-409", "orion5x" }, |
3340 | { "HP Media Vault mv2120", "orion5x" }, |
3341 | { "Buffalo Linkstation LiveV3 (LS-CHL)", "orion5x" }, |
3342 | + { "Buffalo Linkstation LS-CHLv2", "kirkwood" }, /* aka: LS-CH1.0L */ |
3343 | + { "Buffalo Linkstation LS-XHL", "kirkwood" }, |
3344 | { "Buffalo Linkstation Mini", "orion5x" }, |
3345 | { "Buffalo Linkstation Pro/Live", "orion5x" }, |
3346 | { "Marvell Orion-NAS Reference Design", "orion5x" }, |
3347 | @@ -89,6 +87,16 @@ |
3348 | { "Linksys NSLU2", "ixp4xx" }, |
3349 | { "ARM-Versatile AB", "versatile" }, |
3350 | { "ARM-Versatile PB", "versatile" }, |
3351 | + |
3352 | + /* armhf |
3353 | + * |
3354 | + * These flavours were removed in Jessie (replaced by the generic armmp |
3355 | + * flavour). These are kept solely to allow the Jessie installer to be able |
3356 | + * to install Wheezy. |
3357 | + * |
3358 | + * Do not add new flavours here -- new platforms should use the armmp |
3359 | + * kernel, which is the default if nothing is found here. |
3360 | + */ |
3361 | { "Genesi Efika MX (Smartbook)", "mx5" }, |
3362 | { "Genesi Efika MX (Smarttop)", "mx5" }, |
3363 | { "Nokia RX-51 Board", "omap" }, |
3364 | @@ -96,14 +104,7 @@ |
3365 | { "OMAP4 Panda Board", "omap4" }, |
3366 | { "OMAP4430 Panda Board", "omap4" }, /* first OMAP4 hw platform, more to come */ |
3367 | { "OMAP4430 4430SDP board", "omap4" }, /* OMAP4 blaze platform */ |
3368 | - { "Calxeda Highbank", "generic" }, |
3369 | - { "Calxeda ECX-2000", "generic" }, |
3370 | - { "Wandboard i.MX6 Quad Board", "generic" }, |
3371 | { "ARM-Versatile Express", "vexpress" }, |
3372 | - { "SAMSUNG EXYNOS5 (Flattened Device Tree)", "exynos5" }, |
3373 | - { "SAMSUNG SSDK5440 board based on EXYNOS5440", "exynos5" }, |
3374 | - { "SAMSUNG SD5v1 board based on EXYNOS5440", "exynos5" }, |
3375 | - { "KeyStone2", "keystone" }, |
3376 | { NULL, NULL } |
3377 | }; |
3378 | |
3379 | @@ -163,7 +164,7 @@ |
3380 | if (ret) |
3381 | ret = read_cpuinfo(entry, sizeof(entry)); |
3382 | if (ret) |
3383 | - return "unknown"; |
3384 | + return "generic"; |
3385 | |
3386 | for (i = 0; map_hardware[i].entry; i++) |
3387 | { |
3388 | @@ -174,7 +175,7 @@ |
3389 | } |
3390 | } |
3391 | |
3392 | - return "unknown"; |
3393 | + return "generic"; |
3394 | } |
3395 | |
3396 | const char *di_system_subarch_analyze_guess(void) |
3397 | |
3398 | === added file 'src/system/subarch-arm64-linux.c' |
3399 | --- src/system/subarch-arm64-linux.c 1970-01-01 00:00:00 +0000 |
3400 | +++ src/system/subarch-arm64-linux.c 2015-01-28 21:45:05 +0000 |
3401 | @@ -0,0 +1,29 @@ |
3402 | +/* |
3403 | + * subarch-arm64-linux.c |
3404 | + * |
3405 | + * Copyright (C) 2013 Ian Campbell <ijc@hellion.org.uk> |
3406 | + * |
3407 | + * This program is free software; you can redistribute it and/or modify |
3408 | + * it under the terms of the GNU General Public License as published by |
3409 | + * the Free Software Foundation; either version 2 of the License, or |
3410 | + * (at your option) any later version. |
3411 | + * |
3412 | + * This program is distributed in the hope that it will be useful, |
3413 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
3414 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3415 | + * GNU General Public License for more details. |
3416 | + * |
3417 | + * You should have received a copy of the GNU General Public License |
3418 | + * along with this program. If not, see <http://www.gnu.org/licenses/>. |
3419 | + */ |
3420 | + |
3421 | +#include <debian-installer/system/subarch.h> |
3422 | +#include <debian-installer/system/efi.h> |
3423 | + |
3424 | +const char *di_system_subarch_analyze(void) |
3425 | +{ |
3426 | + if (di_system_is_efi()) |
3427 | + return "efi"; |
3428 | + else |
3429 | + return "generic"; |
3430 | +} |
3431 | |
3432 | === modified file 'src/system/subarch-mips-linux.c' |
3433 | --- src/system/subarch-mips-linux.c 2008-03-06 23:18:08 +0000 |
3434 | +++ src/system/subarch-mips-linux.c 2015-01-28 21:45:05 +0000 |
3435 | @@ -1,148 +1,99 @@ |
3436 | +#include <sys/types.h> |
3437 | +#include <regex.h> |
3438 | #include <stdlib.h> |
3439 | #include <stdio.h> |
3440 | #include <string.h> |
3441 | |
3442 | #include <debian-installer/system/subarch.h> |
3443 | |
3444 | -struct cpu { |
3445 | - char *cpu; |
3446 | - char *ret; |
3447 | -}; |
3448 | - |
3449 | -struct systype { |
3450 | - char *sys; |
3451 | - struct cpu *cpu; |
3452 | -}; |
3453 | - |
3454 | -static struct cpu system_sgi_ind_cpu[] = { |
3455 | - { "R4", "r4k-ip22" }, /* match various R4000 variants */ |
3456 | - { "R5000", "r5k-ip22" }, |
3457 | - { "R8000", "r8k-ip26" }, |
3458 | - { "R10000", "r10k-ip28" }, |
3459 | - { NULL, "unknown" } |
3460 | -}; |
3461 | - |
3462 | -static struct cpu system_sgi_origin_cpu[] = { |
3463 | - { "R10000", "r10k-ip27" }, |
3464 | - { "R12000", "r12k-ip27" }, |
3465 | - { NULL, "unknown" } |
3466 | -}; |
3467 | - |
3468 | -static struct cpu system_sgi_o2_cpu[] = { |
3469 | - { "R5", "r5k-ip32" }, /* match R5000 and R5500 */ |
3470 | - { "Nevada", "r5k-ip32" }, |
3471 | - { "RM7000", "r5k-ip32" }, |
3472 | - { "R10000", "r10k-ip32" }, |
3473 | - { "R12000", "r12k-ip32" }, |
3474 | - { NULL, "unknown" } |
3475 | -}; |
3476 | - |
3477 | -static struct cpu system_sibyte_sb1_cpu[] = { |
3478 | - { "SiByte SB1A", "sb1a-bcm91480b" }, |
3479 | - { "SiByte SB1 ", "sb1-bcm91250a" }, |
3480 | - { NULL, "unknown" } |
3481 | -}; |
3482 | - |
3483 | -static struct cpu system_qemu_cpu[] = { |
3484 | - { "MIPS 4Kc", "qemu-mips32" }, |
3485 | - { "MIPS 24Kc", "qemu-mips32" }, |
3486 | - { NULL, "unknown" } |
3487 | -}; |
3488 | - |
3489 | -static struct cpu system_malta_cpu[] = { |
3490 | - { "MIPS 4K", "4kc-malta" }, |
3491 | - { "MIPS 24K", "4kc-malta" }, |
3492 | - { "MIPS 34K", "4kc-malta" }, |
3493 | - { "MIPS 5K", "5kc-malta" }, |
3494 | - { "MIPS 20K", "5kc-malta" }, |
3495 | - { NULL, "unknown" } |
3496 | -}; |
3497 | - |
3498 | -/* add new system types here */ |
3499 | - |
3500 | -static struct cpu system_unknown_cpu[] = { |
3501 | - { NULL, "unknown" } |
3502 | -}; |
3503 | - |
3504 | -static struct systype system_type[] = { |
3505 | - {"SGI Ind", system_sgi_ind_cpu }, /* match "SGI Indy" and "SGI Indigo2" */ |
3506 | - {"SGI Origin", system_sgi_origin_cpu }, |
3507 | - {"SGI IP32", system_sgi_o2_cpu }, |
3508 | - {"SGI O2", system_sgi_o2_cpu }, |
3509 | - {"SiByte BCM9", system_sibyte_sb1_cpu }, /* match Broadcom SB1 boards */ |
3510 | - {"Qemu", system_qemu_cpu }, |
3511 | - {"MIPS Malta", system_malta_cpu }, |
3512 | - { NULL, system_unknown_cpu } |
3513 | -}; |
3514 | - |
3515 | -#define INVALID_SYS_IDX (sizeof(system_type) / sizeof(struct systype) - 1) |
3516 | -#define INVALID_CPU_IDX (-1) |
3517 | +struct hwmap_type { |
3518 | + const char *sys_regex; |
3519 | + const char *cpu_regex; |
3520 | + const char *ret; |
3521 | +}; |
3522 | + |
3523 | +static struct hwmap_type hwmap[] = { |
3524 | + {"MIPS Malta", "MIPS (4K|24K|34K|74K)", "4kc-malta" }, |
3525 | + {"MIPS Malta", "MIPS (5K|20K)", "5kc-malta" }, |
3526 | + {".*", "ICT Loongson-2 V0.2", "loongson-2e" }, |
3527 | + {".*", "ICT Loongson-2 V0.3", "loongson-2f" }, |
3528 | + {".*", "ICT Loongson-3", "loongson-3" }, |
3529 | + {".*", "Cavium Octeon", "octeon" }, |
3530 | + {"SGI (Indy|Indigo2)", "R4", "r4k-ip22" }, |
3531 | + {"SGI (Indy|Indigo2)", "R5000", "r5k-ip22" }, |
3532 | + {"SGI (Indy|Indigo2)", "R8000", "r8k-ip26" }, |
3533 | + {"SGI (Indy|Indigo2)", "R10000", "r10k-ip28" }, |
3534 | + {"SGI Origin", "R10000", "r10k-ip27" }, |
3535 | + {"SGI Origin", "R12000", "r12k-ip27" }, |
3536 | + {"SGI (O2|IP32)", "R5|Nevada|RM7000", "r5k-ip32" }, |
3537 | + {"SGI (O2|IP32)", "RM10000", "r10k-ip32" }, |
3538 | + {"SGI (O2|IP32)", "RM12000", "r12k-ip32" }, |
3539 | + {"SiByte BCM91250", "SiByte SB1", "sb1-bcm91250a" }, |
3540 | + {"SiByte BCM91.80", "SiByte SB1A", "sb1a-bcm91480b" }, |
3541 | + |
3542 | + /* add new hwmap here */ |
3543 | + |
3544 | + { ".*", ".*", "unknown" } |
3545 | +}; |
3546 | |
3547 | #define BUFFER_LENGTH (1024) |
3548 | |
3549 | -static int check_system(const char *entry) |
3550 | -{ |
3551 | - int ret; |
3552 | - |
3553 | - for (ret = 0; system_type[ret].sys; ret++) { |
3554 | - if (!strncmp(system_type[ret].sys, entry, |
3555 | - strlen(system_type[ret].sys))) |
3556 | - break; |
3557 | - } |
3558 | - |
3559 | - return ret; |
3560 | -} |
3561 | - |
3562 | -static int check_cpu(const char *entry, int sys_idx) |
3563 | -{ |
3564 | - int ret; |
3565 | - |
3566 | - if (sys_idx == INVALID_SYS_IDX) { |
3567 | - /* |
3568 | - * This means an unsupported system type, because the |
3569 | - * system type is always the first entry in /proc/cpuinfo. |
3570 | - */ |
3571 | - return INVALID_CPU_IDX; |
3572 | - } |
3573 | - |
3574 | - for (ret = 0; system_type[sys_idx].cpu[ret].cpu; ret++) { |
3575 | - if (!strncmp(system_type[sys_idx].cpu[ret].cpu, entry, |
3576 | - strlen(system_type[sys_idx].cpu[ret].cpu))) |
3577 | - break; |
3578 | - } |
3579 | - |
3580 | - return ret; |
3581 | -} |
3582 | - |
3583 | const char *di_system_subarch_analyze(void) |
3584 | { |
3585 | FILE *file; |
3586 | - int sys_idx = INVALID_SYS_IDX; |
3587 | - int cpu_idx = INVALID_CPU_IDX; |
3588 | char buf[BUFFER_LENGTH]; |
3589 | - char *pos; |
3590 | - size_t len; |
3591 | - |
3592 | - if (!(file = fopen("/proc/cpuinfo", "r"))) |
3593 | - return system_type[sys_idx].cpu[0].ret; |
3594 | - |
3595 | - while (fgets(buf, sizeof(buf), file)) { |
3596 | - if (!(pos = strchr(buf, ':'))) |
3597 | - continue; |
3598 | - if (!(len = strspn(pos, ": \t"))) |
3599 | - continue; |
3600 | - if (!strncmp(buf, "system type", strlen("system type"))) |
3601 | - sys_idx = check_system(pos + len); |
3602 | - else if (!strncmp(buf, "cpu model", strlen("cpu model"))) |
3603 | - cpu_idx = check_cpu(pos + len, sys_idx); |
3604 | - } |
3605 | - |
3606 | - fclose(file); |
3607 | - |
3608 | - if (cpu_idx == INVALID_CPU_IDX) { |
3609 | - sys_idx = INVALID_SYS_IDX; |
3610 | - cpu_idx = 0; |
3611 | - } |
3612 | - |
3613 | - return system_type[sys_idx].cpu[cpu_idx].ret; |
3614 | + const char *pos; |
3615 | + char *system = NULL, *cpu = NULL; |
3616 | + size_t len, i; |
3617 | + |
3618 | + file = fopen("/proc/cpuinfo", "r"); |
3619 | + |
3620 | + if (file) { |
3621 | + while (fgets(buf, sizeof(buf), file)) { |
3622 | + if (!(pos = strchr(buf, ':'))) |
3623 | + continue; |
3624 | + if (!(len = strspn(pos, ": \t"))) |
3625 | + continue; |
3626 | + if (!strncmp(buf, "system type", strlen("system type"))) |
3627 | + system = strdup(pos + len); |
3628 | + if (!strncmp(buf, "cpu model", strlen("cpu model"))) |
3629 | + cpu = strdup(pos + len); |
3630 | + } |
3631 | + |
3632 | + fclose(file); |
3633 | + } |
3634 | + |
3635 | + if (!system) |
3636 | + system = strdup(""); |
3637 | + if (!cpu) |
3638 | + cpu = strdup(""); |
3639 | + |
3640 | + for (i = 0; i < sizeof(hwmap) / sizeof(struct hwmap_type) ; i++) { |
3641 | + regex_t preg; |
3642 | + int ret; |
3643 | + |
3644 | + /* Check for matching system type */ |
3645 | + if (regcomp(&preg, hwmap[i].sys_regex, REG_NOSUB | REG_EXTENDED)) |
3646 | + continue; |
3647 | + ret = regexec(&preg, system, 0, NULL, 0); |
3648 | + regfree(&preg); |
3649 | + if (ret == REG_NOMATCH) |
3650 | + continue; |
3651 | + |
3652 | + /* Check for matching cpu type */ |
3653 | + if (regcomp(&preg, hwmap[i].cpu_regex, REG_NOSUB | REG_EXTENDED)) |
3654 | + continue; |
3655 | + ret = regexec(&preg, cpu, 0, NULL, 0); |
3656 | + regfree(&preg); |
3657 | + if (ret == REG_NOMATCH) |
3658 | + continue; |
3659 | + |
3660 | + /* Match both system and cpu type. Stop. */ |
3661 | + break; |
3662 | + } |
3663 | + |
3664 | + free(system); |
3665 | + free(cpu); |
3666 | + |
3667 | + return hwmap[i].ret; |
3668 | } |
3669 | |
3670 | === modified file 'src/system/subarch-mipsel-linux.c' |
3671 | --- src/system/subarch-mipsel-linux.c 2010-06-19 22:14:05 +0000 |
3672 | +++ src/system/subarch-mipsel-linux.c 1970-01-01 00:00:00 +0000 |
3673 | @@ -1,156 +0,0 @@ |
3674 | -#include <stdlib.h> |
3675 | -#include <stdio.h> |
3676 | -#include <string.h> |
3677 | - |
3678 | -#include <debian-installer/system/subarch.h> |
3679 | - |
3680 | -struct cpu { |
3681 | - char *cpu; |
3682 | - char *ret; |
3683 | -}; |
3684 | - |
3685 | -struct systype { |
3686 | - char *sys; |
3687 | - struct cpu *cpu; |
3688 | -}; |
3689 | - |
3690 | -static struct cpu system_dec_decs_cpu[] = { |
3691 | - { "R3", "r3k-kn02" }, |
3692 | - { "R4", "r4k-kn04" }, |
3693 | - { NULL, "unknown" } |
3694 | -}; |
3695 | - |
3696 | -static struct cpu system_sibyte_sb1_cpu[] = { |
3697 | - { "SiByte SB1A", "sb1a-bcm91480b" }, |
3698 | - { "SiByte SB1 ", "sb1-bcm91250a" }, |
3699 | - { NULL, "unknown" } |
3700 | -}; |
3701 | - |
3702 | -static struct cpu system_cobalt_cpu[] = { |
3703 | - { "Nevada", "cobalt" }, |
3704 | - { NULL, "unknown" } |
3705 | -}; |
3706 | - |
3707 | -static struct cpu system_bcm_bcm947xx_cpu[] = { |
3708 | - { "Broadcom BCM3302", "bcm947xx" }, |
3709 | - { "Broadcom BCM4710", "bcm947xx" }, |
3710 | - { NULL, "unknown" } |
3711 | -}; |
3712 | - |
3713 | -static struct cpu system_qemu_cpu[] = { |
3714 | - { "MIPS 4Kc", "qemu-mips32" }, |
3715 | - { "MIPS 24Kc", "qemu-mips32" }, |
3716 | - { NULL, "unknown" } |
3717 | -}; |
3718 | - |
3719 | -static struct cpu system_malta_cpu[] = { |
3720 | - { "MIPS 4K", "4kc-malta" }, |
3721 | - { "MIPS 24K", "4kc-malta" }, |
3722 | - { "MIPS 34K", "4kc-malta" }, |
3723 | - { "MIPS 5K", "5kc-malta" }, |
3724 | - { "MIPS 20K", "5kc-malta" }, |
3725 | - { NULL, "unknown" } |
3726 | -}; |
3727 | - |
3728 | -static struct cpu system_loongson2_cpu[] = { |
3729 | - { "ICT Loongson-2 V0.2", "loongson-2e" }, |
3730 | - { "ICT Loongson-2 V0.3", "loongson-2f" }, |
3731 | -}; |
3732 | - |
3733 | -/* add new system types here */ |
3734 | - |
3735 | -static struct cpu system_unknown_cpu[] = { |
3736 | - { NULL, "unknown" } |
3737 | -}; |
3738 | - |
3739 | -static struct systype system_type[] = { |
3740 | - /* |
3741 | - * match any of |
3742 | - * "Digital unknown DECstation" |
3743 | - * "Digital DECstation" |
3744 | - * "Digital DECsystem" |
3745 | - * "Digital Personal DECstation" |
3746 | - */ |
3747 | - {"Digital ", system_dec_decs_cpu }, |
3748 | - {"SiByte BCM9", system_sibyte_sb1_cpu }, /* match Broadcom SB1 boards */ |
3749 | - {"MIPS Cobalt", system_cobalt_cpu }, /* old kernels */ |
3750 | - {"Cobalt ", system_cobalt_cpu }, /* match any Cobalt machine; new kernels */ |
3751 | - {"Broadcom BCM947XX", system_bcm_bcm947xx_cpu }, /* Broadcom based APs/NAS */ |
3752 | - {"Qemu", system_qemu_cpu }, |
3753 | - {"MIPS Malta", system_malta_cpu }, |
3754 | - {"lemote-", system_loongson2_cpu }, |
3755 | - {"dexxon-gdium-2f", system_loongson2_cpu }, |
3756 | - { NULL, system_unknown_cpu } |
3757 | -}; |
3758 | - |
3759 | -#define INVALID_SYS_IDX (sizeof(system_type) / sizeof(struct systype) - 1) |
3760 | -#define INVALID_CPU_IDX (-1) |
3761 | - |
3762 | -#define BUFFER_LENGTH (1024) |
3763 | - |
3764 | -static int check_system(const char *entry) |
3765 | -{ |
3766 | - int ret; |
3767 | - |
3768 | - for (ret = 0; system_type[ret].sys; ret++) { |
3769 | - if (!strncmp(system_type[ret].sys, entry, |
3770 | - strlen(system_type[ret].sys))) |
3771 | - break; |
3772 | - } |
3773 | - |
3774 | - return ret; |
3775 | -} |
3776 | - |
3777 | -static int check_cpu(const char *entry, int sys_idx) |
3778 | -{ |
3779 | - int ret; |
3780 | - |
3781 | - if (sys_idx == INVALID_SYS_IDX) { |
3782 | - /* |
3783 | - * This means an unsupported system type, because the |
3784 | - * system type is always the first entry in /proc/cpuinfo. |
3785 | - */ |
3786 | - return INVALID_CPU_IDX; |
3787 | - } |
3788 | - |
3789 | - for (ret = 0; system_type[sys_idx].cpu[ret].cpu; ret++) { |
3790 | - if (!strncmp(system_type[sys_idx].cpu[ret].cpu, entry, |
3791 | - strlen(system_type[sys_idx].cpu[ret].cpu))) |
3792 | - break; |
3793 | - } |
3794 | - |
3795 | - return ret; |
3796 | -} |
3797 | - |
3798 | -const char *di_system_subarch_analyze(void) |
3799 | -{ |
3800 | - FILE *file; |
3801 | - int sys_idx = INVALID_SYS_IDX; |
3802 | - int cpu_idx = INVALID_CPU_IDX; |
3803 | - char buf[BUFFER_LENGTH]; |
3804 | - char *pos; |
3805 | - size_t len; |
3806 | - |
3807 | - if (!(file = fopen("/proc/cpuinfo", "r"))) |
3808 | - return system_type[sys_idx].cpu[0].ret; |
3809 | - |
3810 | - while (fgets(buf, sizeof(buf), file)) { |
3811 | - if (!(pos = strchr(buf, ':'))) |
3812 | - continue; |
3813 | - if (!(len = strspn(pos, ": \t"))) |
3814 | - continue; |
3815 | - if (!strncmp(buf, "system type", strlen("system type"))) |
3816 | - sys_idx = check_system(pos + len); |
3817 | - else if (!strncmp(buf, "cpu model", strlen("cpu model"))) |
3818 | - cpu_idx = check_cpu(pos + len, sys_idx); |
3819 | - } |
3820 | - |
3821 | - fclose(file); |
3822 | - |
3823 | - if (cpu_idx == INVALID_CPU_IDX) { |
3824 | - sys_idx = INVALID_SYS_IDX; |
3825 | - cpu_idx = 0; |
3826 | - } |
3827 | - |
3828 | - return system_type[sys_idx].cpu[cpu_idx].ret; |
3829 | -} |
3830 | |
3831 | === target is u'subarch-mips-linux.c' |
3832 | === modified file 'src/system/subarch-powerpc-linux.c' |
3833 | --- src/system/subarch-powerpc-linux.c 2013-04-11 09:55:37 +0000 |
3834 | +++ src/system/subarch-powerpc-linux.c 2015-01-28 21:45:05 +0000 |
3835 | @@ -35,6 +35,7 @@ |
3836 | { "PA Semi", "pasemi" }, |
3837 | { "Maple", "chrp_ibm" }, |
3838 | { "pSeries", "chrp_ibm" }, |
3839 | + { "PowerNV", "chrp_ibm" }, |
3840 | { "P4080 DS", "fsl" }, |
3841 | { "QEMU e500", "fsl" }, |
3842 | { NULL, NULL } |
3843 | |
3844 | === added symlink 'src/system/subarch-ppc64-linux.c' |
3845 | === target is u'subarch-powerpc-linux.c' |
3846 | === modified file 'src/system/subarch-x86-linux.c' |
3847 | --- src/system/subarch-x86-linux.c 2012-11-25 14:59:59 +0000 |
3848 | +++ src/system/subarch-x86-linux.c 2015-01-28 21:45:05 +0000 |
3849 | @@ -58,6 +58,7 @@ |
3850 | #include <fcntl.h> |
3851 | |
3852 | #include <debian-installer/system/subarch.h> |
3853 | +#include <debian-installer/system/efi.h> |
3854 | |
3855 | #define WORD(x) (*(const uint16_t *)(x)) |
3856 | #define DWORD(x) (*(const uint32_t *)(x)) |
3857 | @@ -250,17 +251,6 @@ |
3858 | return ret; |
3859 | } |
3860 | |
3861 | -/* Are we on an EFI system? Check to see if /sys/firmware/efi |
3862 | - * exists */ |
3863 | -static int is_efi(void) |
3864 | -{ |
3865 | - int ret = access("/sys/firmware/efi", R_OK); |
3866 | - if (ret == 0) |
3867 | - return 1; |
3868 | - else |
3869 | - return 0; |
3870 | -} |
3871 | - |
3872 | struct map { |
3873 | const char *entry; |
3874 | const char *ret; |
3875 | @@ -280,7 +270,7 @@ |
3876 | |
3877 | /* Look for generic EFI first; this will be over-ridden by the mac |
3878 | * detection next if we're on a mac. */ |
3879 | - if (is_efi()) |
3880 | + if (di_system_is_efi()) |
3881 | ret = "efi"; |
3882 | |
3883 | if (manufacturer) |