]>
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 | |
6c42e86d | 15 | PROJECT_NUMBER = 2.9.3 |
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" |
f09b5681 | 199 | ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> " |
d54cf7ff | 200 | ALIASES += endWxPythonOnly="\endif" |
a3465294 | 201 | |
877b5c30 BP |
202 | # This is to get around a bug in Doxygen that prevents use of '{' or '}' |
203 | # inside of any aliased command in parameters. | |
204 | ALIASES += leftCurly="{" | |
205 | ALIASES += rightCurly="}" | |
206 | ||
94802614 FM |
207 | #--------------------------------------------------------------------------- |
208 | # Aliases - for use when documenting samples | |
209 | #--------------------------------------------------------------------------- | |
210 | ||
dff3fa53 VZ |
211 | # For indicating a sample location |
212 | ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/\1" | |
94802614 | 213 | |
57b2bba4 | 214 | # For refering to the corresponding sample in a class document or a overview |
5d4cca7f BP |
215 | # Usually placed in the queue of @see |
216 | ALIASES += sample{1}="\ref page_samples_\1" | |
94802614 | 217 | |
57b2bba4 BP |
218 | # For generating a general description for a sample |
219 | # \1 could be a class or an overview or a descriptive sentence | |
5d4cca7f BP |
220 | # Shall be replaced by manual written description soon |
221 | ALIASES += sampleabout{1}="This sample demonstrates \1." | |
94802614 | 222 | |
5d4cca7f BP |
223 | # For indicating the necessary condition of a sample or a class |
224 | # \1 is the wxUSE_XXX macro | |
225 | 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." | |
226 | 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." | |
227 | ||
15b6757b | 228 | #--------------------------------------------------------------------------- |
10da75d0 | 229 | # Build Options |
15b6757b | 230 | #--------------------------------------------------------------------------- |
10da75d0 | 231 | |
15b6757b FM |
232 | EXTRACT_ALL = YES |
233 | EXTRACT_PRIVATE = NO | |
234 | EXTRACT_STATIC = YES | |
235 | EXTRACT_LOCAL_CLASSES = YES | |
236 | EXTRACT_LOCAL_METHODS = NO | |
237 | EXTRACT_ANON_NSPACES = YES | |
23324ae1 FM |
238 | HIDE_UNDOC_MEMBERS = NO |
239 | HIDE_UNDOC_CLASSES = NO | |
15b6757b FM |
240 | HIDE_FRIEND_COMPOUNDS = NO |
241 | HIDE_IN_BODY_DOCS = NO | |
242 | INTERNAL_DOCS = NO | |
243 | CASE_SENSE_NAMES = NO | |
244 | HIDE_SCOPE_NAMES = NO | |
245 | SHOW_INCLUDE_FILES = YES | |
246 | INLINE_INFO = YES | |
247 | SORT_MEMBER_DOCS = YES | |
0d0dc584 BP |
248 | SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order. |
249 | SORT_GROUP_NAMES = YES | |
15b6757b FM |
250 | SORT_BY_SCOPE_NAME = NO |
251 | GENERATE_TODOLIST = YES | |
252 | GENERATE_TESTLIST = YES | |
253 | GENERATE_BUGLIST = YES | |
254 | GENERATE_DEPRECATEDLIST= YES | |
d54cf7ff FM |
255 | |
256 | # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords | |
dc215c81 | 257 | ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL |
d54cf7ff | 258 | |
15b6757b | 259 | MAX_INITIALIZER_LINES = 30 |
10da75d0 | 260 | SHOW_USED_FILES = NO |
23324ae1 | 261 | SHOW_DIRECTORIES = YES |
0d0dc584 BP |
262 | SHOW_FILES = YES |
263 | SHOW_NAMESPACES = NO | |
6783cae4 | 264 | FILE_VERSION_FILTER = |
0d0dc584 | 265 | LAYOUT_FILE = DoxygenLayout.xml |
15b6757b FM |
266 | |
267 | #--------------------------------------------------------------------------- | |
10da75d0 | 268 | # Warning and Progress Message Options |
15b6757b | 269 | #--------------------------------------------------------------------------- |
10da75d0 | 270 | |
f159c6b5 | 271 | QUIET = YES |
15b6757b | 272 | WARNINGS = YES |
90a47090 | 273 | WARN_IF_UNDOCUMENTED = YES |
15b6757b | 274 | WARN_IF_DOC_ERROR = YES |
23324ae1 | 275 | WARN_NO_PARAMDOC = YES |
15b6757b | 276 | WARN_FORMAT = "$file:$line: $text " |
4411a6b6 | 277 | WARN_LOGFILE = doxygen.log |
15b6757b FM |
278 | |
279 | #--------------------------------------------------------------------------- | |
10da75d0 | 280 | # Input File Options |
15b6757b | 281 | #--------------------------------------------------------------------------- |
10da75d0 | 282 | |
c83e60aa | 283 | INPUT = ./mainpages ./groups ./overviews ../../interface |
15b6757b FM |
284 | INPUT_ENCODING = UTF-8 |
285 | FILE_PATTERNS = *.h *.txt | |
286 | RECURSIVE = YES | |
6783cae4 | 287 | EXCLUDE = |
15b6757b | 288 | EXCLUDE_SYMLINKS = NO |
6783cae4 FM |
289 | EXCLUDE_PATTERNS = |
290 | EXCLUDE_SYMBOLS = | |
29f86fc1 | 291 | EXAMPLE_PATH = ../ |
15b6757b | 292 | EXAMPLE_PATTERNS = * |
29f86fc1 | 293 | EXAMPLE_RECURSIVE = NO |
4411a6b6 | 294 | IMAGE_PATH = images |
6783cae4 FM |
295 | INPUT_FILTER = |
296 | FILTER_PATTERNS = | |
15b6757b FM |
297 | FILTER_SOURCE_FILES = NO |
298 | ||
299 | #--------------------------------------------------------------------------- | |
10da75d0 | 300 | # Source Browsing Options |
15b6757b | 301 | #--------------------------------------------------------------------------- |
10da75d0 | 302 | |
15b6757b FM |
303 | SOURCE_BROWSER = NO |
304 | INLINE_SOURCES = NO | |
305 | STRIP_CODE_COMMENTS = YES | |
306 | REFERENCED_BY_RELATION = NO | |
307 | REFERENCES_RELATION = NO | |
308 | REFERENCES_LINK_SOURCE = YES | |
309 | USE_HTAGS = NO | |
310 | VERBATIM_HEADERS = NO | |
311 | ||
312 | #--------------------------------------------------------------------------- | |
10da75d0 | 313 | # Alphabetical Class Index Options |
15b6757b | 314 | #--------------------------------------------------------------------------- |
10da75d0 | 315 | |
15b6757b FM |
316 | ALPHABETICAL_INDEX = YES |
317 | COLS_IN_ALPHA_INDEX = 5 | |
318 | IGNORE_PREFIX = wx | |
319 | ||
320 | #--------------------------------------------------------------------------- | |
321 | # configuration options related to the HTML output | |
322 | #--------------------------------------------------------------------------- | |
2a6585b8 | 323 | GENERATE_HTML = NO # Only change in format output configs |
15b6757b FM |
324 | HTML_OUTPUT = html |
325 | HTML_FILE_EXTENSION = .html | |
20004800 BP |
326 | HTML_HEADER = custom_header.html |
327 | HTML_FOOTER = custom_footer.html | |
328 | HTML_STYLESHEET = custom_stylesheet.css | |
329 | HTML_EXTRA_FILES = | |
330 | HTML_COLORSTYLE_HUE = | |
331 | HTML_COLORSTYLE_SAT = 255 | |
332 | HTML_COLORSTYLE_GAMMA = 100 | |
333 | HTML_TIMESTAMP = YES | |
15b6757b | 334 | HTML_ALIGN_MEMBERS = YES |
f159c6b5 | 335 | HTML_DYNAMIC_SECTIONS = YES |
7e6ab750 FM |
336 | DISABLE_INDEX = NO |
337 | ENUM_VALUES_PER_LINE = 1 | |
20004800 BP |
338 | GENERATE_TREEVIEW = NO |
339 | USE_INLINE_TREES = NO | |
7e6ab750 | 340 | TREEVIEW_WIDTH = 250 |
20004800 | 341 | EXT_LINKS_IN_WINDOW = YES |
7e6ab750 | 342 | FORMULA_FONTSIZE = 10 |
20004800 | 343 | FORMULA_TRANSPARENT = YES |
7e6ab750 FM |
344 | |
345 | #--------------------------------------------------------------------------- | |
346 | # configuration options related to the CHM output | |
347 | #--------------------------------------------------------------------------- | |
348 | ||
0d0dc584 | 349 | GENERATE_HTMLHELP = NO # Only change in format output configs |
2a6585b8 BP |
350 | CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed |
351 | HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info | |
15b6757b FM |
352 | GENERATE_CHI = NO |
353 | BINARY_TOC = NO | |
354 | TOC_EXPAND = NO | |
7e6ab750 FM |
355 | |
356 | #--------------------------------------------------------------------------- | |
357 | # configuration options related to the Qt Help Project output | |
358 | #--------------------------------------------------------------------------- | |
359 | ||
360 | GENERATE_QHP = NO # Only change in format output configs | |
3051a44a | 361 | QCH_FILE = |
0d0dc584 BP |
362 | QHP_NAMESPACE = org.wxwidgets.doxygen |
363 | QHP_VIRTUAL_FOLDER = doc | |
3051a44a | 364 | QHG_LOCATION = |
7e6ab750 FM |
365 | |
366 | #--------------------------------------------------------------------------- | |
367 | # configuration options related to the Docset output | |
368 | #--------------------------------------------------------------------------- | |
369 | ||
370 | GENERATE_DOCSET = NO # Only change in format output configs | |
371 | DOCSET_FEEDNAME = "wxWidgets 2.9" | |
372 | DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29 | |
373 | DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen | |
374 | DOCSET_PUBLISHER_NAME = wxWidgets Team | |
15b6757b FM |
375 | |
376 | #--------------------------------------------------------------------------- | |
10da75d0 | 377 | # LaTeX Output Options |
15b6757b | 378 | #--------------------------------------------------------------------------- |
10da75d0 | 379 | |
2a6585b8 | 380 | GENERATE_LATEX = NO # Only change in format output configs |
15b6757b FM |
381 | LATEX_OUTPUT = latex |
382 | LATEX_CMD_NAME = latex | |
383 | MAKEINDEX_CMD_NAME = makeindex | |
384 | COMPACT_LATEX = NO | |
385 | PAPER_TYPE = a4wide | |
6783cae4 | 386 | EXTRA_PACKAGES = |
d0894365 | 387 | LATEX_HEADER = latexdocstart.inc |
f4eb5ee6 SC |
388 | PDF_HYPERLINKS = YES |
389 | USE_PDFLATEX = YES | |
390 | LATEX_BATCHMODE = YES | |
15b6757b FM |
391 | LATEX_HIDE_INDICES = NO |
392 | ||
393 | #--------------------------------------------------------------------------- | |
10da75d0 | 394 | # RTF Output Options |
15b6757b | 395 | #--------------------------------------------------------------------------- |
10da75d0 | 396 | |
2a6585b8 | 397 | GENERATE_RTF = NO # Only change in format output configs |
15b6757b FM |
398 | RTF_OUTPUT = rtf |
399 | COMPACT_RTF = NO | |
400 | RTF_HYPERLINKS = NO | |
6783cae4 FM |
401 | RTF_STYLESHEET_FILE = |
402 | RTF_EXTENSIONS_FILE = | |
15b6757b FM |
403 | |
404 | #--------------------------------------------------------------------------- | |
10da75d0 | 405 | # Man Page Output Options |
15b6757b | 406 | #--------------------------------------------------------------------------- |
10da75d0 | 407 | |
2a6585b8 | 408 | GENERATE_MAN = NO # Only change in format output configs |
15b6757b FM |
409 | MAN_OUTPUT = man |
410 | MAN_EXTENSION = .3 | |
411 | MAN_LINKS = NO | |
412 | ||
413 | #--------------------------------------------------------------------------- | |
10da75d0 | 414 | # XML Output Options |
15b6757b | 415 | #--------------------------------------------------------------------------- |
10da75d0 | 416 | |
2a6585b8 | 417 | GENERATE_XML = NO # Only change in format output configs |
15b6757b | 418 | XML_OUTPUT = xml |
6783cae4 FM |
419 | XML_SCHEMA = |
420 | XML_DTD = | |
09ad05fa | 421 | XML_PROGRAMLISTING = NO |
15b6757b FM |
422 | |
423 | #--------------------------------------------------------------------------- | |
10da75d0 | 424 | # AutoGen Definitions Output Options |
15b6757b | 425 | #--------------------------------------------------------------------------- |
10da75d0 | 426 | |
2a6585b8 | 427 | GENERATE_AUTOGEN_DEF = NO # Only change in format output configs |
15b6757b FM |
428 | |
429 | #--------------------------------------------------------------------------- | |
10da75d0 | 430 | # Perl Module Output Options |
15b6757b | 431 | #--------------------------------------------------------------------------- |
10da75d0 | 432 | |
2a6585b8 | 433 | GENERATE_PERLMOD = NO # Only change in format output configs |
30738aae | 434 | PERLMOD_LATEX = YES |
15b6757b | 435 | PERLMOD_PRETTY = YES |
de87600c | 436 | PERLMOD_MAKEVAR_PREFIX = |
15b6757b FM |
437 | |
438 | #--------------------------------------------------------------------------- | |
10da75d0 | 439 | # Preprocessor Options |
15b6757b | 440 | #--------------------------------------------------------------------------- |
10da75d0 | 441 | |
15b6757b FM |
442 | ENABLE_PREPROCESSING = YES |
443 | MACRO_EXPANSION = NO | |
444 | EXPAND_ONLY_PREDEF = NO | |
445 | SEARCH_INCLUDES = YES | |
6783cae4 FM |
446 | INCLUDE_PATH = |
447 | INCLUDE_FILE_PATTERNS = | |
448 | PREDEFINED = | |
449 | EXPAND_AS_DEFINED = | |
15b6757b FM |
450 | SKIP_FUNCTION_MACROS = YES |
451 | ||
452 | #--------------------------------------------------------------------------- | |
10da75d0 | 453 | # Additions Related to External References |
15b6757b | 454 | #--------------------------------------------------------------------------- |
10da75d0 | 455 | |
6783cae4 | 456 | TAGFILES = |
2a6585b8 | 457 | GENERATE_TAGFILE = |
15b6757b FM |
458 | ALLEXTERNALS = NO |
459 | EXTERNAL_GROUPS = YES | |
460 | PERL_PATH = /usr/bin/perl | |
461 | ||
462 | #--------------------------------------------------------------------------- | |
10da75d0 | 463 | # dot Tool Options |
15b6757b | 464 | #--------------------------------------------------------------------------- |
10da75d0 | 465 | |
15b6757b FM |
466 | CLASS_DIAGRAMS = YES |
467 | MSCGEN_PATH = | |
468 | HIDE_UNDOC_RELATIONS = YES | |
469 | HAVE_DOT = YES | |
0d0dc584 BP |
470 | DOT_FONTNAME = FreeSans |
471 | DOT_FONTSIZE = 10 | |
3051a44a | 472 | DOT_FONTPATH = |
0d0dc584 | 473 | CLASS_GRAPH = YES |
15b6757b FM |
474 | COLLABORATION_GRAPH = NO |
475 | GROUP_GRAPHS = NO | |
476 | UML_LOOK = NO | |
477 | TEMPLATE_RELATIONS = NO | |
478 | INCLUDE_GRAPH = NO | |
479 | INCLUDED_BY_GRAPH = NO | |
480 | CALL_GRAPH = NO | |
481 | CALLER_GRAPH = NO | |
482 | GRAPHICAL_HIERARCHY = NO | |
483 | DIRECTORY_GRAPH = NO | |
484 | DOT_IMAGE_FORMAT = png | |
6783cae4 | 485 | DOTFILE_DIRS = |
15b6757b FM |
486 | DOT_GRAPH_MAX_NODES = 50 |
487 | MAX_DOT_GRAPH_DEPTH = 1000 | |
488 | DOT_TRANSPARENT = NO | |
489 | DOT_MULTI_TARGETS = NO | |
490 | GENERATE_LEGEND = YES | |
491 | DOT_CLEANUP = YES | |
492 | ||
2d283194 FM |
493 | # instead of setting a value for DOT_PATH it's easier and more portable to |
494 | # put your dot utility in the PATH; if you are on a Unix system this is usually | |
495 | # done automatically; if you're on Windows you'll need to install GraphViz tools | |
496 | # and then manually add it to the PATH environment variable | |
497 | DOT_PATH = | |
498 | ||
15b6757b | 499 | #--------------------------------------------------------------------------- |
10da75d0 | 500 | # Search Engine Options |
15b6757b | 501 | #--------------------------------------------------------------------------- |
10da75d0 | 502 | |
2a6585b8 BP |
503 | SEARCHENGINE = NO |
504 |