VirtualBox

source: vbox/trunk/Doxyfile.Core@ 86471

Last change on this file since 86471 was 85967, checked in by vboxsync, 4 years ago

/Doxyfile.Core: devcfgm fixes (first used in apic now).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 29.5 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 += openc="Encoding: "
261ALIASES += opfltest="EFLAGS Tested: "
262ALIASES += opflmodify="EFLAGS Modified: "
263ALIASES += opflundef="EFLAGS Undefined: "
264ALIASES += opflset="EFLAGS Set: "
265ALIASES += opflclear="EFLAGS Cleared: "
266ALIASES += ophints="Hints, Flags, ++: "
267ALIASES += opmincpu="Minimum CPU: "
268ALIASES += opcpuid="CPUID: "
269ALIASES += opgroup="@ingroup "
270ALIASES += opunused="Unused Encoding: "
271ALIASES += opinvalid="Invalid Encoding: "
272ALIASES += opinvlstyle="Invalid/Unused Encoding Style: "
273ALIASES += optest="Testcase: "
274ALIASES += opstats="IEM Stats:"
275ALIASES += opfunction="IEM Function"
276ALIASES += opdone="-------------------------"
277
278
279# bugref - xTracker bug reference, takes one to four bug numbers.
280ALIASES += bugref{1}="https://xtracker.innotek.de/index.php?bug=\1"
281ALIASES += bugref{2}="https://xtracker.innotek.de/index.php?bug=\1, \
282https://xtracker.innotek.de/index.php?bug=\2"
283ALIASES += bugref{3}="https://xtracker.innotek.de/index.php?bug=\1, \
284https://xtracker.innotek.de/index.php?bug=\2, \
285https://xtracker.innotek.de/index.php?bug=\3"
286ALIASES += bugref{4}="https://xtracker.innotek.de/index.php?bug=\1, \
287https://xtracker.innotek.de/index.php?bug=\2, \
288https://xtracker.innotek.de/index.php?bug=\3, \
289https://xtracker.innotek.de/index.php?bug=\4"
290
291# ticketref - Track ticket reference, takes one to four ticket numbers.
292ALIASES += ticketref{1}="http://www.virtualbox.org/ticket/\1"
293ALIASES += ticketref{2}="http://www.virtualbox.org/ticket/\1, \
294http://www.virtualbox.org/ticket/\2"
295ALIASES += ticketref{3}="http://www.virtualbox.org/ticket/\1, \
296http://www.virtualbox.org/ticket/\2, \
297http://www.virtualbox.org/ticket/\3"
298ALIASES += ticketref{4}="http://www.virtualbox.org/ticket/\1, \
299http://www.virtualbox.org/ticket/\2, \
300http://www.virtualbox.org/ticket/\3, \
301http://www.virtualbox.org/ticket/\4"
302
303
304TCL_SUBST =
305OPTIMIZE_OUTPUT_FOR_C = YES
306OPTIMIZE_OUTPUT_JAVA = NO
307OPTIMIZE_FOR_FORTRAN = NO
308OPTIMIZE_OUTPUT_VHDL = NO
309EXTENSION_MAPPING =
310MARKDOWN_SUPPORT = YES
311AUTOLINK_SUPPORT = YES
312BUILTIN_STL_SUPPORT = NO
313CPP_CLI_SUPPORT = NO
314SIP_SUPPORT = NO
315IDL_PROPERTY_SUPPORT = YES
316DISTRIBUTE_GROUP_DOC = NO
317SUBGROUPING = YES
318INLINE_GROUPED_CLASSES = NO
319INLINE_SIMPLE_STRUCTS = NO
320TYPEDEF_HIDES_STRUCT = NO
321LOOKUP_CACHE_SIZE = 0
322#---------------------------------------------------------------------------
323# Build related configuration options
324#---------------------------------------------------------------------------
325EXTRACT_ALL = YES
326EXTRACT_PRIVATE = YES
327EXTRACT_PACKAGE = NO
328EXTRACT_STATIC = YES
329EXTRACT_LOCAL_CLASSES = YES
330EXTRACT_LOCAL_METHODS = NO
331EXTRACT_ANON_NSPACES = NO
332HIDE_UNDOC_MEMBERS = NO
333HIDE_UNDOC_CLASSES = NO
334HIDE_FRIEND_COMPOUNDS = NO
335HIDE_IN_BODY_DOCS = NO
336INTERNAL_DOCS = YES
337CASE_SENSE_NAMES = NO
338HIDE_SCOPE_NAMES = NO
339HIDE_COMPOUND_REFERENCE= NO
340SHOW_INCLUDE_FILES = YES
341SHOW_GROUPED_MEMB_INC = NO
342FORCE_LOCAL_INCLUDES = NO
343INLINE_INFO = YES
344SORT_MEMBER_DOCS = YES
345SORT_BRIEF_DOCS = NO
346SORT_MEMBERS_CTORS_1ST = NO
347SORT_GROUP_NAMES = NO
348SORT_BY_SCOPE_NAME = NO
349STRICT_PROTO_MATCHING = NO
350GENERATE_TODOLIST = YES
351GENERATE_TESTLIST = YES
352GENERATE_BUGLIST = YES
353GENERATE_DEPRECATEDLIST= YES
354ENABLED_SECTIONS =
355MAX_INITIALIZER_LINES = 30
356SHOW_USED_FILES = YES
357SHOW_FILES = YES
358SHOW_NAMESPACES = YES
359FILE_VERSION_FILTER =
360LAYOUT_FILE =
361CITE_BIB_FILES =
362#---------------------------------------------------------------------------
363# Configuration options related to warning and progress messages
364#---------------------------------------------------------------------------
365QUIET = YES
366WARNINGS = YES
367##Later: WARN_IF_UNDOCUMENTED = YES
368WARN_IF_UNDOCUMENTED = NO
369WARN_IF_DOC_ERROR = YES
370WARN_NO_PARAMDOC = NO
371WARN_FORMAT = "$file:$line: $text"
372#WARN_LOGFILE = later
373#---------------------------------------------------------------------------
374# Configuration options related to the input files
375#---------------------------------------------------------------------------
376# INPUT = later
377INPUT_ENCODING = UTF-8
378FILE_PATTERNS =
379RECURSIVE = NO
380EXCLUDE =
381EXCLUDE_SYMLINKS = NO
382EXCLUDE_PATTERNS =
383EXCLUDE_SYMBOLS =
384EXAMPLE_PATH =
385EXAMPLE_PATTERNS =
386EXAMPLE_RECURSIVE = NO
387IMAGE_PATH = \
388 doc \
389 doc/tg/Networking-diagrams \
390 doc/tg/USB-diagrams \
391 doc/tg/diagrams \
392 doc/VMM
393INPUT_FILTER =
394FILTER_PATTERNS =
395FILTER_SOURCE_FILES = NO
396FILTER_SOURCE_PATTERNS =
397USE_MDFILE_AS_MAINPAGE =
398#---------------------------------------------------------------------------
399# Configuration options related to source browsing
400#---------------------------------------------------------------------------
401SOURCE_BROWSER = NO
402INLINE_SOURCES = NO
403STRIP_CODE_COMMENTS = YES
404REFERENCED_BY_RELATION = YES
405REFERENCES_RELATION = YES
406REFERENCES_LINK_SOURCE = YES
407SOURCE_TOOLTIPS = YES
408USE_HTAGS = NO
409VERBATIM_HEADERS = YES
410CLANG_ASSISTED_PARSING = NO
411CLANG_OPTIONS =
412#---------------------------------------------------------------------------
413# Configuration options related to the alphabetical class index
414#---------------------------------------------------------------------------
415ALPHABETICAL_INDEX = NO
416COLS_IN_ALPHA_INDEX = 5
417IGNORE_PREFIX =
418#---------------------------------------------------------------------------
419# Configuration options related to the HTML output
420#---------------------------------------------------------------------------
421GENERATE_HTML = YES
422HTML_OUTPUT = html
423HTML_FILE_EXTENSION = .html
424HTML_HEADER =
425HTML_FOOTER =
426HTML_STYLESHEET =
427HTML_EXTRA_STYLESHEET =
428HTML_EXTRA_FILES =
429HTML_COLORSTYLE_HUE = 220
430HTML_COLORSTYLE_SAT = 100
431HTML_COLORSTYLE_GAMMA = 80
432HTML_TIMESTAMP = YES
433HTML_DYNAMIC_SECTIONS = NO
434HTML_INDEX_NUM_ENTRIES = 100
435GENERATE_DOCSET = NO
436DOCSET_FEEDNAME = "Doxygen generated docs"
437DOCSET_BUNDLE_ID = org.doxygen.Project
438DOCSET_PUBLISHER_ID = org.doxygen.Publisher
439DOCSET_PUBLISHER_NAME = Publisher
440GENERATE_HTMLHELP = NO
441CHM_FILE =
442HHC_LOCATION =
443GENERATE_CHI = NO
444CHM_INDEX_ENCODING =
445BINARY_TOC = NO
446TOC_EXPAND = NO
447GENERATE_QHP = NO
448QCH_FILE =
449QHP_NAMESPACE = org.doxygen.Project
450QHP_VIRTUAL_FOLDER = doc
451QHP_CUST_FILTER_NAME =
452QHP_CUST_FILTER_ATTRS =
453QHP_SECT_FILTER_ATTRS =
454QHG_LOCATION =
455GENERATE_ECLIPSEHELP = NO
456ECLIPSE_DOC_ID = org.doxygen.Project
457DISABLE_INDEX = NO
458GENERATE_TREEVIEW = NO
459ENUM_VALUES_PER_LINE = 4
460TREEVIEW_WIDTH = 250
461EXT_LINKS_IN_WINDOW = NO
462FORMULA_FONTSIZE = 10
463FORMULA_TRANSPARENT = YES
464USE_MATHJAX = NO
465MATHJAX_FORMAT = HTML-CSS
466MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
467MATHJAX_EXTENSIONS =
468MATHJAX_CODEFILE =
469SEARCHENGINE = NO
470SERVER_BASED_SEARCH = NO
471EXTERNAL_SEARCH = NO
472SEARCHENGINE_URL =
473SEARCHDATA_FILE = searchdata.xml
474EXTERNAL_SEARCH_ID =
475EXTRA_SEARCH_MAPPINGS =
476#---------------------------------------------------------------------------
477# Configuration options related to the LaTeX output
478#---------------------------------------------------------------------------
479GENERATE_LATEX = NO
480LATEX_OUTPUT = latex
481LATEX_CMD_NAME = latex
482MAKEINDEX_CMD_NAME = makeindex
483COMPACT_LATEX = NO
484PAPER_TYPE = a4wide
485EXTRA_PACKAGES =
486LATEX_HEADER =
487LATEX_FOOTER =
488LATEX_EXTRA_STYLESHEET =
489LATEX_EXTRA_FILES =
490PDF_HYPERLINKS = NO
491USE_PDFLATEX = NO
492LATEX_BATCHMODE = NO
493LATEX_HIDE_INDICES = NO
494LATEX_SOURCE_CODE = NO
495LATEX_BIB_STYLE = plain
496#---------------------------------------------------------------------------
497# Configuration options related to the RTF output
498#---------------------------------------------------------------------------
499GENERATE_RTF = NO
500RTF_OUTPUT = rtf
501COMPACT_RTF = NO
502RTF_HYPERLINKS = NO
503RTF_STYLESHEET_FILE =
504RTF_EXTENSIONS_FILE =
505RTF_SOURCE_CODE = NO
506#---------------------------------------------------------------------------
507# Configuration options related to the man page output
508#---------------------------------------------------------------------------
509GENERATE_MAN = NO
510MAN_OUTPUT = man
511MAN_EXTENSION = .3
512MAN_SUBDIR =
513MAN_LINKS = NO
514#---------------------------------------------------------------------------
515# Configuration options related to the XML output
516#---------------------------------------------------------------------------
517GENERATE_XML = NO
518XML_OUTPUT = xml
519XML_PROGRAMLISTING = YES
520#---------------------------------------------------------------------------
521# Configuration options related to the DOCBOOK output
522#---------------------------------------------------------------------------
523GENERATE_DOCBOOK = NO
524DOCBOOK_OUTPUT = docbook
525DOCBOOK_PROGRAMLISTING = NO
526#---------------------------------------------------------------------------
527# Configuration options for the AutoGen Definitions output
528#---------------------------------------------------------------------------
529GENERATE_AUTOGEN_DEF = NO
530#---------------------------------------------------------------------------
531# Configuration options related to the Perl module output
532#---------------------------------------------------------------------------
533GENERATE_PERLMOD = NO
534PERLMOD_LATEX = NO
535PERLMOD_PRETTY = YES
536PERLMOD_MAKEVAR_PREFIX =
537#---------------------------------------------------------------------------
538# Configuration options related to the preprocessor
539#---------------------------------------------------------------------------
540ENABLE_PREPROCESSING = YES
541MACRO_EXPANSION = YES
542EXPAND_ONLY_PREDEF = YES
543SEARCH_INCLUDES = YES
544# INCLUDE_PATH = later
545# INCLUDE_FILE_PATTERNS = later
546
547PREDEFINED = \
548 DOXYGEN_RUNNING \
549 RT_C_DECLS_END \
550 RT_C_DECLS_BEGIN \
551 VBOX=1 \
552 RT_STRICT=1 \
553 VBOX_STRICT=1 \
554 __cplusplus=1 \
555 ARCH_BITS=HC_ARCH_BITS \
556 R3_ARCH_BITS=HC_ARCH_BITS \
557 R0_ARCH_BITS=HC_ARCH_BITS \
558 RTDECL(type)=type \
559 RT_EXPORT_SYMBOL(name)= \
560 \
561 RT_SRC_POS=1 \
562 RT_SRC_POS_ARGS=SRC_POS \
563 "RT_SRC_POS_DECL=int SRC_POS" \
564 "RTLOG_COMMA_SRC_POS_DECL=, int SRC_POS" \
565 \
566 "RT_IPRT_FORMAT_ATTR(a,b)=" \
567 "RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a,b)=" \
568 RT_NOTHROW_PROTO= \
569 RT_NOTHROW_DEF= \
570 RT_NO_THROW_PROTO= \
571 RT_NO_THROW_DEF= \
572 RTASN1CONTEXTTAG_IMPL_CURSOR_INLINES(a)= \
573 \
574 RT_MSC_PREREQ(a)=0 \
575 RT_MSC_PREREQ_EX(a,b)=b
576
577# decl and calling conventions.
578PREDEFINED += \
579 DECL_NOTHROW(a_RetType)=a_RetType \
580 "DECLINLINE(type)=inline type" \
581 DECL_INLINE_THROW(type)=DECLINLINE(type) \
582 DECL_FORCE_INLINE(type)=DECLINLINE(type) \
583 DECL_NO_INLINE(type)=type \
584 DECL_NO_RETURN(type)=type \
585 DECLCALLBACK(type)=type \
586 "DECLCALLBACKTYPE(type,name,args)=type name args" \
587 "DECLCALLBACKTYPE_EX(type,cconv,name,args)=type name args" \
588 "DECLCALLBACKPTR(type,name,args)=type (* name) args" \
589 "DECLCALLBACKPTR_EX(type,cconv,name,args)=type (* name) args" \
590 "DECLCALLBACKMEMBER(type,name,args)=type (* name) args" \
591 "DECLCALLBACKMEMBER_EX(type,cconv,name,args)=type (* name) args" \
592 DECLEXPORT(type)=type \
593 DECL_EXPORT_NOTHROW(type)=type \
594 DECLIMPORT(type)=type \
595 DECL_IMPORT_NOTHROW(type)=type \
596 DECLHIDDEN(type)=type \
597 DECL_HIDDEN_NOTHROW(type)=type \
598 DECL_HIDDEN_ONLY(type)=type \
599 DECL_HIDDEN_THROW(type)=type \
600 DECL_HIDDEN_DATA(type)=type \
601 DECL_HIDDEN_CONST(type)=type \
602 DECL_HIDDEN_CALLBACK(type)=type \
603 DECLASM(type)=type \
604 RT_ASM_DECL_PRAGMA_WATCOM(type)=type \
605 RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \
606 DECLNORETURN(type)=type \
607 RTCALL= \
608 \
609 APICBOTHCBDECL(type)=type \
610 VBOXCALL= \
611 DECLVBGL(type)=type \
612 DECLR0VBGL(type)=type \
613 USBLIB_DECL(type)=type \
614 VMMDECL(type)=type \
615 VMMR0DECL(type)=type \
616 VMMR3DECL(type)=type \
617 VMMRCDECL(type)=type \
618 VMMRZDECL(type)=type \
619 VMMR0_INT_DECL(type)=type \
620 VMMR3_INT_DECL(type)=type \
621 VMMRC_INT_DECL(type)=type \
622 VMMRZ_INT_DECL(type)=type \
623 GMMR0DECL(type)=type \
624 GMMR3DECL(type)=type \
625 VBOX_DND_FN_DECL_LOG(x)=x \
626 DECLSPEC_HIDDEN= \
627 VMSVGA3DCOCOA_DECL(type)=type \
628 VBOX_LISTENER_DECLARE(a)= \
629 VBOX_WITH_RAW_MODE_NOT_R0
630
631# BS3Kit
632PREDEFINED += \
633 BS3_FAR= \
634 BS3_NEAR= \
635 BS3_FAR_DATA= \
636 BS3_DECL(a_Type)=a_Type \
637 BS3_DECL_NEAR(a_Type)=a_Type \
638 BS3_DECL_FAR(a_Type)=a_Type \
639 BS3_DECL_CALLBACK(a_Type)=a_Type \
640 BS3_DECL_NEAR_CALLBACK(a_Type)=a_Type \
641 BS3_CMN_NM(a_Name)=a_Name \
642 BS3_CMN_FAR_NM(a_Name)=a_Name \
643 BS3_CMN_FN_NM(a_Name)=a_Name \
644 BS3_DATA_NM(a_Name)=a_Name \
645 TMPL_NM(a_Name)=a_Name##_mmm \
646 TMPL_FAR_NM(a_Name)=a_Name##_mmm \
647 "BS3_CMN_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
648 "BS3_CMN_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
649 "BS3_CMN_PROTO_FARSTUB(a_cbParam16, a_RetType, a_Name, a_Params)=a_RetType a_Name a_Params" \
650 "BS3_CMN_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
651 "BS3_MODE_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
652 "BS3_MODE_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
653 "BS3_MODE_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
654 "BS3_PTR_UNION_TEMPLATE(a_BaseName,a_Modifiers)=typedef union a_BaseName { a_Modifiers void *pv } a_BaseName, * P##a_BaseName; }" \
655 "BS3_XPTR_MEMBER(a_Type,a_Name)=a_Type * a_Name" \
656
657
658# templated fun.
659PREDEFINED += \
660 "PGM_BTH_DECL(type,name)=type pgmBth##name" \
661 "PGM_SHW_DECL(type,name)=type pgmShw##name" \
662 "PGM_GST_DECL(type,name)=type pgmGst##name" \
663 "PGM_BTH_NAME(name)=pgmBth##name" \
664 "PGM_SHW_NAME(name)=pgmShw##name" \
665 "PGM_GST_NAME(name)=pgmGst##name" \
666 PGM_ALL_CB_DECL(type)=type \
667 PGM_ALL_CB2_DECL(type)=type \
668 PGMPHYS_DATATYPE=uintXX_t \
669 "PGMPHYSFN_READNAME(a,b,c)=PGMR3PhysReadUxx(a,b,c)" \
670 "PGMPHYSFN_WRITENAME(a,b,c,d)=PGMR3PhysWriteUxx(a,b,c,d)" \
671
672# context hacks.
673PREDEFINED += RCPTRTYPE(RCType)=RCType
674PREDEFINED += R3PTRTYPE(R3Type)=R3Type
675PREDEFINED += R0PTRTYPE(R0Type)=R0Type
676PREDEFINED += HCPTRTYPE(HCType)=HCType
677PREDEFINED += R3R0PTRTYPE(R3R0Type)=R3R0Type
678PREDEFINED += \
679 "CTX_SUFF(var)=var##R3" \
680 "CTX_SUFF_Z(var)=var##RZ" \
681 "CTX_MID(first,last)=firstr##R3##last" \
682 "CTX_MID_Z(first,last)=firstr##RZ##last" \
683
684# Compile assertion hacks.
685PREDEFINED += \
686 "AssertCompileNS(expr)" \
687 "AssertCompile(expr)" \
688 "AssertCompileSize(type, size)" \
689 "AssertCompileSizeAlignment(type, align)" \
690 "AssertCompileMemberAlignment(type, member, align)" \
691 "AssertCompileMemberOffset(type, member, off)" \
692 "AssertCompile2MemberOffsets(type, member1, member2)" \
693 "AssertCompileAdjacentMembers(type, member1, member2)" \
694 "AssertCompileMembersAtSameOffset(type1, member1, type2, member2)" \
695 "AssertCompileMemberSize(type, member, size)" \
696 "AssertCompileMemberSizeAlignment(type, member, align)" \
697 "AssertCompileMembersSameSize(type1, member1, type2, member2)" \
698 "AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)"
699
700# COM/XPCOM hacks.
701PREDEFINED += \
702 STDMETHODIMP=HRESULT \
703 IFACEMETHODIMP=HRESULT \
704 IFACEMETHODIMP_(t)=t \
705 "COMGETTER(n)=get_##n" \
706 "COMSETTER(n)=set_##n" \
707 "ComSafeArrayIn(aType,aArg)=aType *aArg" \
708 "ComSafeArrayOut(aType, aArg)=aType **aArg" \
709 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(a)= \
710 DECLARE_NOT_AGGREGATABLE(a)= \
711 DECLARE_CLASSFACTORY()= \
712 DECLARE_CLASSFACTORY_SINGLETON(a)= \
713 "VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(a,b)=" \
714 "DECLARE_EMPTY_CTOR_DTOR(a):=a(); virtual ~a();"
715
716# COM hacks from From http://www.stack.nl/~dimitri/doxygen/preprocessing.html
717PREDEFINED += \
718 "DECLARE_INTERFACE(name)=class name" \
719 "STDMETHOD_(result,name)=virtual result name" \
720 "PURE= = 0" \
721 THIS_= \
722 THIS= \
723 NTSTATUS=long \
724 LONG=long \
725 NTAPI= \
726 WINAPI= \
727 DECLARE_REGISTRY_RESOURCEID=// \
728 DECLARE_PROTECT_FINAL_CONSTRUCT=// \
729 "DECLARE_AGGREGATABLE(Class)= " \
730 "DECLARE_REGISTRY_RESOURCEID(Id)= " \
731 DECLARE_MESSAGE_MAP= \
732 BEGIN_MESSAGE_MAP=/* \
733 END_MESSAGE_MAP=*/// \
734 BEGIN_COM_MAP=/* \
735 END_COM_MAP=*/// \
736 BEGIN_PROP_MAP=/* \
737 END_PROP_MAP=*/// \
738 BEGIN_MSG_MAP=/* \
739 END_MSG_MAP=*/// \
740 BEGIN_PROPERTY_MAP=/* \
741 END_PROPERTY_MAP=*/// \
742 BEGIN_OBJECT_MAP=/* \
743 END_OBJECT_MAP()=*/// \
744 DECLARE_VIEW_STATUS=// \
745 "STDMETHOD(a)=HRESULT a" \
746 "ATL_NO_VTABLE= " \
747 "__declspec(a)= " \
748 BEGIN_CONNECTION_POINT_MAP=/* \
749 END_CONNECTION_POINT_MAP=*/// \
750 "DECLARE_DYNAMIC(class)= " \
751 "IMPLEMENT_DYNAMIC(class1, class2)= " \
752 "DECLARE_DYNCREATE(class)= " \
753 "IMPLEMENT_DYNCREATE(class1, class2)= " \
754 "IMPLEMENT_SERIAL(class1, class2, class3)= " \
755 "DECLARE_MESSAGE_MAP()= " \
756 TRY=try \
757 "CATCH_ALL(e)= catch(...)" \
758 END_CATCH_ALL= \
759 "THROW_LAST()= throw"\
760 "RUNTIME_CLASS(class)=class" \
761 "MAKEINTRESOURCE(nId)=nId" \
762 "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
763 "ASSERT(x)=assert(x)" \
764 "ASSERT_VALID(x)=assert(x)" \
765 "TRACE0(x)=printf(x)" \
766 "OS_ERR(A,B)={ #A, B }" \
767 __cplusplus \
768 "DECLARE_OLECREATE(class)= " \
769 "BEGIN_DISPATCH_MAP(class1, class2)= " \
770 "BEGIN_INTERFACE_MAP(class1, class2)= " \
771 "INTERFACE_PART(class, id, name)= " \
772 "END_INTERFACE_MAP()=" \
773 "DISP_FUNCTION(class, name, function, result, id)=" \
774 "END_DISPATCH_MAP()=" \
775 "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11)=" \
776 RT_GCC_EXTENSION= \
777 "CPUM_STRUCT_NM(n)=" \
778 "CPUM_UNION_NM(n)=" \
779 "DECL_NO_RETURN(type)=type" \
780 VBOX_WITH_HGCM
781
782EXPAND_AS_DEFINED = \
783 RCPTRTYPE \
784 R3PTRTYPE \
785 R0PTRTYPE \
786 HCPTRTYPE \
787 R3R0PTRTYPE \
788 \
789 ARCH_BITS \
790 R3_ARCH_BITS \
791 R0_ARCH_BITS \
792 GC_ARCH_BITS \
793 HC_ARCH_BITS \
794 \
795 DECLEXPORT \
796 DECLIMPORT \
797 DECLASM \
798 DECLASMTYPE \
799 DECLCALLBACK \
800 DECLCALLBACKMEMBER \
801 DECLCALLBACKPTR \
802 DECLHCCALLBACKMEMBER \
803 DECLRCCALLBACKMEMBER \
804 DECLR3CALLBACKMEMBER \
805 DECLR0CALLBACKMEMBER \
806 DECLRGCALLBACKMEMBER \
807 DECLINLINE \
808 DECL_INLINE_NOTHROW \
809 DECL_FORCE_INLINE \
810 DECLHIDDEN \
811 CTXSUFF \
812 OTHERCTXSUFF \
813 CTXMID \
814 OTHERCTXMID \
815 \
816 INPTR \
817 COMSETTER \
818 COMGETTER \
819 STDMETHOD \
820 STDMETHOD_ \
821 STDMETHODIMP \
822 IFACEMETHODIMP \
823 \
824 DBGDECL \
825 DISDECL \
826 GMMR0DECL \
827 GVMMR0DECL \
828 INTNETDECL \
829 INTNETRCDECL \
830 INTNETR0DECL \
831 INTNETR3DECL \
832 PDMBOTHCBDECL \
833 APICBOTHCBDECL \
834 PGM_BTH_DECL \
835 PGM_GST_DECL \
836 PGM_SHW_DECL \
837 REMDECL \
838 REMRCDECL \
839 REMR0DECL \
840 REMR3DECL \
841 RTDECL \
842 RTRCDECL \
843 RTR0DECL \
844 RTR3DECL \
845 RTDATADECL \
846 RT_DECL_NTAPI \
847 SUPDECL \
848 SUPR0DECL \
849 SUPR3DECL \
850 VBGLR3DECL \
851 VBOXDDU_DECL \
852 VMMDECL \
853 VMMRCDECL \
854 VMMR0DECL \
855 VMMR3DECL \
856 VMM_INT_DECL \
857 \
858 VD_BACKEND_CALLBACK_GET_COMMENT_DEF_NOT_SUPPORTED \
859 VD_BACKEND_CALLBACK_SET_COMMENT_DEF_NOT_SUPPORTED \
860 VD_BACKEND_CALLBACK_GET_UUID_DEF_NOT_SUPPORTED \
861 VD_BACKEND_CALLBACK_SET_UUID_DEF_NOT_SUPPORTED \
862 \
863 IOM_MMIO_STATS_COMMA_DECL \
864 IOM_MMIO_STATS_COMMA_ARG \
865 SUP_HARDENED_SUID
866
867SKIP_FUNCTION_MACROS = NO
868#---------------------------------------------------------------------------
869# Configuration options related to external references
870#---------------------------------------------------------------------------
871TAGFILES =
872GENERATE_TAGFILE =
873ALLEXTERNALS = NO
874EXTERNAL_GROUPS = YES
875EXTERNAL_PAGES = YES
876PERL_PATH = /usr/bin/perl
877#---------------------------------------------------------------------------
878# Configuration options related to the dot tool
879#---------------------------------------------------------------------------
880CLASS_DIAGRAMS = YES
881MSCGEN_PATH =
882DIA_PATH =
883HIDE_UNDOC_RELATIONS = YES
884HAVE_DOT = NO
885DOT_NUM_THREADS = 0
886DOT_FONTNAME = Helvetica
887DOT_FONTSIZE = 10
888DOT_FONTPATH =
889CLASS_GRAPH = YES
890COLLABORATION_GRAPH = YES
891GROUP_GRAPHS = YES
892UML_LOOK = YES
893UML_LIMIT_NUM_FIELDS = 10
894TEMPLATE_RELATIONS = YES
895INCLUDE_GRAPH = YES
896INCLUDED_BY_GRAPH = YES
897CALL_GRAPH = YES
898CALLER_GRAPH = YES
899GRAPHICAL_HIERARCHY = YES
900DIRECTORY_GRAPH = YES
901DOT_IMAGE_FORMAT = png
902INTERACTIVE_SVG = NO
903DOT_PATH =
904DOTFILE_DIRS =
905MSCFILE_DIRS =
906DIAFILE_DIRS =
907PLANTUML_JAR_PATH =
908PLANTUML_INCLUDE_PATH =
909DOT_GRAPH_MAX_NODES = 50
910MAX_DOT_GRAPH_DEPTH = 0
911DOT_TRANSPARENT = YES
912DOT_MULTI_TARGETS = NO
913GENERATE_LEGEND = YES
914DOT_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