VirtualBox

source: vbox/trunk/Doxyfile.Core@ 91933

Last change on this file since 91933 was 90832, checked in by vboxsync, 3 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use