Merge lp:~dannf/libdebian-installer/debsync into lp:~ubuntu-core-dev/libdebian-installer/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
Reviewer Review Type Date Requested Status
Ubuntu Core Development Team Pending
Review via email: mp+247903@code.launchpad.net

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
=== modified file 'debian/changelog'
--- debian/changelog 2014-03-20 13:50:17 +0000
+++ debian/changelog 2015-01-28 21:45:05 +0000
@@ -1,3 +1,134 @@
1libdebian-installer (0.99ubuntu1) UNRELEASED; urgency=medium
2
3 * Resynchronise with Debian. Remaining changes:
4 - Add Dove SoC subarchitecture.
5 - Add more OMAP4 Panda support.
6 - Add OMAP4 Blaze support.
7 - Add ArmadaXP support.
8 - Add Calxeda Highbank support.
9 - Add Freescale "P4080 DS" and "QEMU e500" support.
10 - Add Calxeda ECX-2000 support. (LP: #1196946)
11 - Add support for EXYNOS5440-based platforms (LP: #1231251)
12 - Add support for the WandBoard quad.
13 - Add support for keystone subarch
14 - Add support for HP ProLiant m800 Server Cartridge (keystone)
15 * The "generic" subarch is now returned for all unknown flavors,
16 so drop explicit matching for generic subarch hardware.
17 * Switch the Armada XP, EXYNOS5 and KeyStone2 to the "generic" subarch.
18 These platforms required special flavor kernel builds in previous
19 Ubuntu releases that are no longer provided.
20 * Drop support for Marvell DB-MV88F6781-BP Development Board. We
21 no longer support the "dove" subarch (Ref: partman-auto changelog).
22
23 -- dann frazier <dannf@ubuntu.com> Wed, 28 Jan 2015 11:57:45 -0700
24
25libdebian-installer (0.99) unstable; urgency=medium
26
27 * Replace NULL terminator for the arm map_hardware table, accidentally
28 dropped in 0.92 (Closes: #776488).
29
30 -- dann frazier <dannf@debian.org> Wed, 28 Jan 2015 10:51:22 -0700
31
32libdebian-installer (0.98) unstable; urgency=low
33
34 [ Steve McIntyre ]
35 * Recognise the new ignore_uefi flag from partman-efi.
36 * Add myself to uploaders.
37
38 -- Steve McIntyre <93sam@debian.org> Tue, 25 Nov 2014 17:32:51 +0000
39
40libdebian-installer (0.97) unstable; urgency=low
41
42 [ Jérémy Bobbio ]
43 * Do not write timesamps in Doxygen generated documentation for
44 reproducibility of the build process (Closes: #762732).
45
46 -- Christian Perrier <bubulle@debian.org> Thu, 25 Sep 2014 06:39:10 +0200
47
48libdebian-installer (0.96) unstable; urgency=medium
49
50 * arm64: Detect UEFI based systems as "efi" subarch.
51
52 -- Ian Campbell <ijc@debian.org> Thu, 04 Sep 2014 21:19:26 +0100
53
54libdebian-installer (0.95) unstable; urgency=medium
55
56 [ Aurelien Jarno ]
57 * Add ppc64 and ppc64el support, based on a patch from
58 Frederic Bonnard.
59
60 -- Aurelien Jarno <aurel32@debian.org> Sun, 17 Aug 2014 23:25:04 +0200
61
62libdebian-installer (0.94) unstable; urgency=medium
63
64 [ Aurelien Jarno ]
65 * Group Loongson 3A and 3B in the same loongson-3 subarchitecture.
66
67 -- Aurelien Jarno <aurel32@debian.org> Sat, 12 Jul 2014 16:35:02 +0200
68
69libdebian-installer (0.93) unstable; urgency=medium
70
71 [ Colin Watson ]
72 * Policy version 3.9.5: no changes required.
73 * Upgrade doxygen configuration file using "doxygen -u", suppressing
74 several build warnings.
75
76 [ Ian Campbell ]
77 * Add support for the Buffalo Linkstation LS-XHL. (Closes: #740787)
78
79 -- Cyril Brulebois <kibi@debian.org> Fri, 14 Mar 2014 12:33:35 +0100
80
81libdebian-installer (0.92) unstable; urgency=low
82
83 [ Ian Campbell ]
84 * armel: Add support for "Buffalo Linkstation LS-CHLv2". (Closes: #735452)
85 * armhf/el: Return "generic" subarch for unknown platforms.
86 * arm64: Always return "generic" subarch.
87
88 -- Colin Watson <cjwatson@debian.org> Mon, 27 Jan 2014 16:21:00 +0000
89
90libdebian-installer (0.91) unstable; urgency=medium
91
92 * mips, mipsel: rewrite subarch-mips-linux.c:
93 - Use a regex system instead of a two level lookup to provide more
94 flexibility.
95 - Use subarch-mips-linux.c for mipsel, as more and more systems are
96 bi-endian.
97 - Remove non-supported platforms.
98 - Add support for Cavium Octeon platforms.
99 - Detect more Loongson 2E and 2F machines.
100
101 -- Aurelien Jarno <aurel32@debian.org> Sat, 28 Dec 2013 09:50:51 +0100
102
103libdebian-installer (0.90) unstable; urgency=medium
104
105 * Add support for Loongson 3A platforms.
106
107 -- Aurelien Jarno <aurel32@debian.org> Fri, 27 Dec 2013 20:27:38 +0100
108
109libdebian-installer (0.89) unstable; urgency=low
110
111 * Add support for EXYNOS5440 platforms
112 * Add support for Calxeda Highbank and Midway platforms
113 * Add support for arm64
114 * Add support for virt subarch for arm32/arm64 guests
115 * Add support for the ARMv8 foundation model
116 * Add support for Applied Micro X-Gene systems
117
118 -- dann frazier <dannf@debian.org> Mon, 23 Dec 2013 13:43:25 -0700
119
120libdebian-installer (0.88ubuntu6) utopic; urgency=medium
121
122 * subarch-powerpc-linux.c: Pretend "PowerNV" is "chrp_ibm" for now.
123
124 -- Adam Conrad <adconrad@ubuntu.com> Tue, 07 Oct 2014 17:46:52 -0600
125
126libdebian-installer (0.88ubuntu5) trusty; urgency=medium
127
128 * Add support for HP ProLiant m800 Server Cartridge (keystone)
129
130 -- Manoj Iyer <manoj.iyer@canonical.com> Thu, 19 Jun 2014 12:04:30 -0500
131
1libdebian-installer (0.88ubuntu4) trusty; urgency=medium132libdebian-installer (0.88ubuntu4) trusty; urgency=medium
2133
3 * Report the Calxeda ECX-2000 as generic-lpae, not generic, to match134 * Report the Calxeda ECX-2000 as generic-lpae, not generic, to match
4135
=== modified file 'debian/control'
--- debian/control 2013-11-14 22:09:38 +0000
+++ debian/control 2015-01-28 21:45:05 +0000
@@ -3,9 +3,9 @@
3Priority: optional3Priority: optional
4Maintainer: Ubuntu Installer Team <ubuntu-installer@lists.ubuntu.com>4Maintainer: Ubuntu Installer Team <ubuntu-installer@lists.ubuntu.com>
5XSBC-Original-Maintainer: Debian Install System Team <debian-boot@lists.debian.org>5XSBC-Original-Maintainer: Debian Install System Team <debian-boot@lists.debian.org>
6Uploaders: Bastian Blank <waldi@debian.org>, Colin Watson <cjwatson@debian.org>, Christian Perrier <bubulle@debian.org>6Uploaders: Bastian Blank <waldi@debian.org>, Colin Watson <cjwatson@debian.org>, Christian Perrier <bubulle@debian.org>, Steve McIntyre <93sam@debian.org>
7Build-Depends: dpkg-dev (>= 1.13.5), debhelper (>= 9), dh-autoreconf, doxygen7Build-Depends: dpkg-dev (>= 1.13.5), debhelper (>= 9), dh-autoreconf, doxygen
8Standards-Version: 3.9.48Standards-Version: 3.9.5
9XS-Debian-Vcs-Browser: http://anonscm.debian.org/gitweb/?p=d-i/libdebian-installer.git9XS-Debian-Vcs-Browser: http://anonscm.debian.org/gitweb/?p=d-i/libdebian-installer.git
10XS-Debian-Vcs-Git: git://anonscm.debian.org/d-i/libdebian-installer.git10XS-Debian-Vcs-Git: git://anonscm.debian.org/d-i/libdebian-installer.git
11Vcs-Bzr: http://bazaar.launchpad.net/~ubuntu-core-dev/libdebian-installer/ubuntu11Vcs-Bzr: http://bazaar.launchpad.net/~ubuntu-core-dev/libdebian-installer/ubuntu
1212
=== modified file 'doc/Doxyfile.in'
--- doc/Doxyfile.in 2003-11-19 09:24:14 +0000
+++ doc/Doxyfile.in 2015-01-28 21:45:05 +0000
@@ -1,1078 +1,2306 @@
1# Doxyfile 1.3.41# Doxyfile 1.8.6
22
3# This file describes the settings to be used by the documentation system3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project4# doxygen (www.doxygen.org) for a project.
5#5#
6# All text after a hash (#) is considered a comment and will be ignored6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
7# The format is:10# The format is:
8# TAG = value [value, ...]11# TAG = value [value, ...]
9# For lists items can also be appended using:12# For lists, items can also be appended using:
10# TAG += value [value, ...]13# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")14# Values that contain spaces should be placed between quotes (\" \").
1215
13#---------------------------------------------------------------------------16#---------------------------------------------------------------------------
14# Project related configuration options17# Project related configuration options
15#---------------------------------------------------------------------------18#---------------------------------------------------------------------------
1619
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
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
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
1934
20PROJECT_NAME = libdebian-installer35PROJECT_NAME = libdebian-installer
2136
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
23# This could be handy for archiving the generated documentation or 38# could be handy for archiving the generated documentation or if some version
24# if some version control system is used.39# control system is used.
2540
26PROJECT_NUMBER = 41PROJECT_NUMBER =
2742
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
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
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.
31# where doxygen was started. If left blank the current directory will be used.46
47PROJECT_BRIEF =
48
49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50# the documentation. The maximum height of the logo should not exceed 55 pixels
51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52# to the output directory.
53
54PROJECT_LOGO =
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
3260
33OUTPUT_DIRECTORY = .61OUTPUT_DIRECTORY = .
3462
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-
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
37# information to generate all constant output in the proper language. 65# will distribute the generated files over these directories. Enabling this
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
39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 67# putting all generated files in the same directory would otherwise causes
40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 68# performance problems for the file system.
41# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 69# The default value is: NO.
42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.70
71CREATE_SUBDIRS = NO
72
73# The OUTPUT_LANGUAGE tag is used to specify the language in which all
74# documentation generated by doxygen is written. Doxygen will use this
75# information to generate all constant output in the proper language.
76# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
77# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
78# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
79# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
81# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
82# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
83# Ukrainian and Vietnamese.
84# The default value is: English.
4385
44OUTPUT_LANGUAGE = English86OUTPUT_LANGUAGE = English
4587
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
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
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.
49# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 91# The default value is: YES.
50# forces the Windows encoding (this is the default for the Windows binary),
51# whereas setting the tag to NO uses a Unix-style encoding (the default for
52# all platforms other than Windows).
53
54USE_WINDOWS_ENCODING = NO
55
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.
6092
61BRIEF_MEMBER_DESC = YES93BRIEF_MEMBER_DESC = YES
6294
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
64# the brief description of a member or function before the detailed description. 96# description of a member or function before the detailed description
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 97#
98# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.99# brief descriptions will be completely suppressed.
100# The default value is: YES.
67101
68REPEAT_BRIEF = YES102REPEAT_BRIEF = YES
69103
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
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
106# as the leading text of the brief description, will be stripped from the text
107# and the result, after processing the whole list, is used as the annotated
108# text. Otherwise, the brief description is used as-is. If left blank, the
109# following values are used ($name is automatically replaced with the name of
110# the entity):The $name class, The $name widget, The $name file, is, provides,
111# specifies, contains, represents, a, an and the.
112
113ABBREVIATE_BRIEF =
114
115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116# doxygen will generate a detailed section even if there is only a brief
72# description.117# description.
118# The default value is: NO.
73119
74ALWAYS_DETAILED_SEC = NO120ALWAYS_DETAILED_SEC = NO
75121
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
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
78# ordinary class members. Constructors, destructors and assignment operators of 124# members were ordinary class members. Constructors, destructors and assignment
79# the base classes will not be shown.125# operators of the base classes will not be shown.
126# The default value is: NO.
80127
81INLINE_INHERITED_MEMB = YES128INLINE_INHERITED_MEMB = YES
82129
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
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
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
133# The default value is: YES.
86134
87FULL_PATH_NAMES = NO135FULL_PATH_NAMES = NO
88136
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.
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
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.
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
93141# strip.
94STRIP_FROM_PATH = 142#
95143# Note that you can specify absolute paths here, but also relative paths, which
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.
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.
98# doesn't support long names like on DOS, Mac, or CD-ROM.146
147STRIP_FROM_PATH =
148
149# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150# path mentioned in the documentation of a class, which tells the reader which
151# header file to include in order to use a class. If left blank only the name of
152# the header file containing the class definition is used. Otherwise one should
153# specify the list of include paths that are normally passed to the compiler
154# using the -I flag.
155
156STRIP_FROM_INC_PATH =
157
158# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
159# less readable) file names. This can be useful is your file systems doesn't
160# support long names like on DOS, Mac, or CD-ROM.
161# The default value is: NO.
99162
100SHORT_NAMES = NO163SHORT_NAMES = NO
101164
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
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
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-
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
106# explict @brief command for a brief description.169# description.)
170# The default value is: NO.
107171
108JAVADOC_AUTOBRIEF = NO172JAVADOC_AUTOBRIEF = NO
109173
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
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
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
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.)
114# description. Set this tag to YES if you prefer the old behaviour instead.178# The default value is: NO.
179
180QT_AUTOBRIEF = NO
181
182# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
183# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
184# a brief description. This used to be the default behavior. The new default is
185# to treat a multi-line C++ comment block as a detailed description. Set this
186# tag to YES if you prefer the old behavior instead.
187#
188# Note that setting this tag to YES also means that rational rose comments are
189# not recognized any more.
190# The default value is: NO.
115191
116MULTILINE_CPP_IS_BRIEF = NO192MULTILINE_CPP_IS_BRIEF = NO
117193
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
119# will output the detailed description near the top, like JavaDoc.195# documentation from any documented member that it re-implements.
120# If set to NO, the detailed description appears after the member 196# The default value is: YES.
121# documentation.
122
123DETAILS_AT_TOP = NO
124
125# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
126# member inherits the documentation from any documented member that it
127# reimplements.
128197
129INHERIT_DOCS = YES198INHERIT_DOCS = YES
130199
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
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
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.
134# all members of a group must be documented explicitly.203# The default value is: NO.
135204
136DISTRIBUTE_GROUP_DOC = NO205SEPARATE_MEMBER_PAGES = NO
137206
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
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.
209# Minimum value: 1, maximum value: 16, default value: 4.
140210
141TAB_SIZE = 8211TAB_SIZE = 8
142212
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
144# as commands in the documentation. An alias has the form "name=value". 214# the documentation. An alias has the form:
145# For example adding "sideeffect=\par Side Effects:\n" will allow you to 215# name=value
146# put the command \sideeffect (or @sideeffect) in the documentation, which 216# For example adding
147# will result in a user-defined paragraph with heading "Side Effects:". 217# "sideeffect=@par Side Effects:\n"
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
149219# documentation, which will result in a user-defined paragraph with heading
150ALIASES = 220# "Side Effects:". You can put \n's in the value part of an alias to insert
151221# newlines.
152# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 222
153# only. Doxygen will then generate output that is more tailored for C. 223ALIASES =
154# For instance, some of the names that are used will be different. The list 224
155# of all members will be omitted, etc.225# This tag can be used to specify a number of word-keyword mappings (TCL only).
226# A mapping has the form "name=value". For example adding "class=itcl::class"
227# will allow you to use the command class in the itcl::class meaning.
228
229TCL_SUBST =
230
231# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
232# only. Doxygen will then generate output that is more tailored for C. For
233# instance, some of the names that are used will be different. The list of all
234# members will be omitted, etc.
235# The default value is: NO.
156236
157OPTIMIZE_OUTPUT_FOR_C = YES237OPTIMIZE_OUTPUT_FOR_C = YES
158238
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
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
161# For instance, namespaces will be presented as packages, qualified scopes 241# for that language. For instance, namespaces will be presented as packages,
162# will look different, etc.242# qualified scopes will look different, etc.
243# The default value is: NO.
163244
164OPTIMIZE_OUTPUT_JAVA = NO245OPTIMIZE_OUTPUT_JAVA = NO
165246
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
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.
168# subgroup of that type (e.g. under the Public Functions section). Set it to 249# The default value is: NO.
169# NO to prevent subgrouping. Alternatively, this can be done per class using 250
170# the \nosubgrouping command.251OPTIMIZE_FOR_FORTRAN = NO
252
253# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
254# sources. Doxygen will then generate output that is tailored for VHDL.
255# The default value is: NO.
256
257OPTIMIZE_OUTPUT_VHDL = NO
258
259# Doxygen selects the parser to use depending on the extension of the files it
260# parses. With this tag you can assign which parser to use for a given
261# extension. Doxygen has a built-in mapping, but you can override or extend it
262# using this tag. The format is ext=language, where ext is a file extension, and
263# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
264# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
265# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
266# (default is Fortran), use: inc=Fortran f=C.
267#
268# Note For files without extension you can use no_extension as a placeholder.
269#
270# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
271# the files are not read by doxygen.
272
273EXTENSION_MAPPING =
274
275# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
276# according to the Markdown format, which allows for more readable
277# documentation. See http://daringfireball.net/projects/markdown/ for details.
278# The output of markdown processing is further processed by doxygen, so you can
279# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
280# case of backward compatibilities issues.
281# The default value is: YES.
282
283MARKDOWN_SUPPORT = YES
284
285# When enabled doxygen tries to link words that correspond to documented
286# classes, or namespaces to their corresponding documentation. Such a link can
287# be prevented in individual cases by by putting a % sign in front of the word
288# or globally by setting AUTOLINK_SUPPORT to NO.
289# The default value is: YES.
290
291AUTOLINK_SUPPORT = YES
292
293# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
294# to include (a tag file for) the STL sources as input, then you should set this
295# tag to YES in order to let doxygen match functions declarations and
296# definitions whose arguments contain STL classes (e.g. func(std::string);
297# versus func(std::string) {}). This also make the inheritance and collaboration
298# diagrams that involve STL classes more complete and accurate.
299# The default value is: NO.
300
301BUILTIN_STL_SUPPORT = NO
302
303# If you use Microsoft's C++/CLI language, you should set this option to YES to
304# enable parsing support.
305# The default value is: NO.
306
307CPP_CLI_SUPPORT = NO
308
309# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
310# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
311# will parse them like normal C++ but will assume all classes use public instead
312# of private inheritance when no explicit protection keyword is present.
313# The default value is: NO.
314
315SIP_SUPPORT = NO
316
317# For Microsoft's IDL there are propget and propput attributes to indicate
318# getter and setter methods for a property. Setting this option to YES will make
319# doxygen to replace the get and set methods by a property in the documentation.
320# This will only work if the methods are indeed getting or setting a simple
321# type. If this is not the case, or you want to show the methods anyway, you
322# should set this option to NO.
323# The default value is: YES.
324
325IDL_PROPERTY_SUPPORT = YES
326
327# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
328# tag is set to YES, then doxygen will reuse the documentation of the first
329# member in the group (if any) for the other members of the group. By default
330# all members of a group must be documented explicitly.
331# The default value is: NO.
332
333DISTRIBUTE_GROUP_DOC = NO
334
335# Set the SUBGROUPING tag to YES to allow class member groups of the same type
336# (for instance a group of public functions) to be put as a subgroup of that
337# type (e.g. under the Public Functions section). Set it to NO to prevent
338# subgrouping. Alternatively, this can be done per class using the
339# \nosubgrouping command.
340# The default value is: YES.
171341
172SUBGROUPING = YES342SUBGROUPING = YES
173343
344# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
345# are shown inside the group in which they are included (e.g. using \ingroup)
346# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
347# and RTF).
348#
349# Note that this feature does not work in combination with
350# SEPARATE_MEMBER_PAGES.
351# The default value is: NO.
352
353INLINE_GROUPED_CLASSES = NO
354
355# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
356# with only public data fields or simple typedef fields will be shown inline in
357# the documentation of the scope in which they are defined (i.e. file,
358# namespace, or group documentation), provided this scope is documented. If set
359# to NO, structs, classes, and unions are shown on a separate page (for HTML and
360# Man pages) or section (for LaTeX and RTF).
361# The default value is: NO.
362
363INLINE_SIMPLE_STRUCTS = NO
364
365# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
366# enum is documented as struct, union, or enum with the name of the typedef. So
367# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
368# with name TypeT. When disabled the typedef will appear as a member of a file,
369# namespace, or class. And the struct will be named TypeS. This can typically be
370# useful for C code in case the coding convention dictates that all compound
371# types are typedef'ed and only the typedef is referenced, never the tag name.
372# The default value is: NO.
373
374TYPEDEF_HIDES_STRUCT = NO
375
376# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
377# cache is used to resolve symbols given their name and scope. Since this can be
378# an expensive process and often the same symbol appears multiple times in the
379# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
380# doxygen will become slower. If the cache is too large, memory is wasted. The
381# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
382# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
383# symbols. At the end of a run doxygen will report the cache usage and suggest
384# the optimal cache size from a speed point of view.
385# Minimum value: 0, maximum value: 9, default value: 0.
386
387LOOKUP_CACHE_SIZE = 0
388
174#---------------------------------------------------------------------------389#---------------------------------------------------------------------------
175# Build related configuration options390# Build related configuration options
176#---------------------------------------------------------------------------391#---------------------------------------------------------------------------
177392
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
179# documentation are documented, even if no documentation was available. 394# documentation are documented, even if no documentation was available. Private
180# Private class members and static file members will be hidden unless 395# class members and static file members will be hidden unless the
181# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES396# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
397# Note: This will also disable the warnings about undocumented members that are
398# normally produced when WARNINGS is set to YES.
399# The default value is: NO.
182400
183EXTRACT_ALL = NO401EXTRACT_ALL = NO
184402
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
186# will be included in the documentation.404# be included in the documentation.
405# The default value is: NO.
187406
188EXTRACT_PRIVATE = NO407EXTRACT_PRIVATE = NO
189408
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
191# will be included in the documentation.410# scope will be included in the documentation.
411# The default value is: NO.
412
413EXTRACT_PACKAGE = NO
414
415# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
416# included in the documentation.
417# The default value is: NO.
192418
193EXTRACT_STATIC = YES419EXTRACT_STATIC = YES
194420
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
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
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
424# for Java sources.
425# The default value is: YES.
198426
199EXTRACT_LOCAL_CLASSES = YES427EXTRACT_LOCAL_CLASSES = YES
200428
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,
202# undocumented members of documented classes, files or namespaces. 430# which are defined in the implementation section but not in the interface are
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
204# various overviews, but no documentation section is generated. 432# included.
205# This option has no effect if EXTRACT_ALL is enabled.433# The default value is: NO.
434
435EXTRACT_LOCAL_METHODS = NO
436
437# If this flag is set to YES, the members of anonymous namespaces will be
438# extracted and appear in the documentation as a namespace called
439# 'anonymous_namespace{file}', where file will be replaced with the base name of
440# the file that contains the anonymous namespace. By default anonymous namespace
441# are hidden.
442# The default value is: NO.
443
444EXTRACT_ANON_NSPACES = NO
445
446# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
447# undocumented members inside documented classes or files. If set to NO these
448# members will be included in the various overviews, but no documentation
449# section is generated. This option has no effect if EXTRACT_ALL is enabled.
450# The default value is: NO.
206451
207HIDE_UNDOC_MEMBERS = NO452HIDE_UNDOC_MEMBERS = NO
208453
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
210# undocumented classes that are normally visible in the class hierarchy. 455# undocumented classes that are normally visible in the class hierarchy. If set
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
212# overviews. This option has no effect if EXTRACT_ALL is enabled.457# no effect if EXTRACT_ALL is enabled.
458# The default value is: NO.
213459
214HIDE_UNDOC_CLASSES = NO460HIDE_UNDOC_CLASSES = NO
215461
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
217# friend (class|struct|union) declarations. 463# (class|struct|union) declarations. If set to NO these declarations will be
218# If set to NO (the default) these declarations will be included in the 464# included in the documentation.
219# documentation.465# The default value is: NO.
220466
221HIDE_FRIEND_COMPOUNDS = NO467HIDE_FRIEND_COMPOUNDS = NO
222468
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
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
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.
226# function's detailed documentation block.472# The default value is: NO.
227473
228HIDE_IN_BODY_DOCS = NO474HIDE_IN_BODY_DOCS = NO
229475
230# The INTERNAL_DOCS tag determines if documentation 476# The INTERNAL_DOCS tag determines if documentation that is typed after a
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
232# to NO (the default) then the documentation will be excluded. 478# will be excluded. Set it to YES to include the internal documentation.
233# Set it to YES to include the internal documentation.479# The default value is: NO.
234480
235INTERNAL_DOCS = YES481INTERNAL_DOCS = YES
236482
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
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
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
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
241# users are advised to set this option to NO.487# and Mac users are advised to set this option to NO.
488# The default value is: system dependent.
242489
243CASE_SENSE_NAMES = YES490CASE_SENSE_NAMES = YES
244491
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
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
247# documentation. If set to YES the scope will be hidden.494# scope will be hidden.
495# The default value is: NO.
248496
249HIDE_SCOPE_NAMES = YES497HIDE_SCOPE_NAMES = YES
250498
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
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.
253# of that file.501# The default value is: YES.
254502
255SHOW_INCLUDE_FILES = YES503SHOW_INCLUDE_FILES = YES
256504
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
258# is inserted in the documentation for inline members.506# grouped member an include statement to the documentation, telling the reader
507# which file to include in order to use the member.
508# The default value is: NO.
509
510SHOW_GROUPED_MEMB_INC = NO
511
512# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
513# files with double quotes in the documentation rather than with sharp brackets.
514# The default value is: NO.
515
516FORCE_LOCAL_INCLUDES = NO
517
518# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
519# documentation for inline members.
520# The default value is: YES.
259521
260INLINE_INFO = YES522INLINE_INFO = YES
261523
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
263# will sort the (detailed) documentation of file and class members 525# (detailed) documentation of file and class members alphabetically by member
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.
265# declaration order.527# The default value is: YES.
266528
267SORT_MEMBER_DOCS = YES529SORT_MEMBER_DOCS = YES
268530
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
270# disable (NO) the todo list. This list is created by putting \todo 532# descriptions of file, namespace and class members alphabetically by member
271# commands in the documentation.533# name. If set to NO the members will appear in declaration order. Note that
534# this will also influence the order of the classes in the class list.
535# The default value is: NO.
536
537SORT_BRIEF_DOCS = NO
538
539# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
540# (brief and detailed) documentation of class members so that constructors and
541# destructors are listed first. If set to NO the constructors will appear in the
542# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
543# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
544# member documentation.
545# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
546# detailed member documentation.
547# The default value is: NO.
548
549SORT_MEMBERS_CTORS_1ST = NO
550
551# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
552# of group names into alphabetical order. If set to NO the group names will
553# appear in their defined order.
554# The default value is: NO.
555
556SORT_GROUP_NAMES = NO
557
558# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
559# fully-qualified names, including namespaces. If set to NO, the class list will
560# be sorted only by class name, not including the namespace part.
561# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
562# Note: This option applies only to the class list, not to the alphabetical
563# list.
564# The default value is: NO.
565
566SORT_BY_SCOPE_NAME = NO
567
568# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
569# type resolution of all parameters of a function it will reject a match between
570# the prototype and the implementation of a member function even if there is
571# only one candidate or it is obvious which candidate to choose by doing a
572# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
573# accept a match between prototype and implementation in such cases.
574# The default value is: NO.
575
576STRICT_PROTO_MATCHING = NO
577
578# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
579# todo list. This list is created by putting \todo commands in the
580# documentation.
581# The default value is: YES.
272582
273GENERATE_TODOLIST = YES583GENERATE_TODOLIST = YES
274584
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
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
277# commands in the documentation.587# documentation.
588# The default value is: YES.
278589
279GENERATE_TESTLIST = YES590GENERATE_TESTLIST = YES
280591
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
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.
283# commands in the documentation.594# The default value is: YES.
284595
285GENERATE_BUGLIST = YES596GENERATE_BUGLIST = YES
286597
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)
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
289# \deprecated commands in the documentation.600# the documentation.
601# The default value is: YES.
290602
291GENERATE_DEPRECATEDLIST= YES603GENERATE_DEPRECATEDLIST= YES
292604
293# The ENABLED_SECTIONS tag can be used to enable conditional 605# The ENABLED_SECTIONS tag can be used to enable conditional documentation
294# documentation sections, marked by \if sectionname ... \endif.606# sections, marked by \if <section_label> ... \endif and \cond <section_label>
295607# ... \endcond blocks.
296ENABLED_SECTIONS = 608
297609ENABLED_SECTIONS =
298# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 610
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
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
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
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
303# documentation can be controlled using \showinitializer or \hideinitializer 615# appearance of the value of individual variables and macros / defines can be
304# command in the documentation regardless of this setting.616# controlled using \showinitializer or \hideinitializer command in the
617# documentation regardless of this setting.
618# Minimum value: 0, maximum value: 10000, default value: 30.
305619
306MAX_INITIALIZER_LINES = 30620MAX_INITIALIZER_LINES = 30
307621
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
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
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.
625# The default value is: YES.
311626
312SHOW_USED_FILES = NO627SHOW_USED_FILES = NO
313628
314#---------------------------------------------------------------------------629# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
315# configuration options related to warning and progress messages630# will remove the Files entry from the Quick Index and from the Folder Tree View
316#---------------------------------------------------------------------------631# (if specified).
317632# The default value is: YES.
318# The QUIET tag can be used to turn on/off the messages that are generated 633
319# by doxygen. Possible values are YES and NO. If left blank NO is used.634SHOW_FILES = YES
635
636# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
637# page. This will remove the Namespaces entry from the Quick Index and from the
638# Folder Tree View (if specified).
639# The default value is: YES.
640
641SHOW_NAMESPACES = YES
642
643# The FILE_VERSION_FILTER tag can be used to specify a program or script that
644# doxygen should invoke to get the current version for each file (typically from
645# the version control system). Doxygen will invoke the program by executing (via
646# popen()) the command command input-file, where command is the value of the
647# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
648# by doxygen. Whatever the program writes to standard output is used as the file
649# version. For an example see the documentation.
650
651FILE_VERSION_FILTER =
652
653# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
654# by doxygen. The layout file controls the global structure of the generated
655# output files in an output format independent way. To create the layout file
656# that represents doxygen's defaults, run doxygen with the -l option. You can
657# optionally specify a file name after the option, if omitted DoxygenLayout.xml
658# will be used as the name of the layout file.
659#
660# Note that if you run doxygen from a directory containing a file called
661# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
662# tag is left empty.
663
664LAYOUT_FILE =
665
666# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
667# the reference definitions. This must be a list of .bib files. The .bib
668# extension is automatically appended if omitted. This requires the bibtex tool
669# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
670# For LaTeX the style of the bibliography can be controlled using
671# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
672# search path. Do not use file names with spaces, bibtex cannot handle them. See
673# also \cite for info how to create references.
674
675CITE_BIB_FILES =
676
677#---------------------------------------------------------------------------
678# Configuration options related to warning and progress messages
679#---------------------------------------------------------------------------
680
681# The QUIET tag can be used to turn on/off the messages that are generated to
682# standard output by doxygen. If QUIET is set to YES this implies that the
683# messages are off.
684# The default value is: NO.
320685
321QUIET = NO686QUIET = NO
322687
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
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
325# NO is used.690# this implies that the warnings are on.
691#
692# Tip: Turn warnings on while writing the documentation.
693# The default value is: YES.
326694
327WARNINGS = YES695WARNINGS = YES
328696
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
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
331# automatically be disabled.699# will automatically be disabled.
700# The default value is: YES.
332701
333WARN_IF_UNDOCUMENTED = YES702WARN_IF_UNDOCUMENTED = YES
334703
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
336# potential errors in the documentation, such as not documenting some 705# potential errors in the documentation, such as not documenting some parameters
337# parameters in a documented function, or documenting parameters that 706# in a documented function, or documenting parameters that don't exist or using
338# don't exist or using markup commands wrongly.707# markup commands wrongly.
708# The default value is: YES.
339709
340WARN_IF_DOC_ERROR = YES710WARN_IF_DOC_ERROR = YES
341711
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
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
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
345# warning originated and the warning text.715# documentation, but not about the absence of documentation.
716# The default value is: NO.
717
718WARN_NO_PARAMDOC = NO
719
720# The WARN_FORMAT tag determines the format of the warning messages that doxygen
721# can produce. The string should contain the $file, $line, and $text tags, which
722# will be replaced by the file and line number from which the warning originated
723# and the warning text. Optionally the format may contain $version, which will
724# be replaced by the version of the file (if it could be obtained via
725# FILE_VERSION_FILTER)
726# The default value is: $file:$line: $text.
346727
347WARN_FORMAT = "$file:$line: $text"728WARN_FORMAT = "$file:$line: $text"
348729
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
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
351# to stderr.732# error (stderr).
352733
353WARN_LOGFILE = 734WARN_LOGFILE =
354735
355#---------------------------------------------------------------------------736#---------------------------------------------------------------------------
356# configuration options related to the input files737# Configuration options related to the input files
357#---------------------------------------------------------------------------738#---------------------------------------------------------------------------
358739
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
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
361# directories like "/usr/src/myproject". Separate the files or directories 742# directories like /usr/src/myproject. Separate the files or directories with
362# with spaces.743# spaces.
363744# Note: If this tag is empty the current directory is searched.
364INPUT = @top_srcdir@/doc/libdebian-installer @top_srcdir@/include/ @top_srcdir@/src/745
365746INPUT = @top_srcdir@/doc/libdebian-installer \
366# If the value of the INPUT tag contains directories, you can use the 747 @top_srcdir@/include/ \
367# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 748 @top_srcdir@/src/
368# and *.h) to filter out the source-files in the directories. If left 749
369# blank the following patterns are tested: 750# This tag can be used to specify the character encoding of the source files
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
371# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc752# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
372753# documentation (see: http://www.gnu.org/software/libiconv) for the list of
373FILE_PATTERNS = *.c *.h754# possible encodings.
374755# The default value is: UTF-8.
375# The RECURSIVE tag can be used to turn specify whether or not subdirectories 756
376# should be searched for input files as well. Possible values are YES and NO. 757INPUT_ENCODING = UTF-8
377# If left blank NO is used.758
759# If the value of the INPUT tag contains directories, you can use the
760# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
761# *.h) to filter out the source-files in the directories. If left blank the
762# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
763# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
764# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
765# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
766# *.qsf, *.as and *.js.
767
768FILE_PATTERNS = *.c \
769 *.h
770
771# The RECURSIVE tag can be used to specify whether or not subdirectories should
772# be searched for input files as well.
773# The default value is: NO.
378774
379RECURSIVE = YES775RECURSIVE = YES
380776
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
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
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.
384780#
385EXCLUDE = 781# Note that relative paths are relative to the directory from which doxygen is
386782# run.
387# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 783
388# that are symbolic links (a Unix filesystem feature) are excluded from the input.784EXCLUDE =
785
786# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
787# directories that are symbolic links (a Unix file system feature) are excluded
788# from the input.
789# The default value is: NO.
389790
390EXCLUDE_SYMLINKS = NO791EXCLUDE_SYMLINKS = NO
391792
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
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
394# certain files from those directories.795# certain files from those directories.
395796#
396EXCLUDE_PATTERNS = 797# Note that the wildcards are matched against the file with absolute path, so to
397798# exclude all test directories for example use the pattern */test/*
398# The EXAMPLE_PATH tag can be used to specify one or more files or 799
399# directories that contain example code fragments that are included (see 800EXCLUDE_PATTERNS =
400# the \include command).801
401802# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
402EXAMPLE_PATH = 803# (namespaces, classes, functions, etc.) that should be excluded from the
403804# output. The symbol name can be a fully qualified name, a word, or if the
404# If the value of the EXAMPLE_PATH tag contains directories, you can use the 805# wildcard * is used, a substring. Examples: ANamespace, AClass,
405# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 806# AClass::ANamespace, ANamespace::*Test
406# and *.h) to filter out the source-files in the directories. If left 807#
407# blank all files are included.808# Note that the wildcards are matched against the file with absolute path, so to
408809# exclude all test directories use the pattern */test/*
409EXAMPLE_PATTERNS = 810
410811EXCLUDE_SYMBOLS =
411# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 812
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
413# commands irrespective of the value of the RECURSIVE tag. 814# that contain example code fragments that are included (see the \include
414# Possible values are YES and NO. If left blank NO is used.815# command).
816
817EXAMPLE_PATH =
818
819# If the value of the EXAMPLE_PATH tag contains directories, you can use the
820# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
821# *.h) to filter out the source-files in the directories. If left blank all
822# files are included.
823
824EXAMPLE_PATTERNS =
825
826# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
827# searched for input files to be used with the \include or \dontinclude commands
828# irrespective of the value of the RECURSIVE tag.
829# The default value is: NO.
415830
416EXAMPLE_RECURSIVE = NO831EXAMPLE_RECURSIVE = NO
417832
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
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
420# the \image command).835# \image command).
421836
422IMAGE_PATH = 837IMAGE_PATH =
423838
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
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
426# by executing (via popen()) the command <filter> <input-file>, where <filter> 841# by executing (via popen()) the command:
427# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 842#
428# input file. Doxygen will then use the output that the filter program writes 843# <filter> <input-file>
429# to standard output.844#
430845# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
431INPUT_FILTER = 846# name of an input file. Doxygen will then use the output that the filter
432847# program writes to standard output. If FILTER_PATTERNS is specified, this tag
433# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 848# will be ignored.
434# INPUT_FILTER) will be used to filter the input files when producing source 849#
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
851# code is scanned, but not when the output code is generated. If lines are added
852# or removed, the anchors will not be placed correctly.
853
854INPUT_FILTER =
855
856# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
857# basis. Doxygen will compare the file name with each pattern and apply the
858# filter if there is a match. The filters are a list of the form: pattern=filter
859# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
860# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
861# patterns match the file name, INPUT_FILTER is applied.
862
863FILTER_PATTERNS =
864
865# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
866# INPUT_FILTER ) will also be used to filter the input files that are used for
867# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
868# The default value is: NO.
436869
437FILTER_SOURCE_FILES = NO870FILTER_SOURCE_FILES = NO
438871
439#---------------------------------------------------------------------------872# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
440# configuration options related to source browsing873# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
441#---------------------------------------------------------------------------874# it is also possible to disable source filtering for a specific pattern using
442875# *.ext= (so without naming a filter).
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.
444# be generated. Documented entities will be cross-referenced with these sources.877
878FILTER_SOURCE_PATTERNS =
879
880# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
881# is part of the input, its contents will be placed on the main page
882# (index.html). This can be useful if you have a project on for instance GitHub
883# and want to reuse the introduction page also for the doxygen output.
884
885USE_MDFILE_AS_MAINPAGE =
886
887#---------------------------------------------------------------------------
888# Configuration options related to source browsing
889#---------------------------------------------------------------------------
890
891# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
892# generated. Documented entities will be cross-referenced with these sources.
893#
894# Note: To get rid of all source code in the generated output, make sure that
895# also VERBATIM_HEADERS is set to NO.
896# The default value is: NO.
445897
446SOURCE_BROWSER = NO898SOURCE_BROWSER = NO
447899
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,
449# of functions and classes directly in the documentation.901# classes and enums directly into the documentation.
902# The default value is: NO.
450903
451INLINE_SOURCES = YES904INLINE_SOURCES = YES
452905
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
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
455# fragments. Normal C and C++ comments will always remain visible.908# Fortran comments will always remain visible.
909# The default value is: YES.
456910
457STRIP_CODE_COMMENTS = YES911STRIP_CODE_COMMENTS = YES
458912
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
460# then for each documented function all documented 914# function all documented functions referencing it will be listed.
461# functions referencing it will be listed.915# The default value is: NO.
462916
463REFERENCED_BY_RELATION = YES917REFERENCED_BY_RELATION = YES
464918
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
466# then for each documented function all documented entities 920# all documented entities called/used by that function will be listed.
467# called/used by that function will be listed.921# The default value is: NO.
468922
469REFERENCES_RELATION = YES923REFERENCES_RELATION = YES
470924
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
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
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
928# link to the documentation.
929# The default value is: YES.
930
931REFERENCES_LINK_SOURCE = YES
932
933# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
934# source code will show a tooltip with additional information such as prototype,
935# brief description and links to the definition and documentation. Since this
936# will make the HTML file larger and loading of large files a bit slower, you
937# can opt to disable this feature.
938# The default value is: YES.
939# This tag requires that the tag SOURCE_BROWSER is set to YES.
940
941SOURCE_TOOLTIPS = YES
942
943# If the USE_HTAGS tag is set to YES then the references to source code will
944# point to the HTML generated by the htags(1) tool instead of doxygen built-in
945# source browser. The htags tool is part of GNU's global source tagging system
946# (see http://www.gnu.org/software/global/global.html). You will need version
947# 4.8.6 or higher.
948#
949# To use it do the following:
950# - Install the latest version of global
951# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
952# - Make sure the INPUT points to the root of the source tree
953# - Run doxygen as normal
954#
955# Doxygen will invoke htags (and that will in turn invoke gtags), so these
956# tools must be available from the command line (i.e. in the search path).
957#
958# The result: instead of the source browser generated by doxygen, the links to
959# source code will now point to the output of htags.
960# The default value is: NO.
961# This tag requires that the tag SOURCE_BROWSER is set to YES.
962
963USE_HTAGS = NO
964
965# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
966# verbatim copy of the header file for each class for which an include is
967# specified. Set to NO to disable this.
968# See also: Section \class.
969# The default value is: YES.
474970
475VERBATIM_HEADERS = YES971VERBATIM_HEADERS = YES
476972
477#---------------------------------------------------------------------------973#---------------------------------------------------------------------------
478# configuration options related to the alphabetical class index974# Configuration options related to the alphabetical class index
479#---------------------------------------------------------------------------975#---------------------------------------------------------------------------
480976
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
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
483# contains a lot of classes, structs, unions or interfaces.979# classes, structs, unions or interfaces.
980# The default value is: YES.
484981
485ALPHABETICAL_INDEX = NO982ALPHABETICAL_INDEX = NO
486983
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
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.
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.
987# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
490988
491COLS_IN_ALPHA_INDEX = 5989COLS_IN_ALPHA_INDEX = 5
492990
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
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
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
496# should be ignored while generating the index headers.994# while generating the index headers.
497995# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
498IGNORE_PREFIX = 996
499997IGNORE_PREFIX =
500#---------------------------------------------------------------------------998
501# configuration options related to the HTML output999#---------------------------------------------------------------------------
502#---------------------------------------------------------------------------1000# Configuration options related to the HTML output
5031001#---------------------------------------------------------------------------
504# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 1002
505# generate HTML output.1003# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1004# The default value is: YES.
5061005
507GENERATE_HTML = YES1006GENERATE_HTML = YES
5081007
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
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
511# put in front of it. If left blank `html' will be used as the default path.1010# it.
1011# The default directory is: html.
1012# This tag requires that the tag GENERATE_HTML is set to YES.
5121013
513HTML_OUTPUT = html1014HTML_OUTPUT = html
5141015
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
516# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 1017# generated HTML page (for example: .htm, .php, .asp).
517# doxygen will generate files with .html extension.1018# The default value is: .html.
1019# This tag requires that the tag GENERATE_HTML is set to YES.
5181020
519HTML_FILE_EXTENSION = .html1021HTML_FILE_EXTENSION = .html
5201022
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
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
523# standard header.1025# standard header.
5241026#
525HTML_HEADER = 1027# To get valid HTML the header file that includes any scripts and style sheets
5261028# that doxygen needs, which is dependent on the configuration options used (e.g.
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
528# each generated HTML page. If it is left blank doxygen will generate a 1030# default header using
529# standard footer.1031# doxygen -w html new_header.html new_footer.html new_stylesheet.css
5301032# YourConfigFile
531HTML_FOOTER = 1033# and then modify the file new_header.html. See also section "Doxygen usage"
5321034# for information on how to generate the default header that doxygen normally
533# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 1035# uses.
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
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
536# will generate a default style sheet1038# of the possible markers and block names see the documentation.
5371039# This tag requires that the tag GENERATE_HTML is set to YES.
538HTML_STYLESHEET = 1040
5391041HTML_HEADER =
540# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 1042
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
542# NO a bullet list will be used.1044# generated HTML page. If the tag is left blank doxygen will generate a standard
5431045# footer. See HTML_HEADER for more information on how to generate a default
544HTML_ALIGN_MEMBERS = YES1046# footer and what special commands can be used inside the footer. See also
5451047# section "Doxygen usage" for information on how to generate the default footer
546# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1048# that doxygen normally uses.
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.
548# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 1050
549# of the generated HTML documentation.1051HTML_FOOTER =
1052
1053# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1054# sheet that is used by each HTML page. It can be used to fine-tune the look of
1055# the HTML output. If left blank doxygen will generate a default style sheet.
1056# See also section "Doxygen usage" for information on how to generate the style
1057# sheet that doxygen normally uses.
1058# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1059# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1060# obsolete.
1061# This tag requires that the tag GENERATE_HTML is set to YES.
1062
1063HTML_STYLESHEET =
1064
1065# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1066# defined cascading style sheet that is included after the standard style sheets
1067# created by doxygen. Using this option one can overrule certain style aspects.
1068# This is preferred over using HTML_STYLESHEET since it does not replace the
1069# standard style sheet and is therefor more robust against future updates.
1070# Doxygen will copy the style sheet file to the output directory. For an example
1071# see the documentation.
1072# This tag requires that the tag GENERATE_HTML is set to YES.
1073
1074HTML_EXTRA_STYLESHEET =
1075
1076# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1077# other source files which should be copied to the HTML output directory. Note
1078# that these files will be copied to the base HTML output directory. Use the
1079# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1080# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1081# files will be copied as-is; there are no commands or markers available.
1082# This tag requires that the tag GENERATE_HTML is set to YES.
1083
1084HTML_EXTRA_FILES =
1085
1086# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1087# will adjust the colors in the stylesheet and background images according to
1088# this color. Hue is specified as an angle on a colorwheel, see
1089# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1090# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1091# purple, and 360 is red again.
1092# Minimum value: 0, maximum value: 359, default value: 220.
1093# This tag requires that the tag GENERATE_HTML is set to YES.
1094
1095HTML_COLORSTYLE_HUE = 220
1096
1097# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1098# in the HTML output. For a value of 0 the output will use grayscales only. A
1099# value of 255 will produce the most vivid colors.
1100# Minimum value: 0, maximum value: 255, default value: 100.
1101# This tag requires that the tag GENERATE_HTML is set to YES.
1102
1103HTML_COLORSTYLE_SAT = 100
1104
1105# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1106# luminance component of the colors in the HTML output. Values below 100
1107# gradually make the output lighter, whereas values above 100 make the output
1108# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1109# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1110# change the gamma.
1111# Minimum value: 40, maximum value: 240, default value: 80.
1112# This tag requires that the tag GENERATE_HTML is set to YES.
1113
1114HTML_COLORSTYLE_GAMMA = 80
1115
1116# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1117# page will contain the date and time when the page was generated. Setting this
1118# to NO can help when comparing the output of multiple runs.
1119# The default value is: YES.
1120# This tag requires that the tag GENERATE_HTML is set to YES.
1121
1122HTML_TIMESTAMP = NO
1123
1124# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1125# documentation will contain sections that can be hidden and shown after the
1126# page has loaded.
1127# The default value is: NO.
1128# This tag requires that the tag GENERATE_HTML is set to YES.
1129
1130HTML_DYNAMIC_SECTIONS = NO
1131
1132# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1133# shown in the various tree structured indices initially; the user can expand
1134# and collapse entries dynamically later on. Doxygen will expand the tree to
1135# such a level that at most the specified number of entries are visible (unless
1136# a fully collapsed tree already exceeds this amount). So setting the number of
1137# entries 1 will produce a full collapsed tree by default. 0 is a special value
1138# representing an infinite number of entries and will result in a full expanded
1139# tree by default.
1140# Minimum value: 0, maximum value: 9999, default value: 100.
1141# This tag requires that the tag GENERATE_HTML is set to YES.
1142
1143HTML_INDEX_NUM_ENTRIES = 100
1144
1145# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1146# generated that can be used as input for Apple's Xcode 3 integrated development
1147# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1148# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1149# Makefile in the HTML output directory. Running make will produce the docset in
1150# that directory and running make install will install the docset in
1151# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1152# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1153# for more information.
1154# The default value is: NO.
1155# This tag requires that the tag GENERATE_HTML is set to YES.
1156
1157GENERATE_DOCSET = NO
1158
1159# This tag determines the name of the docset feed. A documentation feed provides
1160# an umbrella under which multiple documentation sets from a single provider
1161# (such as a company or product suite) can be grouped.
1162# The default value is: Doxygen generated docs.
1163# This tag requires that the tag GENERATE_DOCSET is set to YES.
1164
1165DOCSET_FEEDNAME = "Doxygen generated docs"
1166
1167# This tag specifies a string that should uniquely identify the documentation
1168# set bundle. This should be a reverse domain-name style string, e.g.
1169# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1170# The default value is: org.doxygen.Project.
1171# This tag requires that the tag GENERATE_DOCSET is set to YES.
1172
1173DOCSET_BUNDLE_ID = org.doxygen.Project
1174
1175# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1176# the documentation publisher. This should be a reverse domain-name style
1177# string, e.g. com.mycompany.MyDocSet.documentation.
1178# The default value is: org.doxygen.Publisher.
1179# This tag requires that the tag GENERATE_DOCSET is set to YES.
1180
1181DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1182
1183# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1184# The default value is: Publisher.
1185# This tag requires that the tag GENERATE_DOCSET is set to YES.
1186
1187DOCSET_PUBLISHER_NAME = Publisher
1188
1189# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1190# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1191# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1192# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1193# Windows.
1194#
1195# The HTML Help Workshop contains a compiler that can convert all HTML output
1196# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1197# files are now used as the Windows 98 help format, and will replace the old
1198# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1199# HTML files also contain an index, a table of contents, and you can search for
1200# words in the documentation. The HTML workshop also contains a viewer for
1201# compressed HTML files.
1202# The default value is: NO.
1203# This tag requires that the tag GENERATE_HTML is set to YES.
5501204
551GENERATE_HTMLHELP = NO1205GENERATE_HTMLHELP = NO
5521206
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
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
555# can add a path in front of the file if the result should not be 1209# written to the html output directory.
556# written to the html output dir.1210# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
5571211
558CHM_FILE = 1212CHM_FILE =
5591213
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
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
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.
563# the HTML help compiler on the generated index.hhp.1217# The file has to be specified with full path.
5641218# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
565HHC_LOCATION = 1219
5661220HHC_LOCATION =
567# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1221
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 (
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).
1224# The default value is: NO.
1225# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
5701226
571GENERATE_CHI = NO1227GENERATE_CHI = NO
5721228
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)
574# controls whether a binary table of contents is generated (YES) or a 1230# and project file content.
575# normal table of contents (NO) in the .chm file.1231# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1232
1233CHM_INDEX_ENCODING =
1234
1235# The BINARY_TOC flag controls whether a binary table of contents is generated (
1236# YES) or a normal table of contents ( NO) in the .chm file.
1237# The default value is: NO.
1238# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
5761239
577BINARY_TOC = NO1240BINARY_TOC = NO
5781241
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
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.
1244# The default value is: NO.
1245# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
5811246
582TOC_EXPAND = YES1247TOC_EXPAND = YES
5831248
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
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
586# the value YES disables it.1251# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1252# (.qch) of the generated HTML documentation.
1253# The default value is: NO.
1254# This tag requires that the tag GENERATE_HTML is set to YES.
1255
1256GENERATE_QHP = NO
1257
1258# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1259# the file name of the resulting .qch file. The path specified is relative to
1260# the HTML output folder.
1261# This tag requires that the tag GENERATE_QHP is set to YES.
1262
1263QCH_FILE =
1264
1265# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1266# Project output. For more information please see Qt Help Project / Namespace
1267# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1268# The default value is: org.doxygen.Project.
1269# This tag requires that the tag GENERATE_QHP is set to YES.
1270
1271QHP_NAMESPACE = org.doxygen.Project
1272
1273# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1274# Help Project output. For more information please see Qt Help Project / Virtual
1275# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1276# folders).
1277# The default value is: doc.
1278# This tag requires that the tag GENERATE_QHP is set to YES.
1279
1280QHP_VIRTUAL_FOLDER = doc
1281
1282# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1283# filter to add. For more information please see Qt Help Project / Custom
1284# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1285# filters).
1286# This tag requires that the tag GENERATE_QHP is set to YES.
1287
1288QHP_CUST_FILTER_NAME =
1289
1290# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1291# custom filter to add. For more information please see Qt Help Project / Custom
1292# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1293# filters).
1294# This tag requires that the tag GENERATE_QHP is set to YES.
1295
1296QHP_CUST_FILTER_ATTRS =
1297
1298# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1299# project's filter section matches. Qt Help Project / Filter Attributes (see:
1300# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1301# This tag requires that the tag GENERATE_QHP is set to YES.
1302
1303QHP_SECT_FILTER_ATTRS =
1304
1305# The QHG_LOCATION tag can be used to specify the location of Qt's
1306# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1307# generated .qhp file.
1308# This tag requires that the tag GENERATE_QHP is set to YES.
1309
1310QHG_LOCATION =
1311
1312# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1313# generated, together with the HTML files, they form an Eclipse help plugin. To
1314# install this plugin and make it available under the help contents menu in
1315# Eclipse, the contents of the directory containing the HTML and XML files needs
1316# to be copied into the plugins directory of eclipse. The name of the directory
1317# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1318# After copying Eclipse needs to be restarted before the help appears.
1319# The default value is: NO.
1320# This tag requires that the tag GENERATE_HTML is set to YES.
1321
1322GENERATE_ECLIPSEHELP = NO
1323
1324# A unique identifier for the Eclipse help plugin. When installing the plugin
1325# the directory name containing the HTML and XML files should also have this
1326# name. Each documentation set should have its own identifier.
1327# The default value is: org.doxygen.Project.
1328# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1329
1330ECLIPSE_DOC_ID = org.doxygen.Project
1331
1332# If you want full control over the layout of the generated HTML pages it might
1333# be necessary to disable the index and replace it with your own. The
1334# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1335# of each HTML page. A value of NO enables the index and the value YES disables
1336# it. Since the tabs in the index contain the same information as the navigation
1337# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1338# The default value is: NO.
1339# This tag requires that the tag GENERATE_HTML is set to YES.
5871340
588DISABLE_INDEX = NO1341DISABLE_INDEX = NO
5891342
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
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
1345# value is set to YES, a side panel will be generated containing a tree-like
1346# index structure (just like the one that is generated for HTML Help). For this
1347# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1348# (i.e. any modern browser). Windows users are probably better off using the
1349# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1350# further fine-tune the look of the index. As an example, the default style
1351# sheet generated by doxygen has an example that shows how to put an image at
1352# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1353# the same information as the tab index, you could consider setting
1354# DISABLE_INDEX to YES when enabling this option.
1355# The default value is: NO.
1356# This tag requires that the tag GENERATE_HTML is set to YES.
1357
1358GENERATE_TREEVIEW = NO
1359
1360# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1361# doxygen will group on one line in the generated HTML documentation.
1362#
1363# Note that a value of 0 will completely suppress the enum values from appearing
1364# in the overview section.
1365# Minimum value: 0, maximum value: 20, default value: 4.
1366# This tag requires that the tag GENERATE_HTML is set to YES.
5921367
593ENUM_VALUES_PER_LINE = 41368ENUM_VALUES_PER_LINE = 4
5941369
595# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be1370# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
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.
597# is generated for HTML Help). For this to work a browser that supports 1372# Minimum value: 0, maximum value: 1500, default value: 250.
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.
599# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
600# probably better off using the HTML help feature.
601
602GENERATE_TREEVIEW = NO
603
604# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
605# used to set the initial width (in pixels) of the frame in which the tree
606# is shown.
6071374
608TREEVIEW_WIDTH = 2501375TREEVIEW_WIDTH = 250
6091376
610#---------------------------------------------------------------------------1377# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
611# configuration options related to the LaTeX output1378# external symbols imported via tag files in a separate window.
612#---------------------------------------------------------------------------1379# The default value is: NO.
6131380# This tag requires that the tag GENERATE_HTML is set to YES.
614# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1381
615# generate Latex output.1382EXT_LINKS_IN_WINDOW = NO
1383
1384# Use this tag to change the font size of LaTeX formulas included as images in
1385# the HTML documentation. When you change the font size after a successful
1386# doxygen run you need to manually remove any form_*.png images from the HTML
1387# output directory to force them to be regenerated.
1388# Minimum value: 8, maximum value: 50, default value: 10.
1389# This tag requires that the tag GENERATE_HTML is set to YES.
1390
1391FORMULA_FONTSIZE = 10
1392
1393# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1394# generated for formulas are transparent PNGs. Transparent PNGs are not
1395# supported properly for IE 6.0, but are supported on all modern browsers.
1396#
1397# Note that when changing this option you need to delete any form_*.png files in
1398# the HTML output directory before the changes have effect.
1399# The default value is: YES.
1400# This tag requires that the tag GENERATE_HTML is set to YES.
1401
1402FORMULA_TRANSPARENT = YES
1403
1404# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1405# http://www.mathjax.org) which uses client side Javascript for the rendering
1406# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1407# installed or if you want to formulas look prettier in the HTML output. When
1408# enabled you may also need to install MathJax separately and configure the path
1409# to it using the MATHJAX_RELPATH option.
1410# The default value is: NO.
1411# This tag requires that the tag GENERATE_HTML is set to YES.
1412
1413USE_MATHJAX = NO
1414
1415# When MathJax is enabled you can set the default output format to be used for
1416# the MathJax output. See the MathJax site (see:
1417# http://docs.mathjax.org/en/latest/output.html) for more details.
1418# Possible values are: HTML-CSS (which is slower, but has the best
1419# compatibility), NativeMML (i.e. MathML) and SVG.
1420# The default value is: HTML-CSS.
1421# This tag requires that the tag USE_MATHJAX is set to YES.
1422
1423MATHJAX_FORMAT = HTML-CSS
1424
1425# When MathJax is enabled you need to specify the location relative to the HTML
1426# output directory using the MATHJAX_RELPATH option. The destination directory
1427# should contain the MathJax.js script. For instance, if the mathjax directory
1428# is located at the same level as the HTML output directory, then
1429# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1430# Content Delivery Network so you can quickly see the result without installing
1431# MathJax. However, it is strongly recommended to install a local copy of
1432# MathJax from http://www.mathjax.org before deployment.
1433# The default value is: http://cdn.mathjax.org/mathjax/latest.
1434# This tag requires that the tag USE_MATHJAX is set to YES.
1435
1436MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1437
1438# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1439# extension names that should be enabled during MathJax rendering. For example
1440# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1441# This tag requires that the tag USE_MATHJAX is set to YES.
1442
1443MATHJAX_EXTENSIONS =
1444
1445# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1446# of code that will be used on startup of the MathJax code. See the MathJax site
1447# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1448# example see the documentation.
1449# This tag requires that the tag USE_MATHJAX is set to YES.
1450
1451MATHJAX_CODEFILE =
1452
1453# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1454# the HTML output. The underlying search engine uses javascript and DHTML and
1455# should work on any modern browser. Note that when using HTML help
1456# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1457# there is already a search function so this one should typically be disabled.
1458# For large projects the javascript based search engine can be slow, then
1459# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1460# search using the keyboard; to jump to the search box use <access key> + S
1461# (what the <access key> is depends on the OS and browser, but it is typically
1462# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1463# key> to jump into the search results window, the results can be navigated
1464# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1465# the search. The filter options can be selected when the cursor is inside the
1466# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1467# to select a filter and <Enter> or <escape> to activate or cancel the filter
1468# option.
1469# The default value is: YES.
1470# This tag requires that the tag GENERATE_HTML is set to YES.
1471
1472SEARCHENGINE = NO
1473
1474# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1475# implemented using a web server instead of a web client using Javascript. There
1476# are two flavours of web server based searching depending on the
1477# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1478# searching and an index file used by the script. When EXTERNAL_SEARCH is
1479# enabled the indexing and searching needs to be provided by external tools. See
1480# the section "External Indexing and Searching" for details.
1481# The default value is: NO.
1482# This tag requires that the tag SEARCHENGINE is set to YES.
1483
1484SERVER_BASED_SEARCH = NO
1485
1486# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1487# script for searching. Instead the search results are written to an XML file
1488# which needs to be processed by an external indexer. Doxygen will invoke an
1489# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1490# search results.
1491#
1492# Doxygen ships with an example indexer ( doxyindexer) and search engine
1493# (doxysearch.cgi) which are based on the open source search engine library
1494# Xapian (see: http://xapian.org/).
1495#
1496# See the section "External Indexing and Searching" for details.
1497# The default value is: NO.
1498# This tag requires that the tag SEARCHENGINE is set to YES.
1499
1500EXTERNAL_SEARCH = NO
1501
1502# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1503# which will return the search results when EXTERNAL_SEARCH is enabled.
1504#
1505# Doxygen ships with an example indexer ( doxyindexer) and search engine
1506# (doxysearch.cgi) which are based on the open source search engine library
1507# Xapian (see: http://xapian.org/). See the section "External Indexing and
1508# Searching" for details.
1509# This tag requires that the tag SEARCHENGINE is set to YES.
1510
1511SEARCHENGINE_URL =
1512
1513# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1514# search data is written to a file for indexing by an external tool. With the
1515# SEARCHDATA_FILE tag the name of this file can be specified.
1516# The default file is: searchdata.xml.
1517# This tag requires that the tag SEARCHENGINE is set to YES.
1518
1519SEARCHDATA_FILE = searchdata.xml
1520
1521# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1522# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1523# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1524# projects and redirect the results back to the right project.
1525# This tag requires that the tag SEARCHENGINE is set to YES.
1526
1527EXTERNAL_SEARCH_ID =
1528
1529# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1530# projects other than the one defined by this configuration file, but that are
1531# all added to the same external search index. Each project needs to have a
1532# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1533# to a relative location where the documentation can be found. The format is:
1534# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1535# This tag requires that the tag SEARCHENGINE is set to YES.
1536
1537EXTRA_SEARCH_MAPPINGS =
1538
1539#---------------------------------------------------------------------------
1540# Configuration options related to the LaTeX output
1541#---------------------------------------------------------------------------
1542
1543# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1544# The default value is: YES.
6161545
617GENERATE_LATEX = NO1546GENERATE_LATEX = NO
6181547
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
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
621# put in front of it. If left blank `latex' will be used as the default path.1550# it.
1551# The default directory is: latex.
1552# This tag requires that the tag GENERATE_LATEX is set to YES.
6221553
623LATEX_OUTPUT = latex1554LATEX_OUTPUT = latex
6241555
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
626# invoked. If left blank `latex' will be used as the default command name.1557# invoked.
1558#
1559# Note that when enabling USE_PDFLATEX this option is only used for generating
1560# bitmaps for formulas in the HTML output, but not in the Makefile that is
1561# written to the output directory.
1562# The default file is: latex.
1563# This tag requires that the tag GENERATE_LATEX is set to YES.
6271564
628LATEX_CMD_NAME = latex1565LATEX_CMD_NAME = latex
6291566
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
631# generate index for LaTeX. If left blank `makeindex' will be used as the 1568# index for LaTeX.
632# default command name.1569# The default file is: makeindex.
1570# This tag requires that the tag GENERATE_LATEX is set to YES.
6331571
634MAKEINDEX_CMD_NAME = makeindex1572MAKEINDEX_CMD_NAME = makeindex
6351573
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
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
638# save some trees in general.1576# trees in general.
1577# The default value is: NO.
1578# This tag requires that the tag GENERATE_LATEX is set to YES.
6391579
640COMPACT_LATEX = NO1580COMPACT_LATEX = NO
6411581
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
643# by the printer. Possible values are: a4, a4wide, letter, legal and 1583# printer.
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
1585# 14 inches) and executive (7.25 x 10.5 inches).
1586# The default value is: a4.
1587# This tag requires that the tag GENERATE_LATEX is set to YES.
6451588
646PAPER_TYPE = a4wide1589PAPER_TYPE = a4wide
6471590
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
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
6501593# instance you can specify
651EXTRA_PACKAGES = 1594# EXTRA_PACKAGES=times
6521595# If left blank no extra packages will be included.
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.
654# the generated latex document. The header should contain everything until 1597
655# the first chapter. If it is left blank doxygen will generate a 1598EXTRA_PACKAGES =
656# standard header. Notice: only use this tag if you know what you are doing!1599
6571600# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
658LATEX_HEADER = 1601# generated LaTeX document. The header should contain everything until the first
6591602# chapter. If it is left blank doxygen will generate a standard header. See
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
661# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1604# default header to a separate file.
662# contain links (just like the HTML output) instead of page references 1605#
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
1607# following commands have a special meaning inside the header: $title,
1608# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1609# replace them by respectively the title of the page, the current date and time,
1610# only the current date, the version number of doxygen, the project name (see
1611# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1612# This tag requires that the tag GENERATE_LATEX is set to YES.
1613
1614LATEX_HEADER =
1615
1616# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1617# generated LaTeX document. The footer should contain everything after the last
1618# chapter. If it is left blank doxygen will generate a standard footer.
1619#
1620# Note: Only use a user-defined footer if you know what you are doing!
1621# This tag requires that the tag GENERATE_LATEX is set to YES.
1622
1623LATEX_FOOTER =
1624
1625# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1626# other source files which should be copied to the LATEX_OUTPUT output
1627# directory. Note that the files will be copied as-is; there are no commands or
1628# markers available.
1629# This tag requires that the tag GENERATE_LATEX is set to YES.
1630
1631LATEX_EXTRA_FILES =
1632
1633# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1634# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1635# contain links (just like the HTML output) instead of page references. This
1636# makes the output suitable for online browsing using a PDF viewer.
1637# The default value is: YES.
1638# This tag requires that the tag GENERATE_LATEX is set to YES.
6641639
665PDF_HYPERLINKS = NO1640PDF_HYPERLINKS = NO
6661641
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
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
669# higher quality PDF documentation.1644# higher quality PDF documentation.
1645# The default value is: YES.
1646# This tag requires that the tag GENERATE_LATEX is set to YES.
6701647
671USE_PDFLATEX = NO1648USE_PDFLATEX = NO
6721649
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
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
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
676# This option is also used when generating formulas in HTML.1653# when generating formulas in HTML.
1654# The default value is: NO.
1655# This tag requires that the tag GENERATE_LATEX is set to YES.
6771656
678LATEX_BATCHMODE = NO1657LATEX_BATCHMODE = NO
6791658
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
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.
682# in the output.1661# The default value is: NO.
1662# This tag requires that the tag GENERATE_LATEX is set to YES.
6831663
684LATEX_HIDE_INDICES = NO1664LATEX_HIDE_INDICES = NO
6851665
686#---------------------------------------------------------------------------1666# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
687# configuration options related to the RTF output1667# code with syntax highlighting in the LaTeX output.
688#---------------------------------------------------------------------------1668#
6891669# Note that which sources are shown also depends on other settings such as
690# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1670# SOURCE_BROWSER.
691# The RTF output is optimised for Word 97 and may not look very pretty with 1671# The default value is: NO.
692# other RTF readers or editors.1672# This tag requires that the tag GENERATE_LATEX is set to YES.
1673
1674LATEX_SOURCE_CODE = NO
1675
1676# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1677# bibliography, e.g. plainnat, or ieeetr. See
1678# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1679# The default value is: plain.
1680# This tag requires that the tag GENERATE_LATEX is set to YES.
1681
1682LATEX_BIB_STYLE = plain
1683
1684#---------------------------------------------------------------------------
1685# Configuration options related to the RTF output
1686#---------------------------------------------------------------------------
1687
1688# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1689# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1690# readers/editors.
1691# The default value is: NO.
6931692
694GENERATE_RTF = NO1693GENERATE_RTF = NO
6951694
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
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
698# put in front of it. If left blank `rtf' will be used as the default path.1697# it.
1698# The default directory is: rtf.
1699# This tag requires that the tag GENERATE_RTF is set to YES.
6991700
700RTF_OUTPUT = rtf1701RTF_OUTPUT = rtf
7011702
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
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
704# save some trees in general.1705# trees in general.
1706# The default value is: NO.
1707# This tag requires that the tag GENERATE_RTF is set to YES.
7051708
706COMPACT_RTF = NO1709COMPACT_RTF = NO
7071710
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
709# will contain hyperlink fields. The RTF file will 1712# contain hyperlink fields. The RTF file will contain links (just like the HTML
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
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
712# programs which support those fields. 1715# fields.
713# Note: wordpad (write) and others do not support links.1716#
1717# Note: WordPad (write) and others do not support links.
1718# The default value is: NO.
1719# This tag requires that the tag GENERATE_RTF is set to YES.
7141720
715RTF_HYPERLINKS = NO1721RTF_HYPERLINKS = NO
7161722
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
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,
719# replacements, missing definitions are set to their default value.1725# missing definitions are set to their default value.
7201726#
721RTF_STYLESHEET_FILE = 1727# See also section "Doxygen usage" for information on how to generate the
7221728# default style sheet that doxygen normally uses.
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.
724# Syntax is similar to doxygen's config file.1730
7251731RTF_STYLESHEET_FILE =
726RTF_EXTENSIONS_FILE = 1732
7271733# Set optional variables used in the generation of an RTF document. Syntax is
728#---------------------------------------------------------------------------1734# similar to doxygen's config file. A template extensions file can be generated
729# configuration options related to the man page output1735# using doxygen -e rtf extensionFile.
730#---------------------------------------------------------------------------1736# This tag requires that the tag GENERATE_RTF is set to YES.
7311737
732# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1738RTF_EXTENSIONS_FILE =
733# generate man pages1739
1740#---------------------------------------------------------------------------
1741# Configuration options related to the man page output
1742#---------------------------------------------------------------------------
1743
1744# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1745# classes and files.
1746# The default value is: NO.
7341747
735GENERATE_MAN = NO1748GENERATE_MAN = NO
7361749
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
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
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
1753# MAN_OUTPUT.
1754# The default directory is: man.
1755# This tag requires that the tag GENERATE_MAN is set to YES.
7401756
741MAN_OUTPUT = man1757MAN_OUTPUT = man
7421758
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
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
1761# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1762# optional.
1763# The default value is: .3.
1764# This tag requires that the tag GENERATE_MAN is set to YES.
7451765
746MAN_EXTENSION = .31766MAN_EXTENSION = .3
7471767
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
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
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
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.
752# would be unable to find the correct page. The default is NO.1772# The default value is: NO.
1773# This tag requires that the tag GENERATE_MAN is set to YES.
7531774
754MAN_LINKS = NO1775MAN_LINKS = NO
7551776
756#---------------------------------------------------------------------------1777#---------------------------------------------------------------------------
757# configuration options related to the XML output1778# Configuration options related to the XML output
758#---------------------------------------------------------------------------1779#---------------------------------------------------------------------------
7591780
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
761# generate an XML file that captures the structure of 1782# captures the structure of the code including all documentation.
762# the code including all documentation. Note that this 1783# The default value is: NO.
763# feature is still experimental and incomplete at the
764# moment.
7651784
766GENERATE_XML = NO1785GENERATE_XML = NO
7671786
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
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
770# put in front of it. If left blank `xml' will be used as the default path.1789# it.
1790# The default directory is: xml.
1791# This tag requires that the tag GENERATE_XML is set to YES.
7711792
772XML_OUTPUT = xml1793XML_OUTPUT = xml
7731794
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
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.
776# syntax of the XML files.1797# This tag requires that the tag GENERATE_XML is set to YES.
7771798
778XML_SCHEMA = 1799XML_SCHEMA =
7791800
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
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.
782# syntax of the XML files.1803# This tag requires that the tag GENERATE_XML is set to YES.
7831804
784XML_DTD = 1805XML_DTD =
7851806
786#---------------------------------------------------------------------------1807# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
787# configuration options for the AutoGen Definitions output1808# listings (including syntax highlighting and cross-referencing information) to
788#---------------------------------------------------------------------------1809# the XML output. Note that enabling this will significantly increase the size
7891810# of the XML output.
790# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1811# The default value is: YES.
791# generate an AutoGen Definitions (see autogen.sf.net) file 1812# This tag requires that the tag GENERATE_XML is set to YES.
792# that captures the structure of the code including all 1813
793# documentation. Note that this feature is still experimental 1814XML_PROGRAMLISTING = YES
794# and incomplete at the moment.1815
1816#---------------------------------------------------------------------------
1817# Configuration options related to the DOCBOOK output
1818#---------------------------------------------------------------------------
1819
1820# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1821# that can be used to generate PDF.
1822# The default value is: NO.
1823
1824GENERATE_DOCBOOK = NO
1825
1826# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1827# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1828# front of it.
1829# The default directory is: docbook.
1830# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1831
1832DOCBOOK_OUTPUT = docbook
1833
1834#---------------------------------------------------------------------------
1835# Configuration options for the AutoGen Definitions output
1836#---------------------------------------------------------------------------
1837
1838# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1839# Definitions (see http://autogen.sf.net) file that captures the structure of
1840# the code including all documentation. Note that this feature is still
1841# experimental and incomplete at the moment.
1842# The default value is: NO.
7951843
796GENERATE_AUTOGEN_DEF = NO1844GENERATE_AUTOGEN_DEF = NO
7971845
798#---------------------------------------------------------------------------1846#---------------------------------------------------------------------------
799# configuration options related to the Perl module output1847# Configuration options related to the Perl module output
800#---------------------------------------------------------------------------1848#---------------------------------------------------------------------------
8011849
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
803# generate a Perl module file that captures the structure of 1851# file that captures the structure of the code including all documentation.
804# the code including all documentation. Note that this 1852#
805# feature is still experimental and incomplete at the 1853# Note that this feature is still experimental and incomplete at the moment.
806# moment.1854# The default value is: NO.
8071855
808GENERATE_PERLMOD = NO1856GENERATE_PERLMOD = NO
8091857
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
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
812# to generate PDF and DVI output from the Perl module output.1860# output from the Perl module output.
1861# The default value is: NO.
1862# This tag requires that the tag GENERATE_PERLMOD is set to YES.
8131863
814PERLMOD_LATEX = NO1864PERLMOD_LATEX = NO
8151865
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
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
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
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
820# and Perl will parse it just the same.1870# just the same.
1871# The default value is: YES.
1872# This tag requires that the tag GENERATE_PERLMOD is set to YES.
8211873
822PERLMOD_PRETTY = YES1874PERLMOD_PRETTY = YES
8231875
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
825# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1877# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
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
827# Makefile don't overwrite each other's variables.1879# overwrite each other's variables.
8281880# This tag requires that the tag GENERATE_PERLMOD is set to YES.
829PERLMOD_MAKEVAR_PREFIX = 1881
8301882PERLMOD_MAKEVAR_PREFIX =
831#---------------------------------------------------------------------------1883
832# Configuration options related to the preprocessor 1884#---------------------------------------------------------------------------
833#---------------------------------------------------------------------------1885# Configuration options related to the preprocessor
8341886#---------------------------------------------------------------------------
835# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1887
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
837# files.1889# C-preprocessor directives found in the sources and include files.
1890# The default value is: YES.
8381891
839ENABLE_PREPROCESSING = YES1892ENABLE_PREPROCESSING = YES
8401893
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
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
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
844# way by setting EXPAND_ONLY_PREDEF to YES.1897# EXPAND_ONLY_PREDEF to YES.
1898# The default value is: NO.
1899# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8451900
846MACRO_EXPANSION = NO1901MACRO_EXPANSION = NO
8471902
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
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
850# PREDEFINED and EXPAND_AS_PREDEFINED tags.1905# EXPAND_AS_DEFINED tags.
1906# The default value is: NO.
1907# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8511908
852EXPAND_ONLY_PREDEF = NO1909EXPAND_ONLY_PREDEF = NO
8531910
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
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.
1913# The default value is: YES.
1914# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8561915
857SEARCH_INCLUDES = YES1916SEARCH_INCLUDES = YES
8581917
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
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
861# the preprocessor.1920# preprocessor.
1921# This tag requires that the tag SEARCH_INCLUDES is set to YES.
8621922
863INCLUDE_PATH = ../include/1923INCLUDE_PATH = ../include/
8641924
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
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
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
868# be used.1928# used.
1929# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8691930
870INCLUDE_FILE_PATTERNS = *.h1931INCLUDE_FILE_PATTERNS = *.h
8711932
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
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.
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
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"
876# omitted =1 is assumed.1937# is assumed. To prevent a macro definition from being undefined via #undef or
8771938# recursively expanded use the := operator instead of the = operator.
878PREDEFINED = 1939# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8791940
880# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1941PREDEFINED =
881# this tag can be used to specify a list of macro names that should be expanded. 1942
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
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
8841945# macro definition that is found in the sources will be used. Use the PREDEFINED
885EXPAND_AS_DEFINED = 1946# tag if you want to use a different macro definition that overrules the
8861947# definition found in the source code.
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.
888# doxygen's preprocessor will remove all function-like macros that are alone 1949
889# on a line, have an all uppercase name, and do not end with a semicolon. Such 1950EXPAND_AS_DEFINED =
890# function macros are typically used for boiler-plate code, and will confuse the 1951
891# parser if not removed.1952# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1953# remove all refrences to function-like macros that are alone on a line, have an
1954# all uppercase name, and do not end with a semicolon. Such function macros are
1955# typically used for boiler-plate code, and will confuse the parser if not
1956# removed.
1957# The default value is: YES.
1958# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8921959
893SKIP_FUNCTION_MACROS = YES1960SKIP_FUNCTION_MACROS = YES
8941961
895#---------------------------------------------------------------------------1962#---------------------------------------------------------------------------
896# Configuration::addtions related to external references 1963# Configuration options related to external references
897#---------------------------------------------------------------------------1964#---------------------------------------------------------------------------
8981965
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
900# Optionally an initial location of the external documentation 1967# file the location of the external documentation should be added. The format of
901# can be added for each tagfile. The format of a tag file without 1968# a tag file without this location is as follows:
902# this location is as follows: 1969# TAGFILES = file1 file2 ...
903# TAGFILES = file1 file2 ... 1970# Adding location for the tag files is done as follows:
904# Adding location for the tag files is done as follows: 1971# TAGFILES = file1=loc1 "file2 = loc2" ...
905# TAGFILES = file1=loc1 "file2 = loc2" ... 1972# where loc1 and loc2 can be relative or absolute paths or URLs. See the
906# where "loc1" and "loc2" can be relative or absolute paths or 1973# section "Linking to external documentation" for more information about the use
907# URLs. If a location is present for each tag, the installdox tool 1974# of tag files.
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
909# Note that each tag file must have a unique name1976# the path). If a tag file is not located in the directory in which doxygen is
910# (where the name does NOT include the path)1977# run, you must also specify the path to the tagfile here.
911# If a tag file is not located in the directory in which doxygen 1978
912# is run, you must also specify the path to the tagfile here.1979TAGFILES =
9131980
914TAGFILES = 1981# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
9151982# tag file that is based on the input files it reads. See section "Linking to
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.
917# a tag file that is based on the input files it reads.1984
9181985GENERATE_TAGFILE =
919GENERATE_TAGFILE = 1986
9201987# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
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.
922# in the class index. If set to NO only the inherited external classes 1989# The default value is: NO.
923# will be listed.
9241990
925ALLEXTERNALS = NO1991ALLEXTERNALS = NO
9261992
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
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
1995# listed.
1996# The default value is: YES.
1997
1998EXTERNAL_GROUPS = YES
1999
2000# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2001# the related pages index. If set to NO, only the current project's pages will
929# be listed.2002# be listed.
9302003# The default value is: YES.
931EXTERNAL_GROUPS = YES2004
9322005EXTERNAL_PAGES = YES
933# The PERL_PATH should be the absolute path and name of the perl script 2006
934# interpreter (i.e. the result of `which perl').2007# The PERL_PATH should be the absolute path and name of the perl script
2008# interpreter (i.e. the result of 'which perl').
2009# The default file (with absolute path) is: /usr/bin/perl.
9352010
936PERL_PATH = /usr/bin/perl2011PERL_PATH = /usr/bin/perl
9372012
938#---------------------------------------------------------------------------2013#---------------------------------------------------------------------------
939# Configuration options related to the dot tool 2014# Configuration options related to the dot tool
940#---------------------------------------------------------------------------2015#---------------------------------------------------------------------------
9412016
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
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
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
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
946# recommended to install and use dot, since it yields more powerful graphs.2021# powerful graphs.
2022# The default value is: YES.
9472023
948CLASS_DIAGRAMS = YES2024CLASS_DIAGRAMS = YES
9492025
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
951# inheritance and usage relations if the target is undocumented 2027# command. Doxygen will then run the mscgen tool (see:
952# or is not a class.2028# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2029# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2030# the mscgen tool resides. If left empty the tool is assumed to be found in the
2031# default search path.
2032
2033MSCGEN_PATH =
2034
2035# You can include diagrams made with dia in doxygen documentation. Doxygen will
2036# then run dia to produce the diagram and insert it in the documentation. The
2037# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2038# If left empty dia is assumed to be found in the default search path.
2039
2040DIA_PATH =
2041
2042# If set to YES, the inheritance and collaboration graphs will hide inheritance
2043# and usage relations if the target is undocumented or is not a class.
2044# The default value is: YES.
9532045
954HIDE_UNDOC_RELATIONS = YES2046HIDE_UNDOC_RELATIONS = YES
9552047
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
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:
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
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
2052# set to NO
2053# The default value is: NO.
9602054
961HAVE_DOT = NO2055HAVE_DOT = NO
9622056
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
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
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
966# the CLASS_DIAGRAMS tag to NO.2060# larger than 0 to get control over the balance between CPU load and processing
2061# speed.
2062# Minimum value: 0, maximum value: 32, default value: 0.
2063# This tag requires that the tag HAVE_DOT is set to YES.
2064
2065DOT_NUM_THREADS = 0
2066
2067# When you want a differently looking font n the dot files that doxygen
2068# generates you can specify the font name using DOT_FONTNAME. You need to make
2069# sure dot is able to find the font, which can be done by putting it in a
2070# standard location or by setting the DOTFONTPATH environment variable or by
2071# setting DOT_FONTPATH to the directory containing the font.
2072# The default value is: Helvetica.
2073# This tag requires that the tag HAVE_DOT is set to YES.
2074
2075DOT_FONTNAME = Helvetica
2076
2077# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2078# dot graphs.
2079# Minimum value: 4, maximum value: 24, default value: 10.
2080# This tag requires that the tag HAVE_DOT is set to YES.
2081
2082DOT_FONTSIZE = 10
2083
2084# By default doxygen will tell dot to use the default font as specified with
2085# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2086# the path where dot can find it using this tag.
2087# This tag requires that the tag HAVE_DOT is set to YES.
2088
2089DOT_FONTPATH =
2090
2091# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2092# each documented class showing the direct and indirect inheritance relations.
2093# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2094# The default value is: YES.
2095# This tag requires that the tag HAVE_DOT is set to YES.
9672096
968CLASS_GRAPH = YES2097CLASS_GRAPH = YES
9692098
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
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
972# indirect implementation dependencies (inheritance, containment, and 2101# dependencies (inheritance, containment, and class references variables) of the
973# class references variables) of the class with other documented classes.2102# class with other documented classes.
2103# The default value is: YES.
2104# This tag requires that the tag HAVE_DOT is set to YES.
9742105
975COLLABORATION_GRAPH = YES2106COLLABORATION_GRAPH = YES
9762107
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
978# collaboration diagrams in a style similiar to the OMG's Unified Modeling 2109# groups, showing the direct groups dependencies.
2110# The default value is: YES.
2111# This tag requires that the tag HAVE_DOT is set to YES.
2112
2113GROUP_GRAPHS = YES
2114
2115# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2116# collaboration diagrams in a style similar to the OMG's Unified Modeling
979# Language.2117# Language.
2118# The default value is: NO.
2119# This tag requires that the tag HAVE_DOT is set to YES.
9802120
981UML_LOOK = NO2121UML_LOOK = NO
9822122
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
984# relations between templates and their instances.2124# class node. If there are many fields or methods and many nodes the graph may
2125# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2126# number of items for each type to make the size more manageable. Set this to 0
2127# for no limit. Note that the threshold may be exceeded by 50% before the limit
2128# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2129# but if the number exceeds 15, the total amount of fields shown is limited to
2130# 10.
2131# Minimum value: 0, maximum value: 100, default value: 10.
2132# This tag requires that the tag HAVE_DOT is set to YES.
2133
2134UML_LIMIT_NUM_FIELDS = 10
2135
2136# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2137# collaboration graphs will show the relations between templates and their
2138# instances.
2139# The default value is: NO.
2140# This tag requires that the tag HAVE_DOT is set to YES.
9852141
986TEMPLATE_RELATIONS = NO2142TEMPLATE_RELATIONS = NO
9872143
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
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
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
991# other documented files.2147# files.
2148# The default value is: YES.
2149# This tag requires that the tag HAVE_DOT is set to YES.
9922150
993INCLUDE_GRAPH = YES2151INCLUDE_GRAPH = YES
9942152
995# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 2153# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
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
997# documented header file showing the documented files that directly or 2155# the direct and indirect include dependencies of the file with other documented
998# indirectly include this file.2156# files.
2157# The default value is: YES.
2158# This tag requires that the tag HAVE_DOT is set to YES.
9992159
1000INCLUDED_BY_GRAPH = YES2160INCLUDED_BY_GRAPH = YES
10012161
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
1003# generate a call dependency graph for every global function or class method. 2163# dependency graph for every global function or class method.
1004# Note that enabling this option will significantly increase the time of a run. 2164#
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.
2166# So in most cases it will be better to enable call graphs for selected
1006# functions only using the \callgraph command.2167# functions only using the \callgraph command.
2168# The default value is: NO.
2169# This tag requires that the tag HAVE_DOT is set to YES.
10072170
1008CALL_GRAPH = NO2171CALL_GRAPH = NO
10092172
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
1011# will graphical hierarchy of all classes instead of a textual one.2174# dependency graph for every global function or class method.
2175#
2176# Note that enabling this option will significantly increase the time of a run.
2177# So in most cases it will be better to enable caller graphs for selected
2178# functions only using the \callergraph command.
2179# The default value is: NO.
2180# This tag requires that the tag HAVE_DOT is set to YES.
2181
2182CALLER_GRAPH = NO
2183
2184# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2185# hierarchy of all classes instead of a textual one.
2186# The default value is: YES.
2187# This tag requires that the tag HAVE_DOT is set to YES.
10122188
1013GRAPHICAL_HIERARCHY = YES2189GRAPHICAL_HIERARCHY = YES
10142190
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
1016# generated by dot. Possible values are png, jpg, or gif2192# dependencies a directory has on other directories in a graphical way. The
1017# If left blank png will be used.2193# dependency relations are determined by the #include relations between the
2194# files in the directories.
2195# The default value is: YES.
2196# This tag requires that the tag HAVE_DOT is set to YES.
2197
2198DIRECTORY_GRAPH = YES
2199
2200# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2201# generated by dot.
2202# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2203# to make the SVG files visible in IE 9+ (other browsers do not have this
2204# requirement).
2205# Possible values are: png, jpg, gif and svg.
2206# The default value is: png.
2207# This tag requires that the tag HAVE_DOT is set to YES.
10182208
1019DOT_IMAGE_FORMAT = png2209DOT_IMAGE_FORMAT = png
10202210
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
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.
10232213#
1024DOT_PATH = 2214# Note that this requires a modern browser other than Internet Explorer. Tested
10252215# and working are Firefox, Chrome, Safari, and Opera.
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
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.
1028# \dotfile command).2218# The default value is: NO.
10292219# This tag requires that the tag HAVE_DOT is set to YES.
1030DOTFILE_DIRS = 2220
10312221INTERACTIVE_SVG = NO
1032# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 2222
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
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.
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.
1036# large images.2226
10372227DOT_PATH =
1038MAX_DOT_GRAPH_WIDTH = 10242228
10392229# The DOTFILE_DIRS tag can be used to specify one or more directories that
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
1041# (in pixels) of the graphs generated by dot. If a graph becomes larger than 2231# command).
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.
1043# the specified constraint. Beware that most browsers cannot cope with very 2233
1044# large images.2234DOTFILE_DIRS =
10452235
1046MAX_DOT_GRAPH_HEIGHT = 10242236# The MSCFILE_DIRS tag can be used to specify one or more directories that
10472237# contain msc files that are included in the documentation (see the \mscfile
1048# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 2238# command).
1049# graphs generated by dot. A depth value of 3 means that only nodes reachable 2239
1050# from the root by following a path via at most 3 edges will be shown. Nodes that 2240MSCFILE_DIRS =
1051# lay further from the root node will be omitted. Note that setting this option to 2241
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
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
1054# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 2244# command).
1055# If 0 is used for the depth value (the default), the graph is not depth-constrained.2245
2246DIAFILE_DIRS =
2247
2248# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2249# that will be shown in the graph. If the number of nodes in a graph becomes
2250# larger than this value, doxygen will truncate the graph, which is visualized
2251# by representing a node as a red box. Note that doxygen if the number of direct
2252# children of the root node in a graph is already larger than
2253# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2254# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2255# Minimum value: 0, maximum value: 10000, default value: 50.
2256# This tag requires that the tag HAVE_DOT is set to YES.
2257
2258DOT_GRAPH_MAX_NODES = 50
2259
2260# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2261# generated by dot. A depth value of 3 means that only nodes reachable from the
2262# root by following a path via at most 3 edges will be shown. Nodes that lay
2263# further from the root node will be omitted. Note that setting this option to 1
2264# or 2 may greatly reduce the computation time needed for large code bases. Also
2265# note that the size of a graph can be further restricted by
2266# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2267# Minimum value: 0, maximum value: 1000, default value: 0.
2268# This tag requires that the tag HAVE_DOT is set to YES.
10562269
1057MAX_DOT_GRAPH_DEPTH = 02270MAX_DOT_GRAPH_DEPTH = 0
10582271
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
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
1061# arrows in the dot generated graphs.2274# to support this out of the box.
2275#
2276# Warning: Depending on the platform used, enabling this option may lead to
2277# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2278# read).
2279# The default value is: NO.
2280# This tag requires that the tag HAVE_DOT is set to YES.
2281
2282DOT_TRANSPARENT = NO
2283
2284# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2285# files in one run (i.e. multiple -o and -T options on the command line). This
2286# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2287# this, this feature is disabled by default.
2288# The default value is: NO.
2289# This tag requires that the tag HAVE_DOT is set to YES.
2290
2291DOT_MULTI_TARGETS = YES
2292
2293# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2294# explaining the meaning of the various boxes and arrows in the dot generated
2295# graphs.
2296# The default value is: YES.
2297# This tag requires that the tag HAVE_DOT is set to YES.
10622298
1063GENERATE_LEGEND = YES2299GENERATE_LEGEND = YES
10642300
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
1066# remove the intermediate dot files that are used to generate 2302# files that are used to generate the various graphs.
1067# the various graphs.2303# The default value is: YES.
2304# This tag requires that the tag HAVE_DOT is set to YES.
10682305
1069DOT_CLEANUP = YES2306DOT_CLEANUP = YES
1070
1071#---------------------------------------------------------------------------
1072# Configuration::addtions related to the search engine
1073#---------------------------------------------------------------------------
1074
1075# The SEARCHENGINE tag specifies whether or not a search engine should be
1076# used. If set to NO the values of all tags below this one will be ignored.
1077
1078SEARCHENGINE = NO
10792307
=== added file 'include/debian-installer/system/efi.h'
--- include/debian-installer/system/efi.h 1970-01-01 00:00:00 +0000
+++ include/debian-installer/system/efi.h 2015-01-28 21:45:05 +0000
@@ -0,0 +1,34 @@
1/*
2 * efi.h
3 *
4 * Copyright (C) 2014 Ian Campbell <ijc@hellion.org.uk>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef DEBIAN_INSTALLER__SYSTEM__EFI_H
21#define DEBIAN_INSTALLER__SYSTEM__EFI_H
22
23/**
24 * @addtogroup di_system_utils
25 * @{
26 */
27
28/**
29 * Checks if ystem is EFI based.
30 */
31int di_system_is_efi(void);
32
33/** @} */
34#endif
035
=== modified file 'include/debian-installer/system/subarch.h'
--- include/debian-installer/system/subarch.h 2011-03-02 17:11:54 +0000
+++ include/debian-installer/system/subarch.h 2015-01-28 21:45:05 +0000
@@ -21,7 +21,7 @@
21#ifndef DEBIAN_INSTALLER__SYSTEM__SUBARCH_H21#ifndef DEBIAN_INSTALLER__SYSTEM__SUBARCH_H
22#define DEBIAN_INSTALLER__SYSTEM__SUBARCH_H22#define DEBIAN_INSTALLER__SYSTEM__SUBARCH_H
2323
24#ifdef __ARMEL__24#if defined(__ARMEL__)
25#define DI_SYSTEM_SUBARCH_CAN_GUESS 125#define DI_SYSTEM_SUBARCH_CAN_GUESS 1
26#endif26#endif
2727
2828
=== modified file 'src/system/Makefile.am'
--- src/system/Makefile.am 2014-01-27 13:53:58 +0000
+++ src/system/Makefile.am 2015-01-28 21:45:05 +0000
@@ -6,6 +6,7 @@
6libsystem_la_SOURCES = \6libsystem_la_SOURCES = \
7 devfs.c \7 devfs.c \
8 dpkg.c \8 dpkg.c \
9 efi.c \
9 packages.c \10 packages.c \
10 prebaseconfig.c \11 prebaseconfig.c \
11 utils.c12 utils.c
@@ -13,6 +14,7 @@
13EXTRA_libsystem_la_SOURCES = \14EXTRA_libsystem_la_SOURCES = \
14 subarch-generic.c \15 subarch-generic.c \
15 subarch-arm-linux.c \16 subarch-arm-linux.c \
17 subarch-arm64-linux.c \
16 subarch-armeb-linux.c \18 subarch-armeb-linux.c \
17 subarch-armel-linux.c \19 subarch-armel-linux.c \
18 subarch-armhf-linux.c \20 subarch-armhf-linux.c \
@@ -20,6 +22,7 @@
20 subarch-mips-linux.c \22 subarch-mips-linux.c \
21 subarch-mipsel-linux.c \23 subarch-mipsel-linux.c \
22 subarch-powerpc-linux.c \24 subarch-powerpc-linux.c \
25 subarch-ppc64-linux.c \
23 subarch-ppc64el-linux.c \26 subarch-ppc64el-linux.c \
24 subarch-sh4-linux.c \27 subarch-sh4-linux.c \
25 subarch-sparc-linux.c \28 subarch-sparc-linux.c \
2629
=== added file 'src/system/efi.c'
--- src/system/efi.c 1970-01-01 00:00:00 +0000
+++ src/system/efi.c 2015-01-28 21:45:05 +0000
@@ -0,0 +1,42 @@
1/*
2 * efi.c
3 *
4 * Copyright (C) 2012 Steve McIntyre <steve@einval.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
19 */
20
21#include <unistd.h>
22
23#include <debian-installer/system/efi.h>
24
25/* Are we on an EFI system? Check to see if /sys/firmware/efi
26 * exists */
27int di_system_is_efi(void)
28{
29 int ret = access("/sys/firmware/efi", R_OK);
30 if (ret == 0)
31 {
32 /* Have we been told to ignore EFI in partman-efi? */
33 ret = access("/var/lib/partman/ignore_uefi", R_OK);
34 if (ret == 0)
35 return 0;
36 else
37 return 1;
38 }
39 else
40 return 0;
41}
42
043
=== modified file 'src/system/subarch-arm-linux.c'
--- src/system/subarch-arm-linux.c 2014-03-20 13:49:35 +0000
+++ src/system/subarch-arm-linux.c 2015-01-28 21:45:05 +0000
@@ -12,12 +12,9 @@
12 char *ret;12 char *ret;
13};13};
1414
15/* Do not add new armhf platforms here */
15static const char *supported_generic_subarches[] = {16static const char *supported_generic_subarches[] = {
16 "armadaxp",
17 "dove",17 "dove",
18 "exynos5",
19 "generic",
20 "keystone",
21 "omap",18 "omap",
22 "omap4",19 "omap4",
23 "mx51",20 "mx51",
@@ -27,6 +24,7 @@
27};24};
2825
29static struct map map_hardware[] = {26static struct map map_hardware[] = {
27 /* armel */
30 { "Acorn-RiscPC" , "rpc" },28 { "Acorn-RiscPC" , "rpc" },
31 { "EBSA285" , "netwinder" },29 { "EBSA285" , "netwinder" },
32 { "Rebel-NetWinder" , "netwinder" },30 { "Rebel-NetWinder" , "netwinder" },
@@ -34,8 +32,6 @@
34 { "co-EBSA285" , "netwinder" },32 { "co-EBSA285" , "netwinder" },
35 { "Compaq-PersonalServer" , "netwinder" },33 { "Compaq-PersonalServer" , "netwinder" },
36 { "Freescale MX51 Babbage Board", "imx51" }, /* iMX51 reference hardware. */34 { "Freescale MX51 Babbage Board", "imx51" }, /* iMX51 reference hardware. */
37 { "Marvell Armada XP Development Board", "armadaxp" }, /* Marvell ArmadaXP development board SoC */
38 { "Marvell DB-MV88F6781-BP Development Board", "dove" }, /* Marvell Dove SoC */
39 { "ADS" , "ads" }, /* Matches only ADS boards. Put any exceptions before. */35 { "ADS" , "ads" }, /* Matches only ADS boards. Put any exceptions before. */
40 { "Applied Data Systems" , "ads" }, /* More ADS boards. */36 { "Applied Data Systems" , "ads" }, /* More ADS boards. */
41 { "HP t5325 Thin Client", "kirkwood" },37 { "HP t5325 Thin Client", "kirkwood" },
@@ -64,6 +60,8 @@
64 { "QNAP TS-409", "orion5x" },60 { "QNAP TS-409", "orion5x" },
65 { "HP Media Vault mv2120", "orion5x" },61 { "HP Media Vault mv2120", "orion5x" },
66 { "Buffalo Linkstation LiveV3 (LS-CHL)", "orion5x" },62 { "Buffalo Linkstation LiveV3 (LS-CHL)", "orion5x" },
63 { "Buffalo Linkstation LS-CHLv2", "kirkwood" }, /* aka: LS-CH1.0L */
64 { "Buffalo Linkstation LS-XHL", "kirkwood" },
67 { "Buffalo Linkstation Mini", "orion5x" },65 { "Buffalo Linkstation Mini", "orion5x" },
68 { "Buffalo Linkstation Pro/Live", "orion5x" },66 { "Buffalo Linkstation Pro/Live", "orion5x" },
69 { "Marvell Orion-NAS Reference Design", "orion5x" },67 { "Marvell Orion-NAS Reference Design", "orion5x" },
@@ -89,6 +87,16 @@
89 { "Linksys NSLU2", "ixp4xx" },87 { "Linksys NSLU2", "ixp4xx" },
90 { "ARM-Versatile AB", "versatile" },88 { "ARM-Versatile AB", "versatile" },
91 { "ARM-Versatile PB", "versatile" },89 { "ARM-Versatile PB", "versatile" },
90
91 /* armhf
92 *
93 * These flavours were removed in Jessie (replaced by the generic armmp
94 * flavour). These are kept solely to allow the Jessie installer to be able
95 * to install Wheezy.
96 *
97 * Do not add new flavours here -- new platforms should use the armmp
98 * kernel, which is the default if nothing is found here.
99 */
92 { "Genesi Efika MX (Smartbook)", "mx5" },100 { "Genesi Efika MX (Smartbook)", "mx5" },
93 { "Genesi Efika MX (Smarttop)", "mx5" },101 { "Genesi Efika MX (Smarttop)", "mx5" },
94 { "Nokia RX-51 Board", "omap" },102 { "Nokia RX-51 Board", "omap" },
@@ -96,14 +104,7 @@
96 { "OMAP4 Panda Board", "omap4" },104 { "OMAP4 Panda Board", "omap4" },
97 { "OMAP4430 Panda Board", "omap4" }, /* first OMAP4 hw platform, more to come */105 { "OMAP4430 Panda Board", "omap4" }, /* first OMAP4 hw platform, more to come */
98 { "OMAP4430 4430SDP board", "omap4" }, /* OMAP4 blaze platform */106 { "OMAP4430 4430SDP board", "omap4" }, /* OMAP4 blaze platform */
99 { "Calxeda Highbank", "generic" },
100 { "Calxeda ECX-2000", "generic" },
101 { "Wandboard i.MX6 Quad Board", "generic" },
102 { "ARM-Versatile Express", "vexpress" },107 { "ARM-Versatile Express", "vexpress" },
103 { "SAMSUNG EXYNOS5 (Flattened Device Tree)", "exynos5" },
104 { "SAMSUNG SSDK5440 board based on EXYNOS5440", "exynos5" },
105 { "SAMSUNG SD5v1 board based on EXYNOS5440", "exynos5" },
106 { "KeyStone2", "keystone" },
107 { NULL, NULL }108 { NULL, NULL }
108};109};
109110
@@ -163,7 +164,7 @@
163 if (ret)164 if (ret)
164 ret = read_cpuinfo(entry, sizeof(entry));165 ret = read_cpuinfo(entry, sizeof(entry));
165 if (ret)166 if (ret)
166 return "unknown";167 return "generic";
167168
168 for (i = 0; map_hardware[i].entry; i++)169 for (i = 0; map_hardware[i].entry; i++)
169 {170 {
@@ -174,7 +175,7 @@
174 }175 }
175 }176 }
176177
177 return "unknown";178 return "generic";
178}179}
179180
180const char *di_system_subarch_analyze_guess(void)181const char *di_system_subarch_analyze_guess(void)
181182
=== added file 'src/system/subarch-arm64-linux.c'
--- src/system/subarch-arm64-linux.c 1970-01-01 00:00:00 +0000
+++ src/system/subarch-arm64-linux.c 2015-01-28 21:45:05 +0000
@@ -0,0 +1,29 @@
1/*
2 * subarch-arm64-linux.c
3 *
4 * Copyright (C) 2013 Ian Campbell <ijc@hellion.org.uk>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <debian-installer/system/subarch.h>
21#include <debian-installer/system/efi.h>
22
23const char *di_system_subarch_analyze(void)
24{
25 if (di_system_is_efi())
26 return "efi";
27 else
28 return "generic";
29}
030
=== modified file 'src/system/subarch-mips-linux.c'
--- src/system/subarch-mips-linux.c 2008-03-06 23:18:08 +0000
+++ src/system/subarch-mips-linux.c 2015-01-28 21:45:05 +0000
@@ -1,148 +1,99 @@
1#include <sys/types.h>
2#include <regex.h>
1#include <stdlib.h>3#include <stdlib.h>
2#include <stdio.h>4#include <stdio.h>
3#include <string.h>5#include <string.h>
46
5#include <debian-installer/system/subarch.h>7#include <debian-installer/system/subarch.h>
68
7struct cpu {9struct hwmap_type {
8 char *cpu;10 const char *sys_regex;
9 char *ret;11 const char *cpu_regex;
10};12 const char *ret;
1113};
12struct systype {14
13 char *sys;15static struct hwmap_type hwmap[] = {
14 struct cpu *cpu;16 {"MIPS Malta", "MIPS (4K|24K|34K|74K)", "4kc-malta" },
15};17 {"MIPS Malta", "MIPS (5K|20K)", "5kc-malta" },
1618 {".*", "ICT Loongson-2 V0.2", "loongson-2e" },
17static struct cpu system_sgi_ind_cpu[] = {19 {".*", "ICT Loongson-2 V0.3", "loongson-2f" },
18 { "R4", "r4k-ip22" }, /* match various R4000 variants */20 {".*", "ICT Loongson-3", "loongson-3" },
19 { "R5000", "r5k-ip22" },21 {".*", "Cavium Octeon", "octeon" },
20 { "R8000", "r8k-ip26" },22 {"SGI (Indy|Indigo2)", "R4", "r4k-ip22" },
21 { "R10000", "r10k-ip28" },23 {"SGI (Indy|Indigo2)", "R5000", "r5k-ip22" },
22 { NULL, "unknown" }24 {"SGI (Indy|Indigo2)", "R8000", "r8k-ip26" },
23};25 {"SGI (Indy|Indigo2)", "R10000", "r10k-ip28" },
2426 {"SGI Origin", "R10000", "r10k-ip27" },
25static struct cpu system_sgi_origin_cpu[] = {27 {"SGI Origin", "R12000", "r12k-ip27" },
26 { "R10000", "r10k-ip27" },28 {"SGI (O2|IP32)", "R5|Nevada|RM7000", "r5k-ip32" },
27 { "R12000", "r12k-ip27" },29 {"SGI (O2|IP32)", "RM10000", "r10k-ip32" },
28 { NULL, "unknown" }30 {"SGI (O2|IP32)", "RM12000", "r12k-ip32" },
29};31 {"SiByte BCM91250", "SiByte SB1", "sb1-bcm91250a" },
3032 {"SiByte BCM91.80", "SiByte SB1A", "sb1a-bcm91480b" },
31static struct cpu system_sgi_o2_cpu[] = {33
32 { "R5", "r5k-ip32" }, /* match R5000 and R5500 */34 /* add new hwmap here */
33 { "Nevada", "r5k-ip32" },35
34 { "RM7000", "r5k-ip32" },36 { ".*", ".*", "unknown" }
35 { "R10000", "r10k-ip32" },37};
36 { "R12000", "r12k-ip32" },
37 { NULL, "unknown" }
38};
39
40static struct cpu system_sibyte_sb1_cpu[] = {
41 { "SiByte SB1A", "sb1a-bcm91480b" },
42 { "SiByte SB1 ", "sb1-bcm91250a" },
43 { NULL, "unknown" }
44};
45
46static struct cpu system_qemu_cpu[] = {
47 { "MIPS 4Kc", "qemu-mips32" },
48 { "MIPS 24Kc", "qemu-mips32" },
49 { NULL, "unknown" }
50};
51
52static struct cpu system_malta_cpu[] = {
53 { "MIPS 4K", "4kc-malta" },
54 { "MIPS 24K", "4kc-malta" },
55 { "MIPS 34K", "4kc-malta" },
56 { "MIPS 5K", "5kc-malta" },
57 { "MIPS 20K", "5kc-malta" },
58 { NULL, "unknown" }
59};
60
61/* add new system types here */
62
63static struct cpu system_unknown_cpu[] = {
64 { NULL, "unknown" }
65};
66
67static struct systype system_type[] = {
68 {"SGI Ind", system_sgi_ind_cpu }, /* match "SGI Indy" and "SGI Indigo2" */
69 {"SGI Origin", system_sgi_origin_cpu },
70 {"SGI IP32", system_sgi_o2_cpu },
71 {"SGI O2", system_sgi_o2_cpu },
72 {"SiByte BCM9", system_sibyte_sb1_cpu }, /* match Broadcom SB1 boards */
73 {"Qemu", system_qemu_cpu },
74 {"MIPS Malta", system_malta_cpu },
75 { NULL, system_unknown_cpu }
76};
77
78#define INVALID_SYS_IDX (sizeof(system_type) / sizeof(struct systype) - 1)
79#define INVALID_CPU_IDX (-1)
8038
81#define BUFFER_LENGTH (1024)39#define BUFFER_LENGTH (1024)
8240
83static int check_system(const char *entry)
84{
85 int ret;
86
87 for (ret = 0; system_type[ret].sys; ret++) {
88 if (!strncmp(system_type[ret].sys, entry,
89 strlen(system_type[ret].sys)))
90 break;
91 }
92
93 return ret;
94}
95
96static int check_cpu(const char *entry, int sys_idx)
97{
98 int ret;
99
100 if (sys_idx == INVALID_SYS_IDX) {
101 /*
102 * This means an unsupported system type, because the
103 * system type is always the first entry in /proc/cpuinfo.
104 */
105 return INVALID_CPU_IDX;
106 }
107
108 for (ret = 0; system_type[sys_idx].cpu[ret].cpu; ret++) {
109 if (!strncmp(system_type[sys_idx].cpu[ret].cpu, entry,
110 strlen(system_type[sys_idx].cpu[ret].cpu)))
111 break;
112 }
113
114 return ret;
115}
116
117const char *di_system_subarch_analyze(void)41const char *di_system_subarch_analyze(void)
118{42{
119 FILE *file;43 FILE *file;
120 int sys_idx = INVALID_SYS_IDX;
121 int cpu_idx = INVALID_CPU_IDX;
122 char buf[BUFFER_LENGTH];44 char buf[BUFFER_LENGTH];
123 char *pos;45 const char *pos;
124 size_t len;46 char *system = NULL, *cpu = NULL;
12547 size_t len, i;
126 if (!(file = fopen("/proc/cpuinfo", "r")))48
127 return system_type[sys_idx].cpu[0].ret;49 file = fopen("/proc/cpuinfo", "r");
12850
129 while (fgets(buf, sizeof(buf), file)) {51 if (file) {
130 if (!(pos = strchr(buf, ':')))52 while (fgets(buf, sizeof(buf), file)) {
131 continue;53 if (!(pos = strchr(buf, ':')))
132 if (!(len = strspn(pos, ": \t")))54 continue;
133 continue;55 if (!(len = strspn(pos, ": \t")))
134 if (!strncmp(buf, "system type", strlen("system type")))56 continue;
135 sys_idx = check_system(pos + len);57 if (!strncmp(buf, "system type", strlen("system type")))
136 else if (!strncmp(buf, "cpu model", strlen("cpu model")))58 system = strdup(pos + len);
137 cpu_idx = check_cpu(pos + len, sys_idx);59 if (!strncmp(buf, "cpu model", strlen("cpu model")))
138 }60 cpu = strdup(pos + len);
13961 }
140 fclose(file);62
14163 fclose(file);
142 if (cpu_idx == INVALID_CPU_IDX) {64 }
143 sys_idx = INVALID_SYS_IDX;65
144 cpu_idx = 0;66 if (!system)
145 }67 system = strdup("");
14668 if (!cpu)
147 return system_type[sys_idx].cpu[cpu_idx].ret;69 cpu = strdup("");
70
71 for (i = 0; i < sizeof(hwmap) / sizeof(struct hwmap_type) ; i++) {
72 regex_t preg;
73 int ret;
74
75 /* Check for matching system type */
76 if (regcomp(&preg, hwmap[i].sys_regex, REG_NOSUB | REG_EXTENDED))
77 continue;
78 ret = regexec(&preg, system, 0, NULL, 0);
79 regfree(&preg);
80 if (ret == REG_NOMATCH)
81 continue;
82
83 /* Check for matching cpu type */
84 if (regcomp(&preg, hwmap[i].cpu_regex, REG_NOSUB | REG_EXTENDED))
85 continue;
86 ret = regexec(&preg, cpu, 0, NULL, 0);
87 regfree(&preg);
88 if (ret == REG_NOMATCH)
89 continue;
90
91 /* Match both system and cpu type. Stop. */
92 break;
93 }
94
95 free(system);
96 free(cpu);
97
98 return hwmap[i].ret;
148}99}
149100
=== modified file 'src/system/subarch-mipsel-linux.c'
--- src/system/subarch-mipsel-linux.c 2010-06-19 22:14:05 +0000
+++ src/system/subarch-mipsel-linux.c 1970-01-01 00:00:00 +0000
@@ -1,156 +0,0 @@
1#include <stdlib.h>
2#include <stdio.h>
3#include <string.h>
4
5#include <debian-installer/system/subarch.h>
6
7struct cpu {
8 char *cpu;
9 char *ret;
10};
11
12struct systype {
13 char *sys;
14 struct cpu *cpu;
15};
16
17static struct cpu system_dec_decs_cpu[] = {
18 { "R3", "r3k-kn02" },
19 { "R4", "r4k-kn04" },
20 { NULL, "unknown" }
21};
22
23static struct cpu system_sibyte_sb1_cpu[] = {
24 { "SiByte SB1A", "sb1a-bcm91480b" },
25 { "SiByte SB1 ", "sb1-bcm91250a" },
26 { NULL, "unknown" }
27};
28
29static struct cpu system_cobalt_cpu[] = {
30 { "Nevada", "cobalt" },
31 { NULL, "unknown" }
32};
33
34static struct cpu system_bcm_bcm947xx_cpu[] = {
35 { "Broadcom BCM3302", "bcm947xx" },
36 { "Broadcom BCM4710", "bcm947xx" },
37 { NULL, "unknown" }
38};
39
40static struct cpu system_qemu_cpu[] = {
41 { "MIPS 4Kc", "qemu-mips32" },
42 { "MIPS 24Kc", "qemu-mips32" },
43 { NULL, "unknown" }
44};
45
46static struct cpu system_malta_cpu[] = {
47 { "MIPS 4K", "4kc-malta" },
48 { "MIPS 24K", "4kc-malta" },
49 { "MIPS 34K", "4kc-malta" },
50 { "MIPS 5K", "5kc-malta" },
51 { "MIPS 20K", "5kc-malta" },
52 { NULL, "unknown" }
53};
54
55static struct cpu system_loongson2_cpu[] = {
56 { "ICT Loongson-2 V0.2", "loongson-2e" },
57 { "ICT Loongson-2 V0.3", "loongson-2f" },
58};
59
60/* add new system types here */
61
62static struct cpu system_unknown_cpu[] = {
63 { NULL, "unknown" }
64};
65
66static struct systype system_type[] = {
67 /*
68 * match any of
69 * "Digital unknown DECstation"
70 * "Digital DECstation"
71 * "Digital DECsystem"
72 * "Digital Personal DECstation"
73 */
74 {"Digital ", system_dec_decs_cpu },
75 {"SiByte BCM9", system_sibyte_sb1_cpu }, /* match Broadcom SB1 boards */
76 {"MIPS Cobalt", system_cobalt_cpu }, /* old kernels */
77 {"Cobalt ", system_cobalt_cpu }, /* match any Cobalt machine; new kernels */
78 {"Broadcom BCM947XX", system_bcm_bcm947xx_cpu }, /* Broadcom based APs/NAS */
79 {"Qemu", system_qemu_cpu },
80 {"MIPS Malta", system_malta_cpu },
81 {"lemote-", system_loongson2_cpu },
82 {"dexxon-gdium-2f", system_loongson2_cpu },
83 { NULL, system_unknown_cpu }
84};
85
86#define INVALID_SYS_IDX (sizeof(system_type) / sizeof(struct systype) - 1)
87#define INVALID_CPU_IDX (-1)
88
89#define BUFFER_LENGTH (1024)
90
91static int check_system(const char *entry)
92{
93 int ret;
94
95 for (ret = 0; system_type[ret].sys; ret++) {
96 if (!strncmp(system_type[ret].sys, entry,
97 strlen(system_type[ret].sys)))
98 break;
99 }
100
101 return ret;
102}
103
104static int check_cpu(const char *entry, int sys_idx)
105{
106 int ret;
107
108 if (sys_idx == INVALID_SYS_IDX) {
109 /*
110 * This means an unsupported system type, because the
111 * system type is always the first entry in /proc/cpuinfo.
112 */
113 return INVALID_CPU_IDX;
114 }
115
116 for (ret = 0; system_type[sys_idx].cpu[ret].cpu; ret++) {
117 if (!strncmp(system_type[sys_idx].cpu[ret].cpu, entry,
118 strlen(system_type[sys_idx].cpu[ret].cpu)))
119 break;
120 }
121
122 return ret;
123}
124
125const char *di_system_subarch_analyze(void)
126{
127 FILE *file;
128 int sys_idx = INVALID_SYS_IDX;
129 int cpu_idx = INVALID_CPU_IDX;
130 char buf[BUFFER_LENGTH];
131 char *pos;
132 size_t len;
133
134 if (!(file = fopen("/proc/cpuinfo", "r")))
135 return system_type[sys_idx].cpu[0].ret;
136
137 while (fgets(buf, sizeof(buf), file)) {
138 if (!(pos = strchr(buf, ':')))
139 continue;
140 if (!(len = strspn(pos, ": \t")))
141 continue;
142 if (!strncmp(buf, "system type", strlen("system type")))
143 sys_idx = check_system(pos + len);
144 else if (!strncmp(buf, "cpu model", strlen("cpu model")))
145 cpu_idx = check_cpu(pos + len, sys_idx);
146 }
147
148 fclose(file);
149
150 if (cpu_idx == INVALID_CPU_IDX) {
151 sys_idx = INVALID_SYS_IDX;
152 cpu_idx = 0;
153 }
154
155 return system_type[sys_idx].cpu[cpu_idx].ret;
156}
1570
=== target is u'subarch-mips-linux.c'
=== modified file 'src/system/subarch-powerpc-linux.c'
--- src/system/subarch-powerpc-linux.c 2013-04-11 09:55:37 +0000
+++ src/system/subarch-powerpc-linux.c 2015-01-28 21:45:05 +0000
@@ -35,6 +35,7 @@
35 { "PA Semi", "pasemi" },35 { "PA Semi", "pasemi" },
36 { "Maple", "chrp_ibm" },36 { "Maple", "chrp_ibm" },
37 { "pSeries", "chrp_ibm" },37 { "pSeries", "chrp_ibm" },
38 { "PowerNV", "chrp_ibm" },
38 { "P4080 DS", "fsl" },39 { "P4080 DS", "fsl" },
39 { "QEMU e500", "fsl" },40 { "QEMU e500", "fsl" },
40 { NULL, NULL }41 { NULL, NULL }
4142
=== added symlink 'src/system/subarch-ppc64-linux.c'
=== target is u'subarch-powerpc-linux.c'
=== modified file 'src/system/subarch-x86-linux.c'
--- src/system/subarch-x86-linux.c 2012-11-25 14:59:59 +0000
+++ src/system/subarch-x86-linux.c 2015-01-28 21:45:05 +0000
@@ -58,6 +58,7 @@
58#include <fcntl.h>58#include <fcntl.h>
5959
60#include <debian-installer/system/subarch.h>60#include <debian-installer/system/subarch.h>
61#include <debian-installer/system/efi.h>
6162
62#define WORD(x) (*(const uint16_t *)(x))63#define WORD(x) (*(const uint16_t *)(x))
63#define DWORD(x) (*(const uint32_t *)(x))64#define DWORD(x) (*(const uint32_t *)(x))
@@ -250,17 +251,6 @@
250 return ret;251 return ret;
251}252}
252253
253/* Are we on an EFI system? Check to see if /sys/firmware/efi
254 * exists */
255static int is_efi(void)
256{
257 int ret = access("/sys/firmware/efi", R_OK);
258 if (ret == 0)
259 return 1;
260 else
261 return 0;
262}
263
264struct map {254struct map {
265 const char *entry;255 const char *entry;
266 const char *ret;256 const char *ret;
@@ -280,7 +270,7 @@
280270
281 /* Look for generic EFI first; this will be over-ridden by the mac271 /* Look for generic EFI first; this will be over-ridden by the mac
282 * detection next if we're on a mac. */272 * detection next if we're on a mac. */
283 if (is_efi())273 if (di_system_is_efi())
284 ret = "efi";274 ret = "efi";
285275
286 if (manufacturer)276 if (manufacturer)

Subscribers

People subscribed via source and target branches