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