VirtualBox

source: vbox/trunk/Doxyfile.Core@ 67954

Last change on this file since 67954 was 66499, checked in by vboxsync, 7 years ago

Another doxygen fix

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

© 2023 Oracle
ContactPrivacy policyTerms of Use