]>
Commit | Line | Data |
---|---|---|
15b6757b | 1 | ############################################################################# |
be151c9a | 2 | ## Name: Doxyfile_inc |
de87600c | 3 | ## Purpose: Main configuration file for the wxWidgets manual |
4514447c | 4 | ## Author: Francesco Montorsi |
15b6757b FM |
5 | ## RCS-ID: $Id$ |
6 | ## Licence: wxWindows license | |
7 | ############################################################################# | |
8 | ||
9 | #--------------------------------------------------------------------------- | |
10da75d0 | 10 | # Project Options |
15b6757b FM |
11 | #--------------------------------------------------------------------------- |
12 | ||
13 | DOXYFILE_ENCODING = UTF-8 | |
14 | PROJECT_NAME = wxWidgets | |
15 | PROJECT_NUMBER = 2.9.0 | |
16 | OUTPUT_DIRECTORY = out | |
17 | CREATE_SUBDIRS = NO | |
18 | OUTPUT_LANGUAGE = English | |
19 | BRIEF_MEMBER_DESC = YES | |
7a4370a3 | 20 | REPEAT_BRIEF = YES |
15b6757b FM |
21 | ABBREVIATE_BRIEF = |
22 | ALWAYS_DETAILED_SEC = YES | |
23 | INLINE_INHERITED_MEMB = NO | |
10da75d0 BP |
24 | FULL_PATH_NAMES = YES |
25 | STRIP_FROM_PATH = "$(WXWIDGETS)/" | |
26 | STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \ | |
27 | "$(WXWIDGETS)/interface/" | |
15b6757b | 28 | SHORT_NAMES = NO |
4e021c31 | 29 | JAVADOC_AUTOBRIEF = YES |
15b6757b FM |
30 | QT_AUTOBRIEF = NO |
31 | MULTILINE_CPP_IS_BRIEF = NO | |
15b6757b FM |
32 | INHERIT_DOCS = YES |
33 | SEPARATE_MEMBER_PAGES = NO | |
34 | TAB_SIZE = 4 | |
35 | OPTIMIZE_OUTPUT_FOR_C = NO | |
36 | OPTIMIZE_OUTPUT_JAVA = NO | |
0d0dc584 BP |
37 | OPTIMIZE_FOR_FORTRAN = NO |
38 | OPTIMIZE_OUTPUT_VHDL = NO | |
15b6757b FM |
39 | BUILTIN_STL_SUPPORT = NO |
40 | CPP_CLI_SUPPORT = NO | |
0d0dc584 BP |
41 | SIP_SUPPORT = NO |
42 | IDL_PROPERTY_SUPPORT = NO | |
23324ae1 | 43 | DISTRIBUTE_GROUP_DOC = YES |
15b6757b | 44 | SUBGROUPING = YES |
0d0dc584 BP |
45 | TYPEDEF_HIDES_STRUCT = NO |
46 | SYMBOL_CACHE_SIZE = 0 | |
15b6757b | 47 | |
94802614 FM |
48 | # This is the most important part of the wxWidgets Doxyfile; aliases allow |
49 | # us to keep the headers readable and "implement" wxWidgets-specific commands: | |
50 | ||
15b6757b | 51 | #--------------------------------------------------------------------------- |
94802614 | 52 | # Aliases - for use when documenting C++ classes |
15b6757b FM |
53 | #--------------------------------------------------------------------------- |
54 | ||
3051a44a FM |
55 | # aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc): |
56 | ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>" | |
57 | ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span></div></p>Event macros for events emitted by this class:<div>" | |
58 | ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span> or <span>void handlerFuncName(\2& event)</span></div></p>Event macros for events emitted by this class:<div>" | |
59 | ||
60 | # aliases to be used in wxEvent-derived classes: | |
61 | ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span></div></p>Event macros:<div>" | |
62 | ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span> or <span>void handlerFuncName(\2& event)</span></div></p>Event macros:<div>" | |
63 | ||
64 | # common event aliases: | |
8c6791e4 FM |
65 | ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>" |
66 | ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>" | |
67 | ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>" | |
68 | ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>" | |
69 | ALIASES += endEventTable="</div>\n" | |
15b6757b FM |
70 | |
71 | # style aliases | |
0d0dc584 | 72 | ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>" |
8c6791e4 FM |
73 | ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>" |
74 | ALIASES += endStyleTable="</div>\n" | |
15b6757b FM |
75 | |
76 | # extra style aliases | |
0d0dc584 | 77 | ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>" |
8c6791e4 | 78 | ALIASES += endExtraStyleTable="</div>\n" |
469e56bf | 79 | |
09a728e1 FM |
80 | # flag aliases |
81 | ALIASES += beginFlagTable="<div>" | |
82 | ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>" | |
83 | ALIASES += endFlagTable="</div>\n" | |
84 | ||
94802614 FM |
85 | # creates appearance section: this should be used for all main GUI controls |
86 | ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly" | |
87 | ||
88 | #--------------------------------------------------------------------------- | |
89 | # Aliases - for use when documenting any C++ entity | |
90 | #--------------------------------------------------------------------------- | |
91 | ||
e1ebc6f4 | 92 | # aliases for additional wx-specific infos |
4cbfec15 FM |
93 | ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>" |
94 | ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>" | |
0d0dc584 BP |
95 | ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>" |
96 | ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>" | |
4f960cd1 | 97 | ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>" |
e1ebc6f4 FM |
98 | |
99 | # native implementation infos: | |
f59be7c6 FM |
100 | ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>" |
101 | ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>" | |
102 | ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>" | |
103 | ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>" | |
e1ebc6f4 FM |
104 | |
105 | # onlyfor infos: | |
03d4f7b9 FM |
106 | # NOTE: we need to be able to retrieve these infos also from the XML output, thus |
107 | # we use the \xmlonly and \endxmlonly commands to include custom XML tags | |
108 | ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly" | |
109 | ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly" | |
110 | ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly" | |
111 | ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly" | |
048398c7 | 112 | |
12f5e1e7 BP |
113 | # Use this in grouped global functions, and macros since they |
114 | # wouldn't otherwise indicate what header they are defined in. | |
e1ebc6f4 FM |
115 | ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim" |
116 | ||
15b6757b | 117 | # some formatting aliases |
44fe9ffc FM |
118 | ALIASES += true="<span class='literal'>true</span>" |
119 | ALIASES += false="<span class='literal'>false</span>" | |
120 | ALIASES += NULL="<span class='literal'>NULL</span>" | |
8d740f72 | 121 | ALIASES += NUL="<span class='literal'>NUL</span>" |
44fe9ffc FM |
122 | |
123 | # NOTE: these are important as you can't write in the docs | |
124 | # just #ifdef since the # character is used by Doxygen | |
125 | # for explicit linking; use the following aliases instead! | |
126 | # However to avoid overwriting e.g. \if Doxygen command the _ | |
127 | # character is postfixed | |
128 | ALIASES += ifdef_="<span class='literal'>\#ifdef</span>" | |
129 | ALIASES += ifndef_="<span class='literal'>\#ifndef</span>" | |
130 | ALIASES += if_="<span class='literal'>\#if</span>" | |
131 | ALIASES += endif_="<span class='literal'>\#endif</span>" | |
15b6757b | 132 | |
4514447c | 133 | # table aliases for 2 and 3 column tables |
a6d7c65b VS |
134 | ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>" |
135 | ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>" | |
4514447c FM |
136 | ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>" |
137 | ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>" | |
138 | ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>" | |
139 | ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>" | |
140 | ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>" | |
141 | ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>" | |
142 | ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>" | |
143 | ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>" | |
144 | ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>" | |
145 | ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>" | |
146 | ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>" | |
147 | ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>" | |
148 | ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>" | |
149 | ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>" | |
150 | ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>" | |
151 | ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>" | |
152 | ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>" | |
a302d595 | 153 | ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>" |
a6d7c65b | 154 | ALIASES += endTable="</table>" |
a3465294 | 155 | |
4514447c FM |
156 | # definition list aliases |
157 | # a definition list currently is rendered as 2-column table but it may use as | |
158 | # well the <dl>, <dt> and <dd> HTML tags in future. | |
159 | # In any case a definition list differs from a table because of its semantic | |
160 | # nature and because it is always the association of a "title" with a "description" | |
161 | # (in contrast a table may have more than 2 columns of data)... | |
dc215c81 | 162 | ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>" |
0aaf0255 FM |
163 | ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>" |
164 | ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>" | |
165 | ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>" | |
166 | ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>" | |
167 | ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>" | |
168 | ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>" | |
169 | ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>" | |
170 | ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>" | |
171 | ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>" | |
4514447c | 172 | ALIASES += endDefList="</table>" |
808b128e | 173 | ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>" |
4514447c | 174 | |
94802614 FM |
175 | #--------------------------------------------------------------------------- |
176 | # Aliases - for use when documenting wxPerl/wxPython-specific parts | |
177 | #--------------------------------------------------------------------------- | |
178 | ||
d54cf7ff | 179 | # See ENABLED_SECTIONS configuration key for more info about these: |
f09b5681 | 180 | ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> " |
d54cf7ff | 181 | ALIASES += endWxPerlOnly="\endif" |
f09b5681 | 182 | ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> " |
d54cf7ff | 183 | ALIASES += endWxPythonOnly="\endif" |
a3465294 | 184 | |
877b5c30 BP |
185 | # This is to get around a bug in Doxygen that prevents use of '{' or '}' |
186 | # inside of any aliased command in parameters. | |
187 | ALIASES += leftCurly="{" | |
188 | ALIASES += rightCurly="}" | |
189 | ||
94802614 FM |
190 | #--------------------------------------------------------------------------- |
191 | # Aliases - for use when documenting samples | |
192 | #--------------------------------------------------------------------------- | |
193 | ||
5d4cca7f BP |
194 | # For indicating the a directory containing a sample |
195 | ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim" | |
94802614 | 196 | |
57b2bba4 | 197 | # For refering to the corresponding sample in a class document or a overview |
5d4cca7f BP |
198 | # Usually placed in the queue of @see |
199 | ALIASES += sample{1}="\ref page_samples_\1" | |
94802614 | 200 | |
57b2bba4 BP |
201 | # For generating a general description for a sample |
202 | # \1 could be a class or an overview or a descriptive sentence | |
5d4cca7f BP |
203 | # Shall be replaced by manual written description soon |
204 | ALIASES += sampleabout{1}="This sample demonstrates \1." | |
94802614 | 205 | |
5d4cca7f BP |
206 | # For indicating the necessary condition of a sample or a class |
207 | # \1 is the wxUSE_XXX macro | |
208 | ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info." | |
209 | ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info." | |
210 | ||
15b6757b | 211 | #--------------------------------------------------------------------------- |
10da75d0 | 212 | # Build Options |
15b6757b | 213 | #--------------------------------------------------------------------------- |
10da75d0 | 214 | |
15b6757b FM |
215 | EXTRACT_ALL = YES |
216 | EXTRACT_PRIVATE = NO | |
217 | EXTRACT_STATIC = YES | |
218 | EXTRACT_LOCAL_CLASSES = YES | |
219 | EXTRACT_LOCAL_METHODS = NO | |
220 | EXTRACT_ANON_NSPACES = YES | |
23324ae1 FM |
221 | HIDE_UNDOC_MEMBERS = NO |
222 | HIDE_UNDOC_CLASSES = NO | |
15b6757b FM |
223 | HIDE_FRIEND_COMPOUNDS = NO |
224 | HIDE_IN_BODY_DOCS = NO | |
225 | INTERNAL_DOCS = NO | |
226 | CASE_SENSE_NAMES = NO | |
227 | HIDE_SCOPE_NAMES = NO | |
228 | SHOW_INCLUDE_FILES = YES | |
229 | INLINE_INFO = YES | |
230 | SORT_MEMBER_DOCS = YES | |
0d0dc584 BP |
231 | SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order. |
232 | SORT_GROUP_NAMES = YES | |
15b6757b FM |
233 | SORT_BY_SCOPE_NAME = NO |
234 | GENERATE_TODOLIST = YES | |
235 | GENERATE_TESTLIST = YES | |
236 | GENERATE_BUGLIST = YES | |
237 | GENERATE_DEPRECATEDLIST= YES | |
d54cf7ff FM |
238 | |
239 | # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords | |
dc215c81 | 240 | ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL |
d54cf7ff | 241 | |
15b6757b | 242 | MAX_INITIALIZER_LINES = 30 |
10da75d0 | 243 | SHOW_USED_FILES = NO |
23324ae1 | 244 | SHOW_DIRECTORIES = YES |
0d0dc584 BP |
245 | SHOW_FILES = YES |
246 | SHOW_NAMESPACES = NO | |
6783cae4 | 247 | FILE_VERSION_FILTER = |
0d0dc584 | 248 | LAYOUT_FILE = DoxygenLayout.xml |
15b6757b FM |
249 | |
250 | #--------------------------------------------------------------------------- | |
10da75d0 | 251 | # Warning and Progress Message Options |
15b6757b | 252 | #--------------------------------------------------------------------------- |
10da75d0 | 253 | |
f159c6b5 | 254 | QUIET = YES |
15b6757b | 255 | WARNINGS = YES |
90a47090 | 256 | WARN_IF_UNDOCUMENTED = YES |
15b6757b | 257 | WARN_IF_DOC_ERROR = YES |
23324ae1 | 258 | WARN_NO_PARAMDOC = YES |
15b6757b | 259 | WARN_FORMAT = "$file:$line: $text " |
4411a6b6 | 260 | WARN_LOGFILE = doxygen.log |
15b6757b FM |
261 | |
262 | #--------------------------------------------------------------------------- | |
10da75d0 | 263 | # Input File Options |
15b6757b | 264 | #--------------------------------------------------------------------------- |
10da75d0 | 265 | |
c83e60aa | 266 | INPUT = ./mainpages ./groups ./overviews ../../interface |
15b6757b FM |
267 | INPUT_ENCODING = UTF-8 |
268 | FILE_PATTERNS = *.h *.txt | |
269 | RECURSIVE = YES | |
6783cae4 | 270 | EXCLUDE = |
15b6757b | 271 | EXCLUDE_SYMLINKS = NO |
6783cae4 FM |
272 | EXCLUDE_PATTERNS = |
273 | EXCLUDE_SYMBOLS = | |
29f86fc1 | 274 | EXAMPLE_PATH = ../ |
15b6757b | 275 | EXAMPLE_PATTERNS = * |
29f86fc1 | 276 | EXAMPLE_RECURSIVE = NO |
4411a6b6 | 277 | IMAGE_PATH = images |
6783cae4 FM |
278 | INPUT_FILTER = |
279 | FILTER_PATTERNS = | |
15b6757b FM |
280 | FILTER_SOURCE_FILES = NO |
281 | ||
282 | #--------------------------------------------------------------------------- | |
10da75d0 | 283 | # Source Browsing Options |
15b6757b | 284 | #--------------------------------------------------------------------------- |
10da75d0 | 285 | |
15b6757b FM |
286 | SOURCE_BROWSER = NO |
287 | INLINE_SOURCES = NO | |
288 | STRIP_CODE_COMMENTS = YES | |
289 | REFERENCED_BY_RELATION = NO | |
290 | REFERENCES_RELATION = NO | |
291 | REFERENCES_LINK_SOURCE = YES | |
292 | USE_HTAGS = NO | |
293 | VERBATIM_HEADERS = NO | |
294 | ||
295 | #--------------------------------------------------------------------------- | |
10da75d0 | 296 | # Alphabetical Class Index Options |
15b6757b | 297 | #--------------------------------------------------------------------------- |
10da75d0 | 298 | |
15b6757b FM |
299 | ALPHABETICAL_INDEX = YES |
300 | COLS_IN_ALPHA_INDEX = 5 | |
301 | IGNORE_PREFIX = wx | |
302 | ||
303 | #--------------------------------------------------------------------------- | |
304 | # configuration options related to the HTML output | |
305 | #--------------------------------------------------------------------------- | |
2a6585b8 | 306 | GENERATE_HTML = NO # Only change in format output configs |
15b6757b FM |
307 | HTML_OUTPUT = html |
308 | HTML_FILE_EXTENSION = .html | |
309 | HTML_HEADER = htmlheader.inc | |
310 | HTML_FOOTER = htmlfooter.inc | |
6783cae4 | 311 | HTML_STYLESHEET = |
15b6757b | 312 | HTML_ALIGN_MEMBERS = YES |
f159c6b5 | 313 | HTML_DYNAMIC_SECTIONS = YES |
0d0dc584 BP |
314 | GENERATE_DOCSET = NO # Only change in format output configs |
315 | DOCSET_FEEDNAME = "wxWidgets" | |
316 | DOCSET_BUNDLE_ID = org.wxwidgets.doxygen | |
317 | GENERATE_HTMLHELP = NO # Only change in format output configs | |
2a6585b8 BP |
318 | CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed |
319 | HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info | |
15b6757b FM |
320 | GENERATE_CHI = NO |
321 | BINARY_TOC = NO | |
322 | TOC_EXPAND = NO | |
0d0dc584 | 323 | GENERATE_QHP = NO |
3051a44a | 324 | QCH_FILE = |
0d0dc584 BP |
325 | QHP_NAMESPACE = org.wxwidgets.doxygen |
326 | QHP_VIRTUAL_FOLDER = doc | |
3051a44a | 327 | QHG_LOCATION = |
15b6757b | 328 | DISABLE_INDEX = NO |
bbc5b7f8 | 329 | ENUM_VALUES_PER_LINE = 1 |
0d0dc584 | 330 | GENERATE_TREEVIEW = NONE |
15b6757b | 331 | TREEVIEW_WIDTH = 250 |
0d0dc584 | 332 | FORMULA_FONTSIZE = 10 |
15b6757b FM |
333 | |
334 | #--------------------------------------------------------------------------- | |
10da75d0 | 335 | # LaTeX Output Options |
15b6757b | 336 | #--------------------------------------------------------------------------- |
10da75d0 | 337 | |
2a6585b8 | 338 | GENERATE_LATEX = NO # Only change in format output configs |
15b6757b FM |
339 | LATEX_OUTPUT = latex |
340 | LATEX_CMD_NAME = latex | |
341 | MAKEINDEX_CMD_NAME = makeindex | |
342 | COMPACT_LATEX = NO | |
343 | PAPER_TYPE = a4wide | |
6783cae4 | 344 | EXTRA_PACKAGES = |
d0894365 | 345 | LATEX_HEADER = latexdocstart.inc |
f4eb5ee6 SC |
346 | PDF_HYPERLINKS = YES |
347 | USE_PDFLATEX = YES | |
348 | LATEX_BATCHMODE = YES | |
15b6757b FM |
349 | LATEX_HIDE_INDICES = NO |
350 | ||
351 | #--------------------------------------------------------------------------- | |
10da75d0 | 352 | # RTF Output Options |
15b6757b | 353 | #--------------------------------------------------------------------------- |
10da75d0 | 354 | |
2a6585b8 | 355 | GENERATE_RTF = NO # Only change in format output configs |
15b6757b FM |
356 | RTF_OUTPUT = rtf |
357 | COMPACT_RTF = NO | |
358 | RTF_HYPERLINKS = NO | |
6783cae4 FM |
359 | RTF_STYLESHEET_FILE = |
360 | RTF_EXTENSIONS_FILE = | |
15b6757b FM |
361 | |
362 | #--------------------------------------------------------------------------- | |
10da75d0 | 363 | # Man Page Output Options |
15b6757b | 364 | #--------------------------------------------------------------------------- |
10da75d0 | 365 | |
2a6585b8 | 366 | GENERATE_MAN = NO # Only change in format output configs |
15b6757b FM |
367 | MAN_OUTPUT = man |
368 | MAN_EXTENSION = .3 | |
369 | MAN_LINKS = NO | |
370 | ||
371 | #--------------------------------------------------------------------------- | |
10da75d0 | 372 | # XML Output Options |
15b6757b | 373 | #--------------------------------------------------------------------------- |
10da75d0 | 374 | |
2a6585b8 | 375 | GENERATE_XML = NO # Only change in format output configs |
15b6757b | 376 | XML_OUTPUT = xml |
6783cae4 FM |
377 | XML_SCHEMA = |
378 | XML_DTD = | |
09ad05fa | 379 | XML_PROGRAMLISTING = NO |
15b6757b FM |
380 | |
381 | #--------------------------------------------------------------------------- | |
10da75d0 | 382 | # AutoGen Definitions Output Options |
15b6757b | 383 | #--------------------------------------------------------------------------- |
10da75d0 | 384 | |
2a6585b8 | 385 | GENERATE_AUTOGEN_DEF = NO # Only change in format output configs |
15b6757b FM |
386 | |
387 | #--------------------------------------------------------------------------- | |
10da75d0 | 388 | # Perl Module Output Options |
15b6757b | 389 | #--------------------------------------------------------------------------- |
10da75d0 | 390 | |
2a6585b8 | 391 | GENERATE_PERLMOD = NO # Only change in format output configs |
30738aae | 392 | PERLMOD_LATEX = YES |
15b6757b | 393 | PERLMOD_PRETTY = YES |
de87600c | 394 | PERLMOD_MAKEVAR_PREFIX = |
15b6757b FM |
395 | |
396 | #--------------------------------------------------------------------------- | |
10da75d0 | 397 | # Preprocessor Options |
15b6757b | 398 | #--------------------------------------------------------------------------- |
10da75d0 | 399 | |
15b6757b FM |
400 | ENABLE_PREPROCESSING = YES |
401 | MACRO_EXPANSION = NO | |
402 | EXPAND_ONLY_PREDEF = NO | |
403 | SEARCH_INCLUDES = YES | |
6783cae4 FM |
404 | INCLUDE_PATH = |
405 | INCLUDE_FILE_PATTERNS = | |
406 | PREDEFINED = | |
407 | EXPAND_AS_DEFINED = | |
15b6757b FM |
408 | SKIP_FUNCTION_MACROS = YES |
409 | ||
410 | #--------------------------------------------------------------------------- | |
10da75d0 | 411 | # Additions Related to External References |
15b6757b | 412 | #--------------------------------------------------------------------------- |
10da75d0 | 413 | |
6783cae4 | 414 | TAGFILES = |
2a6585b8 | 415 | GENERATE_TAGFILE = |
15b6757b FM |
416 | ALLEXTERNALS = NO |
417 | EXTERNAL_GROUPS = YES | |
418 | PERL_PATH = /usr/bin/perl | |
419 | ||
420 | #--------------------------------------------------------------------------- | |
10da75d0 | 421 | # dot Tool Options |
15b6757b | 422 | #--------------------------------------------------------------------------- |
10da75d0 | 423 | |
15b6757b FM |
424 | CLASS_DIAGRAMS = YES |
425 | MSCGEN_PATH = | |
426 | HIDE_UNDOC_RELATIONS = YES | |
427 | HAVE_DOT = YES | |
0d0dc584 BP |
428 | DOT_FONTNAME = FreeSans |
429 | DOT_FONTSIZE = 10 | |
3051a44a | 430 | DOT_FONTPATH = |
0d0dc584 | 431 | CLASS_GRAPH = YES |
15b6757b FM |
432 | COLLABORATION_GRAPH = NO |
433 | GROUP_GRAPHS = NO | |
434 | UML_LOOK = NO | |
435 | TEMPLATE_RELATIONS = NO | |
436 | INCLUDE_GRAPH = NO | |
437 | INCLUDED_BY_GRAPH = NO | |
438 | CALL_GRAPH = NO | |
439 | CALLER_GRAPH = NO | |
440 | GRAPHICAL_HIERARCHY = NO | |
441 | DIRECTORY_GRAPH = NO | |
442 | DOT_IMAGE_FORMAT = png | |
6783cae4 FM |
443 | DOT_PATH = |
444 | DOTFILE_DIRS = | |
15b6757b FM |
445 | DOT_GRAPH_MAX_NODES = 50 |
446 | MAX_DOT_GRAPH_DEPTH = 1000 | |
447 | DOT_TRANSPARENT = NO | |
448 | DOT_MULTI_TARGETS = NO | |
449 | GENERATE_LEGEND = YES | |
450 | DOT_CLEANUP = YES | |
451 | ||
452 | #--------------------------------------------------------------------------- | |
10da75d0 | 453 | # Search Engine Options |
15b6757b | 454 | #--------------------------------------------------------------------------- |
10da75d0 | 455 | |
2a6585b8 BP |
456 | SEARCHENGINE = NO |
457 |