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