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