3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING = UTF-8
9 # OUTPUT_DIRECTORY = later
11 OUTPUT_LANGUAGE = English
12 BRIEF_MEMBER_DESC = YES
15 ALWAYS_DETAILED_SEC = NO
16 INLINE_INHERITED_MEMB = NO
21 JAVADOC_AUTOBRIEF = YES
23 MULTILINE_CPP_IS_BRIEF = NO
26 SEPARATE_MEMBER_PAGES = NO
30 "thread=@par Thread Context:\n" \
31 "vmstate=@par VM State In:\n" \
32 "vmstateto=@par VM State Out:\n"
34 # Interface method implementation macros.
36 interface_method_impl{2}="Implements \1 method \link \1::\2 \2 \endlink @copydoc \1::\2 "
38 interface_method_impl{3}="\3. \
40 Implements \1 method \link \1::\2 \2 \endlink @copydoc \1::\2 "
42 # Callback method implementation macros.
44 callback_method_impl{1}="Implements the callback \link \1 \1 \endlink @copydoc \1 "
46 callback_method_impl{2}="\2. \
48 Implements the callback \link \1 \1 "
50 # The following is for Global Configuration options.
52 gcfgm{6}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
53 <b>Name:</b> \1 <br> \
54 <b>Type:</b> \2 <br> \
55 <b>Unit:</b> \6 <br> \
58 <b>Default:</b> \5 <br> \
61 gcfgm{5}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
62 <b>Name:</b> \1 <br> \
63 <b>Type:</b> \2 <br> \
66 <b>Default:</b> \5 <br> \
69 gcfgm{4}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
70 <b>Name:</b> \1 <br> \
71 <b>Type:</b> \2 <br> \
76 gcfgm{3}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
77 <b>Name:</b> \1 <br> \
78 <b>Type:</b> \2 <br> \
79 <b>Default:</b> \3 <br> \
82 gcfgm{2}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
83 <b>Name:</b> \1 <br> \
84 <b>Type:</b> \2 <br> \
87 # The following is for per-VM Configuration options.
89 cfgm{6}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
90 <b>Name:</b> \1 <br> \
91 <b>Type:</b> \2 <br> \
92 <b>Unit:</b> \6 <br> \
95 <b>Default:</b> \5 <br> \
98 cfgm{5}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
99 <b>Name:</b> \1 <br> \
100 <b>Type:</b> \2 <br> \
101 <b>Min:</b> \3 <br> \
102 <b>Max:</b> \4 <br> \
103 <b>Default:</b> \5 <br> \
106 cfgm{4}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
107 <b>Name:</b> \1 <br> \
108 <b>Type:</b> \2 <br> \
109 <b>Min:</b> \3 <br> \
110 <b>Max:</b> \4 <br> \
113 cfgm{3}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
114 <b>Name:</b> \1 <br> \
115 <b>Type:</b> \2 <br> \
116 <b>Default:</b> \3 <br> \
119 cfgm{2}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
120 <b>Name:</b> \1 <br> \
121 <b>Type:</b> \2 <br> \
124 # The following is for device configuration options.
126 devcfgm{6}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
127 <b>Name:</b> [Device Instance]/\1 <br> \
128 <b>Type:</b> \2 <br> \
129 <b>Unit:</b> \6 <br> \
130 <b>Min:</b> \3 <br> \
131 <b>Max:</b> \4 <br> \
132 <b>Default:</b> \5 <br> \
135 devcfgm{5}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
136 <b>Name:</b> [Device Instance]/\1 <br> \
137 <b>Type:</b> \2 <br> \
138 <b>Min:</b> \3 <br> \
139 <b>Max:</b> \4 <br> \
140 <b>Default:</b> \5 <br> \
143 devcfgm{4}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
144 <b>Name:</b> [Device Instance]/\1 <br> \
145 <b>Type:</b> \2 <br> \
146 <b>Min:</b> \3 <br> \
147 <b>Max:</b> \4 <br> \
150 devcfgm{3}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
151 <b>Name:</b> [Device Instance]/\1 <br> \
152 <b>Type:</b> \2 <br> \
153 <b>Default:</b> \3 <br> \
156 devcfgm{2}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
157 <b>Name:</b> [Device Instance]/\1 <br> \
158 <b>Type:</b> \2 <br> \
161 # The following is for driver configuration options.
163 drvcfgm{6}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
164 <b>Name:</b> [Driver Instance]/\1 <br> \
165 <b>Type:</b> \2 <br> \
166 <b>Unit:</b> \6 <br> \
167 <b>Min:</b> \3 <br> \
168 <b>Max:</b> \4 <br> \
169 <b>Default:</b> \5 <br> \
172 drvcfgm{5}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
173 <b>Name:</b> [Driver Instance]/\1 <br> \
174 <b>Type:</b> \2 <br> \
175 <b>Min:</b> \3 <br> \
176 <b>Max:</b> \4 <br> \
177 <b>Default:</b> \5 <br> \
180 drvcfgm{4}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
181 <b>Name:</b> [Driver Instance]/\1 <br> \
182 <b>Type:</b> \2 <br> \
183 <b>Min:</b> \3 <br> \
184 <b>Max:</b> \4 <br> \
187 drvcfgm{3}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
188 <b>Name:</b> [Driver Instance]/\1 <br> \
189 <b>Type:</b> \2 <br> \
190 <b>Default:</b> \3 <br> \
193 drvcfgm{2}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
194 <b>Name:</b> [Driver Instance]/\1 <br> \
195 <b>Type:</b> \2 <br> \
198 # The following is for USB device configuration options.
200 usbcfgm{6}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
201 <b>Name:</b> [USB Device Instance]/\1 <br> \
202 <b>Type:</b> \2 <br> \
203 <b>Unit:</b> \6 <br> \
204 <b>Min:</b> \3 <br> \
205 <b>Max:</b> \4 <br> \
206 <b>Default:</b> \5 <br> \
209 usbcfgm{5}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
210 <b>Name:</b> [USB Device Instance]/\1 <br> \
211 <b>Type:</b> \2 <br> \
212 <b>Min:</b> \3 <br> \
213 <b>Max:</b> \4 <br> \
214 <b>Default:</b> \5 <br> \
217 usbcfgm{4}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
218 <b>Name:</b> [USB Device Instance]/\1 <br> \
219 <b>Type:</b> \2 <br> \
220 <b>Min:</b> \3 <br> \
221 <b>Max:</b> \4 <br> \
224 usbcfgm{3}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
225 <b>Name:</b> [USB Device Instance]/\1 <br> \
226 <b>Type:</b> \2 <br> \
227 <b>Default:</b> \3 <br> \
230 usbcfgm{2}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
231 <b>Name:</b> [USB Device Instance]/\1 <br> \
232 <b>Type:</b> \2 <br> \
235 # bugref - xTracker bug reference, takes one to four bug numbers.
236 ALIASES += bugref{1}="https://xtracker.innotek.de/index.php?bug=\1"
237 ALIASES += bugref{2}="https://xtracker.innotek.de/index.php?bug=\1, \
238 https://xtracker.innotek.de/index.php?bug=\2"
239 ALIASES += bugref{3}="https://xtracker.innotek.de/index.php?bug=\1, \
240 https://xtracker.innotek.de/index.php?bug=\2, \
241 https://xtracker.innotek.de/index.php?bug=\3"
242 ALIASES += bugref{4}="https://xtracker.innotek.de/index.php?bug=\1, \
243 https://xtracker.innotek.de/index.php?bug=\2, \
244 https://xtracker.innotek.de/index.php?bug=\3, \
245 https://xtracker.innotek.de/index.php?bug=\4"
247 # ticketref - Track ticket reference, takes one to four ticket numbers.
248 ALIASES += ticketref{1}="http://www.virtualbox.org/ticket/\1"
249 ALIASES += ticketref{2}="http://www.virtualbox.org/ticket/\1, \
250 http://www.virtualbox.org/ticket/\2"
251 ALIASES += ticketref{3}="http://www.virtualbox.org/ticket/\1, \
252 http://www.virtualbox.org/ticket/\2, \
253 http://www.virtualbox.org/ticket/\3"
254 ALIASES += ticketref{4}="http://www.virtualbox.org/ticket/\1, \
255 http://www.virtualbox.org/ticket/\2, \
256 http://www.virtualbox.org/ticket/\3, \
257 http://www.virtualbox.org/ticket/\4"
260 OPTIMIZE_OUTPUT_FOR_C = YES
261 OPTIMIZE_OUTPUT_JAVA = NO
262 BUILTIN_STL_SUPPORT = NO
265 DISTRIBUTE_GROUP_DOC = NO
267 TYPEDEF_HIDES_STRUCT = NO
269 #---------------------------------------------------------------------------
270 # Build related configuration options
271 #---------------------------------------------------------------------------
273 EXTRACT_PRIVATE = YES
275 EXTRACT_LOCAL_CLASSES = YES
276 EXTRACT_LOCAL_METHODS = NO
277 EXTRACT_ANON_NSPACES = NO
278 HIDE_UNDOC_MEMBERS = NO
279 HIDE_UNDOC_CLASSES = NO
280 HIDE_FRIEND_COMPOUNDS = NO
281 HIDE_IN_BODY_DOCS = NO
283 CASE_SENSE_NAMES = NO
284 HIDE_SCOPE_NAMES = NO
285 SHOW_INCLUDE_FILES = YES
287 SORT_MEMBER_DOCS = YES
289 SORT_BY_SCOPE_NAME = NO
290 GENERATE_TODOLIST = YES
291 GENERATE_TESTLIST = YES
292 GENERATE_BUGLIST = YES
293 GENERATE_DEPRECATEDLIST= YES
295 MAX_INITIALIZER_LINES = 30
296 SHOW_USED_FILES = YES
297 SHOW_DIRECTORIES = NO
298 FILE_VERSION_FILTER =
300 #---------------------------------------------------------------------------
301 # configuration options related to warning and progress messages
302 #---------------------------------------------------------------------------
305 ##Later: WARN_IF_UNDOCUMENTED = YES
306 WARN_IF_UNDOCUMENTED = NO
307 WARN_IF_DOC_ERROR = YES
308 WARN_NO_PARAMDOC = NO
309 WARN_FORMAT = "$file:$line: $text"
310 #WARN_LOGFILE = later
312 #---------------------------------------------------------------------------
313 # configuration options related to the input files
314 #---------------------------------------------------------------------------
316 INPUT_ENCODING = UTF-8
320 EXCLUDE_SYMLINKS = NO
325 EXAMPLE_RECURSIVE = NO
328 doc/tg/Networking-diagrams \
329 doc/tg/USB-diagrams \
334 FILTER_SOURCE_FILES = NO
336 #---------------------------------------------------------------------------
337 # configuration options related to source browsing
338 #---------------------------------------------------------------------------
341 STRIP_CODE_COMMENTS = YES
342 REFERENCED_BY_RELATION = YES
343 REFERENCES_RELATION = YES
344 REFERENCES_LINK_SOURCE = YES
346 VERBATIM_HEADERS = YES
348 #---------------------------------------------------------------------------
349 # configuration options related to the alphabetical class index
350 #---------------------------------------------------------------------------
351 ALPHABETICAL_INDEX = NO
352 COLS_IN_ALPHA_INDEX = 5
355 #---------------------------------------------------------------------------
356 # configuration options related to the HTML output
357 #---------------------------------------------------------------------------
360 HTML_FILE_EXTENSION = .html
364 HTML_ALIGN_MEMBERS = YES
365 GENERATE_HTMLHELP = NO
366 HTML_DYNAMIC_SECTIONS = NO
373 ENUM_VALUES_PER_LINE = 4
374 GENERATE_TREEVIEW = NO
377 #---------------------------------------------------------------------------
378 # configuration options related to the LaTeX output
379 #---------------------------------------------------------------------------
382 LATEX_CMD_NAME = latex
383 MAKEINDEX_CMD_NAME = makeindex
391 LATEX_HIDE_INDICES = NO
393 #---------------------------------------------------------------------------
394 # configuration options related to the RTF output
395 #---------------------------------------------------------------------------
400 RTF_STYLESHEET_FILE =
401 RTF_EXTENSIONS_FILE =
403 #---------------------------------------------------------------------------
404 # configuration options related to the man page output
405 #---------------------------------------------------------------------------
411 #---------------------------------------------------------------------------
412 # configuration options related to the XML output
413 #---------------------------------------------------------------------------
418 XML_PROGRAMLISTING = YES
420 #---------------------------------------------------------------------------
421 # configuration options for the AutoGen Definitions output
422 #---------------------------------------------------------------------------
423 GENERATE_AUTOGEN_DEF = NO
425 #---------------------------------------------------------------------------
426 # configuration options related to the Perl module output
427 #---------------------------------------------------------------------------
428 GENERATE_PERLMOD = NO
431 PERLMOD_MAKEVAR_PREFIX =
433 #---------------------------------------------------------------------------
434 # Configuration options related to the preprocessor
435 #---------------------------------------------------------------------------
436 ENABLE_PREPROCESSING = YES
437 MACRO_EXPANSION = YES
438 EXPAND_ONLY_PREDEF = YES
439 SEARCH_INCLUDES = YES
440 # INCLUDE_PATH = later
441 # INCLUDE_FILE_PATTERNS = later
447 AssertCompileNS(expr) \
448 AssertCompile(expr) \
449 AssertCompileSize(type, size) \
450 AssertCompileSizeAlignment(type, align) \
451 AssertCompileMemberAlignment(type, member, align) \
452 AssertCompileMemberOffset(type, member, off) \
453 AssertCompile2MemberOffsets(type, member1, member2) \
454 AssertCompileAdjacentMembers(type, member1, member2) \
455 AssertCompileMembersAtSameOffset(type1, member1, type2, member2) \
456 AssertCompileMemberSize(type, member, size) \
457 AssertCompileMemberSizeAlignment(type, member, align) \
458 AssertCompileMembersSameSize(type1, member1, type2, member2) \
459 AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)
462 PREDEFINED += RCPTRTYPE(RCType)=RCType
463 PREDEFINED += R3PTRTYPE(R3Type)=R3Type
464 PREDEFINED += R0PTRTYPE(R0Type)=R0Type
465 PREDEFINED += HCPTRTYPE(HCType)=HCType
466 PREDEFINED += R3R0PTRTYPE(R3R0Type)=R3R0Type
467 # Compile assertion hacks.
469 AssertCompile(expr) \
470 AssertCompileSize(a,b) \
471 AssertCompileSizeAlignment(a,b) \
472 AssertCompileMemberSizeAlignment(a,b,c) \
473 AssertCompileMemberAlignment(a,b,c) \
474 AssertCompileMemberOffset(a,b,c) \
475 AssertCompile2MemberOffsets(a,b,c)
477 PREDEFINED += STDMETHODIMP=HRESULT
478 PREDEFINED += "COMGETTER(n)=get_##n"
479 PREDEFINED += "COMSETTER(n)=set_##n"
480 # COM hacks from From http://www.stack.nl/~dimitri/doxygen/preprocessing.html
481 PREDEFINED += "DECLARE_INTERFACE(name)=class name" \
482 "STDMETHOD_(result,name)=virtual result name" \
486 DECLARE_REGISTRY_RESOURCEID=// \
487 DECLARE_PROTECT_FINAL_CONSTRUCT=// \
488 "DECLARE_AGGREGATABLE(Class)= " \
489 "DECLARE_REGISTRY_RESOURCEID(Id)= " \
490 DECLARE_MESSAGE_MAP= \
491 BEGIN_MESSAGE_MAP=/* \
492 END_MESSAGE_MAP=*/// \
499 BEGIN_PROPERTY_MAP=/* \
500 END_PROPERTY_MAP=*/// \
501 BEGIN_OBJECT_MAP=/* \
502 END_OBJECT_MAP()=*/// \
503 DECLARE_VIEW_STATUS=// \
504 "STDMETHOD(a)=HRESULT a" \
507 BEGIN_CONNECTION_POINT_MAP=/* \
508 END_CONNECTION_POINT_MAP=*/// \
509 "DECLARE_DYNAMIC(class)= " \
510 "IMPLEMENT_DYNAMIC(class1, class2)= " \
511 "DECLARE_DYNCREATE(class)= " \
512 "IMPLEMENT_DYNCREATE(class1, class2)= " \
513 "IMPLEMENT_SERIAL(class1, class2, class3)= " \
514 "DECLARE_MESSAGE_MAP()= " \
516 "CATCH_ALL(e)= catch(...)" \
518 "THROW_LAST()= throw"\
519 "RUNTIME_CLASS(class)=class" \
520 "MAKEINTRESOURCE(nId)=nId" \
521 "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
522 "ASSERT(x)=assert(x)" \
523 "ASSERT_VALID(x)=assert(x)" \
524 "TRACE0(x)=printf(x)" \
525 "OS_ERR(A,B)={ #A, B }" \
527 "DECLARE_OLECREATE(class)= " \
528 "BEGIN_DISPATCH_MAP(class1, class2)= " \
529 "BEGIN_INTERFACE_MAP(class1, class2)= " \
530 "INTERFACE_PART(class, id, name)= " \
531 "END_INTERFACE_MAP()=" \
532 "DISP_FUNCTION(class, name, function, result, id)=" \
533 "END_DISPATCH_MAP()=" \
534 "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4,\
535 id5, id6, id7, id8, id9, id10, id11)="
537 EXPAND_AS_DEFINED = \
556 DECLHCCALLBACKMEMBER \
557 DECLRCCALLBACKMEMBER \
558 DECLR3CALLBACKMEMBER \
559 DECLR0CALLBACKMEMBER \
607 SKIP_FUNCTION_MACROS = NO
609 #---------------------------------------------------------------------------
610 # Configuration::additions related to external references
611 #---------------------------------------------------------------------------
615 EXTERNAL_GROUPS = YES
616 PERL_PATH = /usr/bin/perl
618 #---------------------------------------------------------------------------
619 # Configuration options related to the dot tool
620 #---------------------------------------------------------------------------
623 HIDE_UNDOC_RELATIONS = YES
626 COLLABORATION_GRAPH = YES
629 TEMPLATE_RELATIONS = YES
631 INCLUDED_BY_GRAPH = YES
634 GRAPHICAL_HIERARCHY = YES
635 DIRECTORY_GRAPH = YES
636 DOT_IMAGE_FORMAT = png
639 DOT_GRAPH_MAX_NODES = 50
640 MAX_DOT_GRAPH_DEPTH = 0
641 DOT_TRANSPARENT = YES
642 DOT_MULTI_TARGETS = NO
643 GENERATE_LEGEND = YES
646 #---------------------------------------------------------------------------
647 # Configuration::additions related to the search engine
648 #---------------------------------------------------------------------------