VirtualBox

source: vbox/trunk/Doxyfile.Core@ 84073

Last change on this file since 84073 was 83753, checked in by vboxsync, 5 years ago

/Doxyfile.Core: Another shot at the bldprog-strtab-template.cpp.h doxygen issue. bugref:8489
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 28.6 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{6}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
134<b>Name:</b> [Device Instance]/\1 <br> \
135<b>Type:</b> \2 <br> \
136<b>Unit:</b> \6 <br> \
137<b>Min:</b> \3 <br> \
138<b>Max:</b> \4 <br> \
139<b>Default:</b> \5 <br> \
140"
141ALIASES += \
142 devcfgm{5}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
143<b>Name:</b> [Device Instance]/\1 <br> \
144<b>Type:</b> \2 <br> \
145<b>Min:</b> \3 <br> \
146<b>Max:</b> \4 <br> \
147<b>Default:</b> \5 <br> \
148"
149ALIASES += \
150 devcfgm{4}="\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>Min:</b> \3 <br> \
154<b>Max:</b> \4 <br> \
155"
156ALIASES += \
157 devcfgm{3}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
158<b>Name:</b> [Device Instance]/\1 <br> \
159<b>Type:</b> \2 <br> \
160<b>Default:</b> \3 <br> \
161"
162ALIASES += \
163 devcfgm{2}="\xrefitem lst_cfgm \"Device Config: \1\" \"VM Configuration Values\" \
164<b>Name:</b> [Device Instance]/\1 <br> \
165<b>Type:</b> \2 <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_NO_THROW_PROTO= \
569 RTASN1CONTEXTTAG_IMPL_CURSOR_INLINES(a)= \
570 \
571 RT_MSC_PREREQ(a)=0 \
572 RT_MSC_PREREQ_EX(a,b)=b
573
574# decl and calling conventions.
575PREDEFINED += \
576 "DECLINLINE(type)=inline type" \
577 APICBOTHCBDECL(type)=type \
578 DECL_FORCE_INLINE(type)=DECLINLINE(type) \
579 DECL_NO_INLINE(type)=type \
580 DECLCALLBACK(type)=type \
581 DECLEXPORT(type)=type \
582 DECLIMPORT(type)=type \
583 DECLHIDDEN(type)=type \
584 DECL_HIDDEN_CONST(type)=type \
585 DECLASM(type)=type \
586 RT_ASM_DECL_PRAGMA_WATCOM(type)=type \
587 RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \
588 DECLNORETURN(type)=type \
589 VBOXCALL= \
590 RTCALL= \
591 DECLVBGL(type)=type \
592 DECLR0VBGL(type)=type \
593 USBLIB_DECL(type)=type \
594 VMMDECL(type)=type \
595 VMMR0DECL(type)=type \
596 VMMR3DECL(type)=type \
597 VMMRCDECL(type)=type \
598 VMMRZDECL(type)=type \
599 VMMR0_INT_DECL(type)=type \
600 VMMR3_INT_DECL(type)=type \
601 VMMRC_INT_DECL(type)=type \
602 VMMRZ_INT_DECL(type)=type \
603 GMMR0DECL(type)=type \
604 GMMR3DECL(type)=type \
605 VBOX_DND_FN_DECL_LOG(x)=x \
606 DECLSPEC_HIDDEN= \
607 VMSVGA3DCOCOA_DECL(type)=type \
608 VBOX_LISTENER_DECLARE(a)= \
609 VBOX_WITH_RAW_MODE_NOT_R0
610
611# BS3Kit
612PREDEFINED += \
613 BS3_FAR= \
614 BS3_NEAR= \
615 BS3_FAR_DATA= \
616 BS3_DECL(a_Type)=a_Type \
617 BS3_DECL_NEAR(a_Type)=a_Type \
618 BS3_DECL_FAR(a_Type)=a_Type \
619 BS3_DECL_CALLBACK(a_Type)=a_Type \
620 BS3_DECL_NEAR_CALLBACK(a_Type)=a_Type \
621 BS3_CMN_NM(a_Name)=a_Name \
622 BS3_CMN_FAR_NM(a_Name)=a_Name \
623 BS3_CMN_FN_NM(a_Name)=a_Name \
624 BS3_DATA_NM(a_Name)=a_Name \
625 TMPL_NM(a_Name)=a_Name##_mmm \
626 TMPL_FAR_NM(a_Name)=a_Name##_mmm \
627 "BS3_CMN_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
628 "BS3_CMN_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
629 "BS3_CMN_PROTO_FARSTUB(a_cbParam16, a_RetType, a_Name, a_Params)=a_RetType a_Name a_Params" \
630 "BS3_CMN_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
631 "BS3_MODE_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
632 "BS3_MODE_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
633 "BS3_MODE_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
634 "BS3_PTR_UNION_TEMPLATE(a_BaseName,a_Modifiers)=typedef union a_BaseName { a_Modifiers void *pv } a_BaseName, * P##a_BaseName; }" \
635 "BS3_XPTR_MEMBER(a_Type,a_Name)=a_Type * a_Name" \
636
637
638# templated fun.
639PREDEFINED += \
640 "PGM_BTH_DECL(type,name)=type pgmBth##name" \
641 "PGM_SHW_DECL(type,name)=type pgmShw##name" \
642 "PGM_GST_DECL(type,name)=type pgmGst##name" \
643 "PGM_BTH_NAME(name)=pgmBth##name" \
644 "PGM_SHW_NAME(name)=pgmShw##name" \
645 "PGM_GST_NAME(name)=pgmGst##name" \
646 PGM_ALL_CB_DECL(type)=type \
647 PGM_ALL_CB2_DECL(type)=type \
648 PGMPHYS_DATATYPE=uintXX_t \
649 "PGMPHYSFN_READNAME(a,b,c)=PGMR3PhysReadUxx(a,b,c)" \
650 "PGMPHYSFN_WRITENAME(a,b,c,d)=PGMR3PhysWriteUxx(a,b,c,d)" \
651
652# context hacks.
653PREDEFINED += RCPTRTYPE(RCType)=RCType
654PREDEFINED += R3PTRTYPE(R3Type)=R3Type
655PREDEFINED += R0PTRTYPE(R0Type)=R0Type
656PREDEFINED += HCPTRTYPE(HCType)=HCType
657PREDEFINED += R3R0PTRTYPE(R3R0Type)=R3R0Type
658PREDEFINED += \
659 "CTX_SUFF(var)=var##R3" \
660 "CTX_SUFF_Z(var)=var##RZ" \
661 "CTX_MID(first,last)=firstr##R3##last" \
662 "CTX_MID_Z(first,last)=firstr##RZ##last" \
663
664# Compile assertion hacks.
665PREDEFINED += \
666 "AssertCompileNS(expr)" \
667 "AssertCompile(expr)" \
668 "AssertCompileSize(type, size)" \
669 "AssertCompileSizeAlignment(type, align)" \
670 "AssertCompileMemberAlignment(type, member, align)" \
671 "AssertCompileMemberOffset(type, member, off)" \
672 "AssertCompile2MemberOffsets(type, member1, member2)" \
673 "AssertCompileAdjacentMembers(type, member1, member2)" \
674 "AssertCompileMembersAtSameOffset(type1, member1, type2, member2)" \
675 "AssertCompileMemberSize(type, member, size)" \
676 "AssertCompileMemberSizeAlignment(type, member, align)" \
677 "AssertCompileMembersSameSize(type1, member1, type2, member2)" \
678 "AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)"
679
680# COM/XPCOM hacks.
681PREDEFINED += \
682 STDMETHODIMP=HRESULT \
683 IFACEMETHODIMP=HRESULT \
684 IFACEMETHODIMP_(t)=t \
685 "COMGETTER(n)=get_##n" \
686 "COMSETTER(n)=set_##n" \
687 "ComSafeArrayIn(aType,aArg)=aType *aArg" \
688 "ComSafeArrayOut(aType, aArg)=aType **aArg" \
689 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(a)= \
690 DECLARE_NOT_AGGREGATABLE(a)= \
691 DECLARE_CLASSFACTORY()= \
692 DECLARE_CLASSFACTORY_SINGLETON(a)= \
693 "VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(a,b)=" \
694 "DECLARE_EMPTY_CTOR_DTOR(a):=a(); virtual ~a();"
695
696# COM hacks from From http://www.stack.nl/~dimitri/doxygen/preprocessing.html
697PREDEFINED += \
698 "DECLARE_INTERFACE(name)=class name" \
699 "STDMETHOD_(result,name)=virtual result name" \
700 "PURE= = 0" \
701 THIS_= \
702 THIS= \
703 NTSTATUS=long \
704 LONG=long \
705 NTAPI= \
706 WINAPI= \
707 DECLARE_REGISTRY_RESOURCEID=// \
708 DECLARE_PROTECT_FINAL_CONSTRUCT=// \
709 "DECLARE_AGGREGATABLE(Class)= " \
710 "DECLARE_REGISTRY_RESOURCEID(Id)= " \
711 DECLARE_MESSAGE_MAP= \
712 BEGIN_MESSAGE_MAP=/* \
713 END_MESSAGE_MAP=*/// \
714 BEGIN_COM_MAP=/* \
715 END_COM_MAP=*/// \
716 BEGIN_PROP_MAP=/* \
717 END_PROP_MAP=*/// \
718 BEGIN_MSG_MAP=/* \
719 END_MSG_MAP=*/// \
720 BEGIN_PROPERTY_MAP=/* \
721 END_PROPERTY_MAP=*/// \
722 BEGIN_OBJECT_MAP=/* \
723 END_OBJECT_MAP()=*/// \
724 DECLARE_VIEW_STATUS=// \
725 "STDMETHOD(a)=HRESULT a" \
726 "ATL_NO_VTABLE= " \
727 "__declspec(a)= " \
728 BEGIN_CONNECTION_POINT_MAP=/* \
729 END_CONNECTION_POINT_MAP=*/// \
730 "DECLARE_DYNAMIC(class)= " \
731 "IMPLEMENT_DYNAMIC(class1, class2)= " \
732 "DECLARE_DYNCREATE(class)= " \
733 "IMPLEMENT_DYNCREATE(class1, class2)= " \
734 "IMPLEMENT_SERIAL(class1, class2, class3)= " \
735 "DECLARE_MESSAGE_MAP()= " \
736 TRY=try \
737 "CATCH_ALL(e)= catch(...)" \
738 END_CATCH_ALL= \
739 "THROW_LAST()= throw"\
740 "RUNTIME_CLASS(class)=class" \
741 "MAKEINTRESOURCE(nId)=nId" \
742 "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
743 "ASSERT(x)=assert(x)" \
744 "ASSERT_VALID(x)=assert(x)" \
745 "TRACE0(x)=printf(x)" \
746 "OS_ERR(A,B)={ #A, B }" \
747 __cplusplus \
748 "DECLARE_OLECREATE(class)= " \
749 "BEGIN_DISPATCH_MAP(class1, class2)= " \
750 "BEGIN_INTERFACE_MAP(class1, class2)= " \
751 "INTERFACE_PART(class, id, name)= " \
752 "END_INTERFACE_MAP()=" \
753 "DISP_FUNCTION(class, name, function, result, id)=" \
754 "END_DISPATCH_MAP()=" \
755 "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11)=" \
756 RT_GCC_EXTENSION= \
757 "CPUM_STRUCT_NM(n)=" \
758 "CPUM_UNION_NM(n)=" \
759 "DECL_NO_RETURN(type)=type" \
760 VBOX_WITH_HGCM
761
762EXPAND_AS_DEFINED = \
763 RCPTRTYPE \
764 R3PTRTYPE \
765 R0PTRTYPE \
766 HCPTRTYPE \
767 R3R0PTRTYPE \
768 \
769 ARCH_BITS \
770 R3_ARCH_BITS \
771 R0_ARCH_BITS \
772 GC_ARCH_BITS \
773 HC_ARCH_BITS \
774 \
775 DECLEXPORT \
776 DECLIMPORT \
777 DECLASM \
778 DECLASMTYPE \
779 DECLCALLBACK \
780 DECLCALLBACKMEMBER \
781 DECLCALLBACKPTR \
782 DECLHCCALLBACKMEMBER \
783 DECLRCCALLBACKMEMBER \
784 DECLR3CALLBACKMEMBER \
785 DECLR0CALLBACKMEMBER \
786 DECLRGCALLBACKMEMBER \
787 DECLINLINE \
788 DECL_FORCE_INLINE \
789 DECLHIDDEN \
790 CTXSUFF \
791 OTHERCTXSUFF \
792 CTXMID \
793 OTHERCTXMID \
794 \
795 INPTR \
796 COMSETTER \
797 COMGETTER \
798 STDMETHOD \
799 STDMETHOD_ \
800 STDMETHODIMP \
801 IFACEMETHODIMP \
802 \
803 DBGDECL \
804 DISDECL \
805 GMMR0DECL \
806 GVMMR0DECL \
807 INTNETDECL \
808 INTNETRCDECL \
809 INTNETR0DECL \
810 INTNETR3DECL \
811 PDMBOTHCBDECL \
812 APICBOTHCBDECL \
813 PGM_BTH_DECL \
814 PGM_GST_DECL \
815 PGM_SHW_DECL \
816 REMDECL \
817 REMRCDECL \
818 REMR0DECL \
819 REMR3DECL \
820 RTDECL \
821 RTRCDECL \
822 RTR0DECL \
823 RTR3DECL \
824 RTDATADECL \
825 SUPDECL \
826 SUPR0DECL \
827 SUPR3DECL \
828 VBGLR3DECL \
829 VBOXDDU_DECL \
830 VMMDECL \
831 VMMRCDECL \
832 VMMR0DECL \
833 VMMR3DECL \
834 VMM_INT_DECL \
835 \
836 VD_BACKEND_CALLBACK_GET_COMMENT_DEF_NOT_SUPPORTED \
837 VD_BACKEND_CALLBACK_SET_COMMENT_DEF_NOT_SUPPORTED \
838 VD_BACKEND_CALLBACK_GET_UUID_DEF_NOT_SUPPORTED \
839 VD_BACKEND_CALLBACK_SET_UUID_DEF_NOT_SUPPORTED \
840 \
841 IOM_MMIO_STATS_COMMA_DECL \
842 IOM_MMIO_STATS_COMMA_ARG \
843 SUP_HARDENED_SUID
844
845SKIP_FUNCTION_MACROS = NO
846#---------------------------------------------------------------------------
847# Configuration options related to external references
848#---------------------------------------------------------------------------
849TAGFILES =
850GENERATE_TAGFILE =
851ALLEXTERNALS = NO
852EXTERNAL_GROUPS = YES
853EXTERNAL_PAGES = YES
854PERL_PATH = /usr/bin/perl
855#---------------------------------------------------------------------------
856# Configuration options related to the dot tool
857#---------------------------------------------------------------------------
858CLASS_DIAGRAMS = YES
859MSCGEN_PATH =
860DIA_PATH =
861HIDE_UNDOC_RELATIONS = YES
862HAVE_DOT = NO
863DOT_NUM_THREADS = 0
864DOT_FONTNAME = Helvetica
865DOT_FONTSIZE = 10
866DOT_FONTPATH =
867CLASS_GRAPH = YES
868COLLABORATION_GRAPH = YES
869GROUP_GRAPHS = YES
870UML_LOOK = YES
871UML_LIMIT_NUM_FIELDS = 10
872TEMPLATE_RELATIONS = YES
873INCLUDE_GRAPH = YES
874INCLUDED_BY_GRAPH = YES
875CALL_GRAPH = YES
876CALLER_GRAPH = YES
877GRAPHICAL_HIERARCHY = YES
878DIRECTORY_GRAPH = YES
879DOT_IMAGE_FORMAT = png
880INTERACTIVE_SVG = NO
881DOT_PATH =
882DOTFILE_DIRS =
883MSCFILE_DIRS =
884DIAFILE_DIRS =
885PLANTUML_JAR_PATH =
886PLANTUML_INCLUDE_PATH =
887DOT_GRAPH_MAX_NODES = 50
888MAX_DOT_GRAPH_DEPTH = 0
889DOT_TRANSPARENT = YES
890DOT_MULTI_TARGETS = NO
891GENERATE_LEGEND = YES
892DOT_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