VirtualBox

source: vbox/trunk/Doxyfile.Core@ 94618

Last change on this file since 94618 was 94618, checked in by vboxsync, 2 years ago

/Doxyfile.Core,/Makefile.kmk: Do IEM*cpp.cpp.h files.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 32.9 KB
Line 
1# Doxyfile 1.8.9
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = VBox
8PROJECT_NUMBER =
9PROJECT_BRIEF =
10PROJECT_LOGO =
11# OUTPUT_DIRECTORY = later
12CREATE_SUBDIRS = NO
13ALLOW_UNICODE_NAMES = NO
14OUTPUT_LANGUAGE = English
15BRIEF_MEMBER_DESC = YES
16REPEAT_BRIEF = YES
17ABBREVIATE_BRIEF =
18ALWAYS_DETAILED_SEC = NO
19INLINE_INHERITED_MEMB = NO
20FULL_PATH_NAMES = NO
21STRIP_FROM_PATH =
22STRIP_FROM_INC_PATH =
23SHORT_NAMES = NO
24JAVADOC_AUTOBRIEF = YES
25QT_AUTOBRIEF = NO
26MULTILINE_CPP_IS_BRIEF = NO
27INHERIT_DOCS = YES
28SEPARATE_MEMBER_PAGES = NO
29TAB_SIZE = 4
30ALIASES = \
31 "note=@remark" \
32 "thread=@par Thread Context:^^" \
33 "vmstate=@par VM State In:^^" \
34 "vmstateto=@par VM State Out:^^"
35
36# Input / output paragraphs.
37ALIASES += \
38 "output=@par Output:^^" \
39 "input=@par Input:^^"
40
41# Interface method implementation macros.
42ALIASES += \
43 interface_method_impl{2}="Implements \1 method \link \1::\2 \2 \endlink @copydoc \1::\2 "
44ALIASES += \
45 interface_method_impl{3}="\3. \
46\
47Implements \1 method \link \1::\2 \2 \endlink @copydoc \1::\2 "
48
49# Callback method implementation macros.
50ALIASES += \
51 callback_method_impl{2}="\2. \
52\
53Implements the callback \link \1 \1 \endlink "
54ALIASES += \
55 callback_method_impl{1}="Implements the callback \link \1 \1 \endlink @copydoc \1 "
56
57# The following is for Global Configuration options.
58ALIASES += \
59 gcfgm{6}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
60<b>Name:</b> \1 <br> \
61<b>Type:</b> \2 <br> \
62<b>Unit:</b> \6 <br> \
63<b>Min:</b> \3 <br> \
64<b>Max:</b> \4 <br> \
65<b>Default:</b> \5 <br> \
66"
67ALIASES += \
68 gcfgm{5}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
69<b>Name:</b> \1 <br> \
70<b>Type:</b> \2 <br> \
71<b>Min:</b> \3 <br> \
72<b>Max:</b> \4 <br> \
73<b>Default:</b> \5 <br> \
74"
75ALIASES += \
76 gcfgm{4}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
77<b>Name:</b> \1 <br> \
78<b>Type:</b> \2 <br> \
79<b>Min:</b> \3 <br> \
80<b>Max:</b> \4 <br> \
81"
82ALIASES += \
83 gcfgm{3}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
84<b>Name:</b> \1 <br> \
85<b>Type:</b> \2 <br> \
86<b>Default:</b> \3 <br> \
87"
88ALIASES += \
89 gcfgm{2}="\xrefitem lst_gcfgm \"Global VM Config: \1\" \"Global Configuration Values\" \
90<b>Name:</b> \1 <br> \
91<b>Type:</b> \2 <br> \
92"
93
94# The following is for per-VM Configuration options.
95ALIASES += \
96 cfgm{6}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
97<b>Name:</b> \1 <br> \
98<b>Type:</b> \2 <br> \
99<b>Unit:</b> \6 <br> \
100<b>Min:</b> \3 <br> \
101<b>Max:</b> \4 <br> \
102<b>Default:</b> \5 <br> \
103"
104ALIASES += \
105 cfgm{5}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
106<b>Name:</b> \1 <br> \
107<b>Type:</b> \2 <br> \
108<b>Min:</b> \3 <br> \
109<b>Max:</b> \4 <br> \
110<b>Default:</b> \5 <br> \
111"
112ALIASES += \
113 cfgm{4}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
114<b>Name:</b> \1 <br> \
115<b>Type:</b> \2 <br> \
116<b>Min:</b> \3 <br> \
117<b>Max:</b> \4 <br> \
118"
119ALIASES += \
120 cfgm{3}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
121<b>Name:</b> \1 <br> \
122<b>Type:</b> \2 <br> \
123<b>Default:</b> \3 <br> \
124"
125ALIASES += \
126 cfgm{2}="\xrefitem lst_cfgm \"VM Config: \1\" \"VM Configuration Values\" \
127<b>Name:</b> \1 <br> \
128<b>Type:</b> \2 <br> \
129"
130
131# The following is for device configuration options.
132ALIASES += \
133 devcfgm{7}="\xrefitem lst_cfgm \"Device Config: \1/\2\" \"VM Configuration Values\" \
134<b>Name:</b> /Devices/\1/#/Config/\2 <br> \
135<b>Type:</b> \3 <br> \
136<b>Unit:</b> \7 <br> \
137<b>Min:</b> \4 <br> \
138<b>Max:</b> \5 <br> \
139<b>Default:</b> \6 <br> \
140"
141ALIASES += \
142 devcfgm{6}="\xrefitem lst_cfgm \"Device Config: \1/\2\" \"VM Configuration Values\" \
143<b>Name:</b> /Devices/\1/#1/Config/\2 <br> \
144<b>Type:</b> \3 <br> \
145<b>Min:</b> \4 <br> \
146<b>Max:</b> \5 <br> \
147<b>Default:</b> \6 <br> \
148"
149ALIASES += \
150 devcfgm{5}="\xrefitem lst_cfgm \"Device Config: \1/\2\" \"VM Configuration Values\" \
151<b>Name:</b> /Devices\1/#1/Config/\2 <br> \
152<b>Type:</b> \3 <br> \
153<b>Min:</b> \4 <br> \
154<b>Max:</b> \5 <br> \
155"
156ALIASES += \
157 devcfgm{4}="\xrefitem lst_cfgm \"Device Config: \1/\2\" \"VM Configuration Values\" \
158<b>Name:</b> /Devices\1/#1/Config/\2 <br> \
159<b>Type:</b> \3 <br> \
160<b>Default:</b> \4 <br> \
161"
162ALIASES += \
163 devcfgm{3}="\xrefitem lst_cfgm \"Device Config: \1/\2\" \"VM Configuration Values\" \
164<b>Name:</b> /Devices\1/#1/Config/\2 <br> \
165<b>Type:</b> \3 <br> \
166"
167
168# The following is for driver configuration options.
169ALIASES += \
170 drvcfgm{6}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
171<b>Name:</b> [Driver Instance]/\1 <br> \
172<b>Type:</b> \2 <br> \
173<b>Unit:</b> \6 <br> \
174<b>Min:</b> \3 <br> \
175<b>Max:</b> \4 <br> \
176<b>Default:</b> \5 <br> \
177"
178ALIASES += \
179 drvcfgm{5}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
180<b>Name:</b> [Driver Instance]/\1 <br> \
181<b>Type:</b> \2 <br> \
182<b>Min:</b> \3 <br> \
183<b>Max:</b> \4 <br> \
184<b>Default:</b> \5 <br> \
185"
186ALIASES += \
187 drvcfgm{4}="\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>Min:</b> \3 <br> \
191<b>Max:</b> \4 <br> \
192"
193ALIASES += \
194 drvcfgm{3}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
195<b>Name:</b> [Driver Instance]/\1 <br> \
196<b>Type:</b> \2 <br> \
197<b>Default:</b> \3 <br> \
198"
199ALIASES += \
200 drvcfgm{2}="\xrefitem lst_cfgm \"Driver Config: \1\" \"VM Configuration Values\" \
201<b>Name:</b> [Driver Instance]/\1 <br> \
202<b>Type:</b> \2 <br> \
203"
204
205# The following is for USB device configuration options.
206ALIASES += \
207 usbcfgm{6}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
208<b>Name:</b> [USB Device Instance]/\1 <br> \
209<b>Type:</b> \2 <br> \
210<b>Unit:</b> \6 <br> \
211<b>Min:</b> \3 <br> \
212<b>Max:</b> \4 <br> \
213<b>Default:</b> \5 <br> \
214"
215ALIASES += \
216 usbcfgm{5}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
217<b>Name:</b> [USB Device Instance]/\1 <br> \
218<b>Type:</b> \2 <br> \
219<b>Min:</b> \3 <br> \
220<b>Max:</b> \4 <br> \
221<b>Default:</b> \5 <br> \
222"
223ALIASES += \
224 usbcfgm{4}="\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>Min:</b> \3 <br> \
228<b>Max:</b> \4 <br> \
229"
230ALIASES += \
231 usbcfgm{3}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
232<b>Name:</b> [USB Device Instance]/\1 <br> \
233<b>Type:</b> \2 <br> \
234<b>Default:</b> \3 <br> \
235"
236ALIASES += \
237 usbcfgm{2}="\xrefitem lst_cfgm \"USB Device Config: \1\" \"VM Configuration Values\" \
238<b>Name:</b> [USB Device Instance]/\1 <br> \
239<b>Type:</b> \2 <br> \
240"
241
242# UDF spec reference - 1=section, 2=page
243ALIASES += udf260{2}="<a href=\"http://www.osta.org/specs/pdf/udf260.pdf#page=\2\">UDF-2.60:\1</a>"
244# Generic ECMA spec reference - 1=spec-number 2=section, 3=page
245ALIASES += ecma{3}="<a href=\"https://www.ecma-international.org/publications/files/ECMA-ST/Ecma-\1.pdf#page=\3\">ECMA-\1:\2</a>"
246# ECMA-167 spec reference - 1=part 2=section, 3=page
247ALIASES += ecma167{3}="\ecma{167,Part\1/\2,\3}"
248
249# For IEM opcode specs.
250ALIASES += opbrief=""
251ALIASES += opdesc=""
252ALIASES += opmnemonic="Mnemonic: "
253ALIASES += op1="Operand \#1: "
254ALIASES += op2="Operand \#2: "
255ALIASES += op3="Operand \#3: "
256ALIASES += op4="Operand \#4: "
257ALIASES += oppfx="Req.Prefix: "
258ALIASES += opmaps="Opcode Maps: "
259ALIASES += opcode="Opcode Byte: "
260ALIASES += opcodesub="Opcode Sub-Byte: "
261ALIASES += openc="Encoding: "
262ALIASES += opfltest="EFLAGS Tested: "
263ALIASES += opflmodify="EFLAGS Modified: "
264ALIASES += opflundef="EFLAGS Undefined: "
265ALIASES += opflset="EFLAGS Set: "
266ALIASES += opflclear="EFLAGS Cleared: "
267ALIASES += ophints="Hints, Flags, ++: "
268ALIASES += opdisenum="Disassembler Enum: "
269ALIASES += opmincpu="Minimum CPU: "
270ALIASES += opcpuid="CPUID: "
271ALIASES += opxcpttype="Exception Type: "
272ALIASES += opgroup="@ingroup "
273ALIASES += opunused="Unused Encoding: "
274ALIASES += opinvalid="Invalid Encoding: "
275ALIASES += opinvlstyle="Invalid/Unused Encoding Style: "
276ALIASES += optest="Testcase: "
277ALIASES += opcopytests="Testcase: Same as "
278ALIASES += opstats="IEM Stats:"
279ALIASES += opfunction="IEM Function"
280ALIASES += opdone="-------------------------"
281
282
283# bugref - xTracker bug reference, takes one to four bug numbers.
284ALIASES += bugref{1}="https://xtracker.innotek.de/index.php?bug=\1"
285ALIASES += bugref{2}="https://xtracker.innotek.de/index.php?bug=\1, \
286https://xtracker.innotek.de/index.php?bug=\2"
287ALIASES += bugref{3}="https://xtracker.innotek.de/index.php?bug=\1, \
288https://xtracker.innotek.de/index.php?bug=\2, \
289https://xtracker.innotek.de/index.php?bug=\3"
290ALIASES += bugref{4}="https://xtracker.innotek.de/index.php?bug=\1, \
291https://xtracker.innotek.de/index.php?bug=\2, \
292https://xtracker.innotek.de/index.php?bug=\3, \
293https://xtracker.innotek.de/index.php?bug=\4"
294
295# ticketref - Track ticket reference, takes one to four ticket numbers.
296ALIASES += ticketref{1}="http://www.virtualbox.org/ticket/\1"
297ALIASES += ticketref{2}="http://www.virtualbox.org/ticket/\1, \
298http://www.virtualbox.org/ticket/\2"
299ALIASES += ticketref{3}="http://www.virtualbox.org/ticket/\1, \
300http://www.virtualbox.org/ticket/\2, \
301http://www.virtualbox.org/ticket/\3"
302ALIASES += ticketref{4}="http://www.virtualbox.org/ticket/\1, \
303http://www.virtualbox.org/ticket/\2, \
304http://www.virtualbox.org/ticket/\3, \
305http://www.virtualbox.org/ticket/\4"
306
307
308OPTIMIZE_OUTPUT_FOR_C = YES
309OPTIMIZE_OUTPUT_JAVA = NO
310OPTIMIZE_FOR_FORTRAN = NO
311OPTIMIZE_OUTPUT_VHDL = NO
312EXTENSION_MAPPING =
313MARKDOWN_SUPPORT = YES
314AUTOLINK_SUPPORT = YES
315BUILTIN_STL_SUPPORT = NO
316CPP_CLI_SUPPORT = NO
317SIP_SUPPORT = NO
318IDL_PROPERTY_SUPPORT = YES
319DISTRIBUTE_GROUP_DOC = NO
320SUBGROUPING = YES
321INLINE_GROUPED_CLASSES = NO
322INLINE_SIMPLE_STRUCTS = NO
323TYPEDEF_HIDES_STRUCT = NO
324LOOKUP_CACHE_SIZE = 0
325#---------------------------------------------------------------------------
326# Build related configuration options
327#---------------------------------------------------------------------------
328EXTRACT_ALL = YES
329EXTRACT_PRIVATE = YES
330EXTRACT_PACKAGE = NO
331EXTRACT_STATIC = YES
332EXTRACT_LOCAL_CLASSES = YES
333EXTRACT_LOCAL_METHODS = NO
334EXTRACT_ANON_NSPACES = NO
335HIDE_UNDOC_MEMBERS = NO
336HIDE_UNDOC_CLASSES = NO
337HIDE_FRIEND_COMPOUNDS = NO
338HIDE_IN_BODY_DOCS = NO
339INTERNAL_DOCS = YES
340CASE_SENSE_NAMES = NO
341HIDE_SCOPE_NAMES = NO
342HIDE_COMPOUND_REFERENCE= NO
343SHOW_INCLUDE_FILES = YES
344SHOW_GROUPED_MEMB_INC = NO
345FORCE_LOCAL_INCLUDES = NO
346INLINE_INFO = YES
347SORT_MEMBER_DOCS = YES
348SORT_BRIEF_DOCS = NO
349SORT_MEMBERS_CTORS_1ST = NO
350SORT_GROUP_NAMES = NO
351SORT_BY_SCOPE_NAME = NO
352STRICT_PROTO_MATCHING = NO
353GENERATE_TODOLIST = YES
354GENERATE_TESTLIST = YES
355GENERATE_BUGLIST = YES
356GENERATE_DEPRECATEDLIST= YES
357ENABLED_SECTIONS =
358MAX_INITIALIZER_LINES = 30
359SHOW_USED_FILES = YES
360SHOW_FILES = YES
361SHOW_NAMESPACES = YES
362FILE_VERSION_FILTER =
363LAYOUT_FILE =
364CITE_BIB_FILES =
365#---------------------------------------------------------------------------
366# Configuration options related to warning and progress messages
367#---------------------------------------------------------------------------
368QUIET = YES
369WARNINGS = YES
370##Later: WARN_IF_UNDOCUMENTED = YES
371WARN_IF_UNDOCUMENTED = NO
372WARN_IF_DOC_ERROR = YES
373WARN_NO_PARAMDOC = NO
374WARN_FORMAT = "$file:$line: $text"
375#WARN_LOGFILE = later
376#---------------------------------------------------------------------------
377# Configuration options related to the input files
378#---------------------------------------------------------------------------
379# INPUT = later
380INPUT_ENCODING = UTF-8
381FILE_PATTERNS =
382RECURSIVE = NO
383EXCLUDE =
384EXCLUDE_SYMLINKS = NO
385EXCLUDE_PATTERNS =
386EXCLUDE_SYMBOLS =
387EXAMPLE_PATH =
388EXAMPLE_PATTERNS =
389EXAMPLE_RECURSIVE = NO
390IMAGE_PATH = \
391 doc \
392 doc/tg/Networking-diagrams \
393 doc/tg/USB-diagrams \
394 doc/tg/diagrams \
395 doc/VMM
396INPUT_FILTER =
397FILTER_PATTERNS =
398FILTER_SOURCE_FILES = NO
399FILTER_SOURCE_PATTERNS =
400USE_MDFILE_AS_MAINPAGE =
401#---------------------------------------------------------------------------
402# Configuration options related to source browsing
403#---------------------------------------------------------------------------
404SOURCE_BROWSER = NO
405INLINE_SOURCES = NO
406STRIP_CODE_COMMENTS = YES
407REFERENCED_BY_RELATION = YES
408REFERENCES_RELATION = YES
409REFERENCES_LINK_SOURCE = YES
410SOURCE_TOOLTIPS = YES
411USE_HTAGS = NO
412VERBATIM_HEADERS = YES
413CLANG_ASSISTED_PARSING = NO
414CLANG_OPTIONS =
415#---------------------------------------------------------------------------
416# Configuration options related to the alphabetical class index
417#---------------------------------------------------------------------------
418ALPHABETICAL_INDEX = NO
419COLS_IN_ALPHA_INDEX = 5
420IGNORE_PREFIX =
421#---------------------------------------------------------------------------
422# Configuration options related to the HTML output
423#---------------------------------------------------------------------------
424GENERATE_HTML = YES
425HTML_OUTPUT = html
426HTML_FILE_EXTENSION = .html
427HTML_HEADER =
428HTML_FOOTER =
429HTML_STYLESHEET =
430HTML_EXTRA_STYLESHEET =
431HTML_EXTRA_FILES =
432HTML_COLORSTYLE_HUE = 220
433HTML_COLORSTYLE_SAT = 100
434HTML_COLORSTYLE_GAMMA = 80
435HTML_TIMESTAMP = YES
436HTML_DYNAMIC_SECTIONS = NO
437HTML_INDEX_NUM_ENTRIES = 100
438GENERATE_DOCSET = NO
439DOCSET_FEEDNAME = "Doxygen generated docs"
440DOCSET_BUNDLE_ID = org.doxygen.Project
441DOCSET_PUBLISHER_ID = org.doxygen.Publisher
442DOCSET_PUBLISHER_NAME = Publisher
443GENERATE_HTMLHELP = NO
444CHM_FILE =
445HHC_LOCATION =
446GENERATE_CHI = NO
447CHM_INDEX_ENCODING =
448BINARY_TOC = NO
449TOC_EXPAND = NO
450GENERATE_QHP = NO
451QCH_FILE =
452QHP_NAMESPACE = org.doxygen.Project
453QHP_VIRTUAL_FOLDER = doc
454QHP_CUST_FILTER_NAME =
455QHP_CUST_FILTER_ATTRS =
456QHP_SECT_FILTER_ATTRS =
457QHG_LOCATION =
458GENERATE_ECLIPSEHELP = NO
459ECLIPSE_DOC_ID = org.doxygen.Project
460DISABLE_INDEX = NO
461GENERATE_TREEVIEW = NO
462ENUM_VALUES_PER_LINE = 4
463TREEVIEW_WIDTH = 250
464EXT_LINKS_IN_WINDOW = NO
465FORMULA_FONTSIZE = 10
466FORMULA_TRANSPARENT = YES
467USE_MATHJAX = NO
468MATHJAX_FORMAT = HTML-CSS
469MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
470MATHJAX_EXTENSIONS =
471MATHJAX_CODEFILE =
472SEARCHENGINE = NO
473SERVER_BASED_SEARCH = NO
474EXTERNAL_SEARCH = NO
475SEARCHENGINE_URL =
476SEARCHDATA_FILE = searchdata.xml
477EXTERNAL_SEARCH_ID =
478EXTRA_SEARCH_MAPPINGS =
479#---------------------------------------------------------------------------
480# Configuration options related to the LaTeX output
481#---------------------------------------------------------------------------
482GENERATE_LATEX = NO
483LATEX_OUTPUT = latex
484LATEX_CMD_NAME = latex
485MAKEINDEX_CMD_NAME = makeindex
486COMPACT_LATEX = NO
487PAPER_TYPE = a4
488EXTRA_PACKAGES =
489LATEX_HEADER =
490LATEX_FOOTER =
491LATEX_EXTRA_STYLESHEET =
492LATEX_EXTRA_FILES =
493PDF_HYPERLINKS = NO
494USE_PDFLATEX = NO
495LATEX_BATCHMODE = NO
496LATEX_HIDE_INDICES = NO
497LATEX_SOURCE_CODE = NO
498LATEX_BIB_STYLE = plain
499#---------------------------------------------------------------------------
500# Configuration options related to the RTF output
501#---------------------------------------------------------------------------
502GENERATE_RTF = NO
503RTF_OUTPUT = rtf
504COMPACT_RTF = NO
505RTF_HYPERLINKS = NO
506RTF_STYLESHEET_FILE =
507RTF_EXTENSIONS_FILE =
508RTF_SOURCE_CODE = NO
509#---------------------------------------------------------------------------
510# Configuration options related to the man page output
511#---------------------------------------------------------------------------
512GENERATE_MAN = NO
513MAN_OUTPUT = man
514MAN_EXTENSION = .3
515MAN_SUBDIR =
516MAN_LINKS = NO
517#---------------------------------------------------------------------------
518# Configuration options related to the XML output
519#---------------------------------------------------------------------------
520GENERATE_XML = NO
521XML_OUTPUT = xml
522XML_PROGRAMLISTING = YES
523#---------------------------------------------------------------------------
524# Configuration options related to the DOCBOOK output
525#---------------------------------------------------------------------------
526GENERATE_DOCBOOK = NO
527DOCBOOK_OUTPUT = docbook
528DOCBOOK_PROGRAMLISTING = NO
529#---------------------------------------------------------------------------
530# Configuration options for the AutoGen Definitions output
531#---------------------------------------------------------------------------
532GENERATE_AUTOGEN_DEF = NO
533#---------------------------------------------------------------------------
534# Configuration options related to the Perl module output
535#---------------------------------------------------------------------------
536GENERATE_PERLMOD = NO
537PERLMOD_LATEX = NO
538PERLMOD_PRETTY = YES
539PERLMOD_MAKEVAR_PREFIX =
540#---------------------------------------------------------------------------
541# Configuration options related to the preprocessor
542#---------------------------------------------------------------------------
543ENABLE_PREPROCESSING = YES
544MACRO_EXPANSION = YES
545EXPAND_ONLY_PREDEF = YES
546SEARCH_INCLUDES = YES
547# INCLUDE_PATH = later
548# INCLUDE_FILE_PATTERNS = later
549
550PREDEFINED = \
551 DOXYGEN_RUNNING \
552 RT_C_DECLS_END \
553 RT_C_DECLS_BEGIN \
554 VBOX=1 \
555 RT_STRICT=1 \
556 VBOX_STRICT=1 \
557 __cplusplus=1 \
558 ARCH_BITS=HC_ARCH_BITS \
559 R3_ARCH_BITS=HC_ARCH_BITS \
560 R0_ARCH_BITS=HC_ARCH_BITS \
561 RTDECL(type)=type \
562 RT_EXPORT_SYMBOL(name)= \
563 \
564 RT_SRC_POS=1 \
565 RT_SRC_POS_ARGS=SRC_POS \
566 "RT_SRC_POS_DECL=int SRC_POS" \
567 "RTLOG_COMMA_SRC_POS_DECL=, int SRC_POS" \
568 \
569 "RT_IPRT_FORMAT_ATTR(a,b)=" \
570 "RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a,b)=" \
571 RT_NOTHROW_PROTO= \
572 RT_NOTHROW_DEF= \
573 RT_NO_THROW_PROTO= \
574 RT_NO_THROW_DEF= \
575 RTASN1CONTEXTTAG_IMPL_CURSOR_INLINES(a)= \
576 \
577 RT_MSC_PREREQ(a)=0 \
578 RT_MSC_PREREQ_EX(a,b)=b
579
580# decl and calling conventions.
581PREDEFINED += \
582 DECL_NOTHROW(a_RetType)=a_RetType \
583 "DECLINLINE(type)=inline type" \
584 DECL_INLINE_THROW(type)=DECLINLINE(type) \
585 DECL_FORCE_INLINE(type)=DECLINLINE(type) \
586 DECL_NO_INLINE(type)=type \
587 DECL_NO_RETURN(type)=type \
588 DECLCALLBACK(type)=type \
589 "DECLCALLBACKTYPE(type,name,args)=type name args" \
590 "DECLCALLBACKTYPE_EX(type,cconv,name,args)=type name args" \
591 "DECLCALLBACKPTR(type,name,args)=type (* name) args" \
592 "DECLCALLBACKPTR_EX(type,cconv,name,args)=type (* name) args" \
593 "DECLCALLBACKMEMBER(type,name,args)=type (* name) args" \
594 "DECLCALLBACKMEMBER_EX(type,cconv,name,args)=type (* name) args" \
595 "DECLRCCALLBACKMEMBER(type,name,args)=type (* name) args" \
596 "DECLR3CALLBACKMEMBER(type,name,args)=type (* name) args" \
597 "DECLR0CALLBACKMEMBER(type,name,args)=type (* name) args" \
598 "DECLRGCALLBACKMEMBER(type,name,args)=type (* name) args" \
599 DECLEXPORT(type)=type \
600 DECL_EXPORT_NOTHROW(type)=type \
601 DECLIMPORT(type)=type \
602 DECL_IMPORT_NOTHROW(type)=type \
603 DECLHIDDEN(type)=type \
604 DECL_HIDDEN_NOTHROW(type)=type \
605 DECL_HIDDEN_ONLY(type)=type \
606 DECL_HIDDEN_THROW(type)=type \
607 DECL_HIDDEN_DATA(type)=type \
608 DECL_HIDDEN_CONST(type)=type \
609 DECL_HIDDEN_CALLBACK(type)=type \
610 DECLASM(type)=type \
611 RT_ASM_DECL_PRAGMA_WATCOM(type)=type \
612 RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \
613 DECLNORETURN(type)=type \
614 RTCALL= \
615 \
616 APICBOTHCBDECL(type)=type \
617 VBOXCALL= \
618 DECLVBGL(type)=type \
619 DECLR0VBGL(type)=type \
620 USBLIB_DECL(type)=type \
621 VMMDECL(type)=type \
622 VMMR0DECL(type)=type \
623 VMMR3DECL(type)=type \
624 VMMRCDECL(type)=type \
625 VMMRZDECL(type)=type \
626 VMMR0_INT_DECL(type)=type \
627 VMMR3_INT_DECL(type)=type \
628 VMMRC_INT_DECL(type)=type \
629 VMMRZ_INT_DECL(type)=type \
630 GMMR0DECL(type)=type \
631 GMMR3DECL(type)=type \
632 VBOX_DND_FN_DECL_LOG(x)=x \
633 DECLSPEC_HIDDEN= \
634 VMSVGA3DCOCOA_DECL(type)=type \
635 VBOX_LISTENER_DECLARE(a)= \
636 VBOX_WITH_RAW_MODE_NOT_R0
637
638# BS3Kit
639PREDEFINED += \
640 BS3_FAR= \
641 BS3_NEAR= \
642 BS3_FAR_DATA= \
643 BS3_DECL(a_Type)=a_Type \
644 BS3_DECL_NEAR(a_Type)=a_Type \
645 BS3_DECL_FAR(a_Type)=a_Type \
646 BS3_DECL_CALLBACK(a_Type)=a_Type \
647 BS3_DECL_NEAR_CALLBACK(a_Type)=a_Type \
648 BS3_CMN_NM(a_Name)=a_Name \
649 BS3_CMN_FAR_NM(a_Name)=a_Name \
650 BS3_CMN_FN_NM(a_Name)=a_Name \
651 BS3_DATA_NM(a_Name)=a_Name \
652 TMPL_NM(a_Name)=a_Name##_mmm \
653 TMPL_FAR_NM(a_Name)=a_Name##_mmm \
654 "BS3_CMN_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
655 "BS3_CMN_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
656 "BS3_CMN_PROTO_FARSTUB(a_cbParam16, a_RetType, a_Name, a_Params)=a_RetType a_Name a_Params" \
657 "BS3_CMN_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
658 "BS3_MODE_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
659 "BS3_MODE_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
660 "BS3_MODE_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
661 "BS3_PTR_UNION_TEMPLATE(a_BaseName,a_Modifiers)=typedef union a_BaseName { a_Modifiers void *pv } a_BaseName, * P##a_BaseName; }" \
662 "BS3_XPTR_MEMBER(a_Type,a_Name)=a_Type * a_Name" \
663
664
665# templated fun.
666PREDEFINED += \
667 "PGM_BTH_DECL(type,name)=type pgmBth##name" \
668 "PGM_SHW_DECL(type,name)=type pgmShw##name" \
669 "PGM_GST_DECL(type,name)=type pgmGst##name" \
670 "PGM_BTH_NAME(name)=pgmBth##name" \
671 "PGM_SHW_NAME(name)=pgmShw##name" \
672 "PGM_GST_NAME(name)=pgmGst##name" \
673 PGM_ALL_CB_DECL(type)=type \
674 PGM_ALL_CB2_DECL(type)=type \
675 PGMPHYS_DATATYPE=uintXX_t \
676 "PGMPHYSFN_READNAME(a,b,c)=PGMR3PhysReadUxx(a,b,c)" \
677 "PGMPHYSFN_WRITENAME(a,b,c,d)=PGMR3PhysWriteUxx(a,b,c,d)" \
678
679# context hacks.
680PREDEFINED += RCPTRTYPE(RCType)=RCType
681PREDEFINED += R3PTRTYPE(R3Type)=R3Type
682PREDEFINED += R0PTRTYPE(R0Type)=R0Type
683PREDEFINED += HCPTRTYPE(HCType)=HCType
684PREDEFINED += R3R0PTRTYPE(R3R0Type)=R3R0Type
685PREDEFINED += \
686 "CTX_SUFF(var)=var##R3" \
687 "CTX_SUFF_Z(var)=var##RZ" \
688 "CTX_MID(first,last)=firstr##R3##last" \
689 "CTX_MID_Z(first,last)=firstr##RZ##last" \
690
691# Compile assertion hacks.
692PREDEFINED += \
693 "AssertCompileNS(expr)=static_assert(expr)" \
694 "AssertCompile(expr)=static_assert(expr)" \
695 "AssertCompileSize(type, size)=static_assert(true)" \
696 "AssertCompileSizeAlignment(type, align)=static_assert(true)" \
697 "AssertCompileMemberAlignment(type, member, align)=static_assert(true)" \
698 "AssertCompileMemberOffset(type, member, off)=static_assert(true)" \
699 "AssertCompile2MemberOffsets(type, member1, member2)=static_assert(true)" \
700 "AssertCompileAdjacentMembers(type, member1, member2)=static_assert(true)" \
701 "AssertCompileMembersAtSameOffset(type1, member1, type2, member2)=static_assert(true)" \
702 "AssertCompileMemberSize(type, member, size)=static_assert(true)" \
703 "AssertCompileMemberSizeAlignment(type, member, align)=static_assert(true)" \
704 "AssertCompileMembersSameSize(type1, member1, type2, member2)=static_assert(true)" \
705 "AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)=static_assert(true)"
706
707# COM/XPCOM hacks.
708PREDEFINED += \
709 STDMETHODIMP=HRESULT \
710 IFACEMETHODIMP=HRESULT \
711 IFACEMETHODIMP_(t)=t \
712 "COMGETTER(n)=get_##n" \
713 "COMSETTER(n)=set_##n" \
714 "ComSafeArrayIn(aType,aArg)=aType *aArg" \
715 "ComSafeArrayOut(aType, aArg)=aType **aArg" \
716 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(a)= \
717 DECLARE_NOT_AGGREGATABLE(a)= \
718 DECLARE_CLASSFACTORY()= \
719 DECLARE_CLASSFACTORY_SINGLETON(a)= \
720 "VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(a,b)=" \
721 "DECLARE_TRANSLATE_METHODS(a)=static const char *tr(const char *aSourceText, const char *aComment = NULL, const int aNum = -1);" \
722 "DECLARE_EMPTY_CTOR_DTOR(a)=a(); virtual ~a();" \
723 "DECLARE_COMMON_CLASS_METHODS(a)=a(); virtual ~a(); static const char *tr(const char *aSourceText, const char *aComment = NULL, const int aNum = -1);"
724
725# COM hacks from From http://www.stack.nl/~dimitri/doxygen/preprocessing.html
726PREDEFINED += \
727 "DECLARE_INTERFACE(name)=class name" \
728 "STDMETHOD_(result,name)=virtual result name" \
729 "PURE= = 0" \
730 THIS_= \
731 THIS= \
732 NTSTATUS=long \
733 LONG=long \
734 NTAPI= \
735 WINAPI= \
736 DECLARE_REGISTRY_RESOURCEID=// \
737 DECLARE_PROTECT_FINAL_CONSTRUCT=// \
738 "DECLARE_AGGREGATABLE(Class)= " \
739 "DECLARE_REGISTRY_RESOURCEID(Id)= " \
740 DECLARE_MESSAGE_MAP= \
741 BEGIN_MESSAGE_MAP=/* \
742 END_MESSAGE_MAP=*/// \
743 BEGIN_COM_MAP=/* \
744 END_COM_MAP=*/// \
745 BEGIN_PROP_MAP=/* \
746 END_PROP_MAP=*/// \
747 BEGIN_MSG_MAP=/* \
748 END_MSG_MAP=*/// \
749 BEGIN_PROPERTY_MAP=/* \
750 END_PROPERTY_MAP=*/// \
751 BEGIN_OBJECT_MAP=/* \
752 END_OBJECT_MAP()=*/// \
753 DECLARE_VIEW_STATUS=// \
754 "STDMETHOD(a)=HRESULT a" \
755 "ATL_NO_VTABLE= " \
756 "__declspec(a)= " \
757 BEGIN_CONNECTION_POINT_MAP=/* \
758 END_CONNECTION_POINT_MAP=*/// \
759 "DECLARE_DYNAMIC(class)= " \
760 "IMPLEMENT_DYNAMIC(class1, class2)= " \
761 "DECLARE_DYNCREATE(class)= " \
762 "IMPLEMENT_DYNCREATE(class1, class2)= " \
763 "IMPLEMENT_SERIAL(class1, class2, class3)= " \
764 "DECLARE_MESSAGE_MAP()= " \
765 TRY=try \
766 "CATCH_ALL(e)= catch(...)" \
767 END_CATCH_ALL= \
768 "THROW_LAST()= throw"\
769 "RUNTIME_CLASS(class)=class" \
770 "MAKEINTRESOURCE(nId)=nId" \
771 "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
772 "ASSERT(x)=assert(x)" \
773 "ASSERT_VALID(x)=assert(x)" \
774 "TRACE0(x)=printf(x)" \
775 "OS_ERR(A,B)={ #A, B }" \
776 __cplusplus \
777 "DECLARE_OLECREATE(class)= " \
778 "BEGIN_DISPATCH_MAP(class1, class2)= " \
779 "BEGIN_INTERFACE_MAP(class1, class2)= " \
780 "INTERFACE_PART(class, id, name)= " \
781 "END_INTERFACE_MAP()=" \
782 "DISP_FUNCTION(class, name, function, result, id)=" \
783 "END_DISPATCH_MAP()=" \
784 "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11)=" \
785 RT_GCC_EXTENSION= \
786 "CPUM_STRUCT_NM(n)=" \
787 "CPUM_UNION_NM(n)=" \
788 "DECL_NO_RETURN(type)=type" \
789 VBOX_WITH_HGCM \
790 \
791 "IEM_DECL_IMPL_DEF(a_RetType, a_Name, a_ArgList)=a_RetType a_Name a_ArgList" \
792 "IEM_DECL_IMPL_TYPE(a_RetType, a_Name, a_ArgList)=a_RetType (a_Name) a_ArgList" \
793 \
794 "FNIEMOP_DEF(a_Name)=int a_Name()" \
795 "FNIEMOP_DEF_1(a_Name, a_Type0, a_Name0)=int a_Name(a_Type0 a_Name0)" \
796 "FNIEMOP_DEF_2(a_Name, a_Type0, a_Name0, a_Type1, a_Name1)=int a_Name(a_Type0 a_Name0, a_Type1 a_Name1)" \
797 "FNIEMOPRM_DEF(a_Name)=int a_Name(uint8_t bRm)" \
798 \
799 "IEM_CIMPL_DEF_0(a_Name)=int a_Name()" \
800 "IEM_CIMPL_TYPE_0(a_Name)=int (a_Name)()" \
801 "IEM_CIMPL_CALL_0(a_pfn)=a_pfn()" \
802 "IEM_CIMPL_DEF_1(a_Name, a_Type0, a_Arg0)=int a_Name(a_Type0 a_Arg0)" \
803 "IEM_CIMPL_TYPE_1(a_Name, a_Type0, a_Arg0)=int (a_Name)(a_Type0 a_Arg0)" \
804 "IEM_CIMPL_CALL_1(a_pfn, a0)=a_pfn(a0)" \
805 "IEM_CIMPL_DEF_2(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1)=int a_Name(a_Type0 a_Arg0, a_Type1 a_Arg1)" \
806 "IEM_CIMPL_TYPE_2(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1)=int (a_Name)(a_Type0 a_Arg0, a_Type1 a_Arg1)" \
807 "IEM_CIMPL_CALL_2(a_pfn, a0, a1)=a_pfn(a0, a1)" \
808 "IEM_CIMPL_DEF_3(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2)=int a_Name(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2)" \
809 "IEM_CIMPL_TYPE_3(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2)=int (a_Name)(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2)" \
810 "IEM_CIMPL_CALL_3(a_pfn, a0, a1, a2)=a_pfn(a0, a1, a2)" \
811 "IEM_CIMPL_DEF_4(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2, a_Type3, a_Arg3)=int a_Name(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2, a_Type3 a_Arg3)" \
812 "IEM_CIMPL_TYPE_4(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2, a_Type3, a_Arg3)=int (a_Name)(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2, a_Type3 a_Arg3)" \
813 "IEM_CIMPL_CALL_4(a_pfn, a0, a1, a2, a3)=a_pfn(a0, a1, a2, a3)" \
814 "IEM_CIMPL_DEF_5(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2, a_Type3, a_Arg3, a_Type4, a_Arg4)=int a_Name(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2, a_Type3 a_Arg3, a_Type4 a_Arg4)" \
815 "IEM_CIMPL_TYPE_5(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2, a_Type3, a_Arg3, a_Type4, a_Arg4)=int (a_Name)(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2, a_Type3 a_Arg3, a_Type4 a_Arg4)" \
816 "IEM_CIMPL_CALL_5(a_pfn, a0, a1, a2, a3, a4)=a_pfn(a0, a1, a2, a3, a4)" \
817 "IEM_CIMPL_DEF_6(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2, a_Type3, a_Arg3, a_Type4, a_Arg4, a_Type5, a_Arg5)=int a_Name(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2, a_Type3 a_Arg3, a_Type4 a_Arg4, a_Type5 a_Arg5)" \
818 "IEM_CIMPL_TYPE_6(a_Name, a_Type0, a_Arg0, a_Type1, a_Arg1, a_Type2, a_Arg2, a_Type3, a_Arg3, a_Type4, a_Arg4, a_Type5, a_Arg5)=int (a_Name)(a_Type0 a_Arg0, a_Type1 a_Arg1, a_Type2 a_Arg2, a_Type3 a_Arg3, a_Type4 a_Arg4, a_Type5 a_Arg5)" \
819 "IEM_CIMPL_CALL_6(a_pfn, a0, a1, a2, a3, a4, a5)=a_pfn(a0, a1, a2, a3, a4, a5)" \
820
821EXPAND_AS_DEFINED = \
822 ARCH_BITS \
823 R3_ARCH_BITS \
824 R0_ARCH_BITS \
825 GC_ARCH_BITS \
826 HC_ARCH_BITS \
827 \
828 DECLASMTYPE \
829 DECL_INLINE_NOTHROW \
830 CTXSUFF \
831 OTHERCTXSUFF \
832 CTXMID \
833 OTHERCTXMID \
834 \
835 INPTR \
836 COMSETTER \
837 COMGETTER \
838 STDMETHOD \
839 STDMETHOD_ \
840 STDMETHODIMP \
841 IFACEMETHODIMP \
842 \
843 DBGDECL \
844 DISDECL \
845 GMMR0DECL \
846 GVMMR0DECL \
847 INTNETDECL \
848 INTNETRCDECL \
849 INTNETR0DECL \
850 INTNETR3DECL \
851 PDMBOTHCBDECL \
852 APICBOTHCBDECL \
853 PGM_BTH_DECL \
854 PGM_GST_DECL \
855 PGM_SHW_DECL \
856 REMDECL \
857 REMRCDECL \
858 REMR0DECL \
859 REMR3DECL \
860 RTDECL \
861 RTRCDECL \
862 RTR0DECL \
863 RTR3DECL \
864 RTDATADECL \
865 RT_DECL_NTAPI \
866 SUPDECL \
867 SUPR0DECL \
868 SUPR3DECL \
869 VBGLR3DECL \
870 VBOXDDU_DECL \
871 VMMDECL \
872 VMMRCDECL \
873 VMMR0DECL \
874 VMMR3DECL \
875 VMM_INT_DECL \
876 \
877 VD_BACKEND_CALLBACK_GET_COMMENT_DEF_NOT_SUPPORTED \
878 VD_BACKEND_CALLBACK_SET_COMMENT_DEF_NOT_SUPPORTED \
879 VD_BACKEND_CALLBACK_GET_UUID_DEF_NOT_SUPPORTED \
880 VD_BACKEND_CALLBACK_SET_UUID_DEF_NOT_SUPPORTED \
881 \
882 IOM_MMIO_STATS_COMMA_DECL \
883 IOM_MMIO_STATS_COMMA_ARG \
884 SUP_HARDENED_SUID \
885 \
886 VTABLE_ENTRY \
887 VTABLE_RESERVED
888
889SKIP_FUNCTION_MACROS = NO
890#---------------------------------------------------------------------------
891# Configuration options related to external references
892#---------------------------------------------------------------------------
893TAGFILES =
894GENERATE_TAGFILE =
895ALLEXTERNALS = NO
896EXTERNAL_GROUPS = YES
897EXTERNAL_PAGES = YES
898#---------------------------------------------------------------------------
899# Configuration options related to the dot tool
900#---------------------------------------------------------------------------
901CLASS_DIAGRAMS = YES
902DIA_PATH =
903HIDE_UNDOC_RELATIONS = YES
904HAVE_DOT = NO
905DOT_NUM_THREADS = 0
906DOT_FONTNAME = Helvetica
907DOT_FONTSIZE = 10
908DOT_FONTPATH =
909CLASS_GRAPH = YES
910COLLABORATION_GRAPH = YES
911GROUP_GRAPHS = YES
912UML_LOOK = YES
913UML_LIMIT_NUM_FIELDS = 10
914TEMPLATE_RELATIONS = YES
915INCLUDE_GRAPH = YES
916INCLUDED_BY_GRAPH = YES
917CALL_GRAPH = YES
918CALLER_GRAPH = YES
919GRAPHICAL_HIERARCHY = YES
920DIRECTORY_GRAPH = YES
921DOT_IMAGE_FORMAT = png
922INTERACTIVE_SVG = NO
923DOT_PATH =
924DOTFILE_DIRS =
925MSCFILE_DIRS =
926DIAFILE_DIRS =
927PLANTUML_JAR_PATH =
928PLANTUML_INCLUDE_PATH =
929DOT_GRAPH_MAX_NODES = 50
930MAX_DOT_GRAPH_DEPTH = 0
931DOT_TRANSPARENT = YES
932DOT_MULTI_TARGETS = NO
933GENERATE_LEGEND = YES
934DOT_CLEANUP = YES
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette