VirtualBox

source: vbox/trunk/Doxyfile.Core@ 78203

Last change on this file since 78203 was 75595, checked in by vboxsync, 5 years ago

Doxyfile.Core: experiment...
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 28.4 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{2}="\2. \
52\
[57977]53Implements the callback \link \1 \1 \endlink "
[75595]54ALIASES += \
55 callback_method_impl{1}="Implements the callback \link \1 \1 \endlink @copydoc \1 "
[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
[68378]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
[65885]249# For IEM opcode specs.
[66009]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="-------------------------"
[65885]277
278
[13029]279# bugref - xTracker bug reference, takes one to four bug numbers.
[12759]280ALIASES += bugref{1}="https://xtracker.innotek.de/index.php?bug=\1"
[13029]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.
[12759]292ALIASES += ticketref{1}="http://www.virtualbox.org/ticket/\1"
[13029]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"
[10447]302
[12759]303
[58128]304TCL_SUBST =
[1]305OPTIMIZE_OUTPUT_FOR_C = YES
306OPTIMIZE_OUTPUT_JAVA = NO
[58128]307OPTIMIZE_FOR_FORTRAN = NO
308OPTIMIZE_OUTPUT_VHDL = NO
309EXTENSION_MAPPING =
310MARKDOWN_SUPPORT = YES
311AUTOLINK_SUPPORT = YES
[6288]312BUILTIN_STL_SUPPORT = NO
313CPP_CLI_SUPPORT = NO
314SIP_SUPPORT = NO
[58128]315IDL_PROPERTY_SUPPORT = YES
[6288]316DISTRIBUTE_GROUP_DOC = NO
[1]317SUBGROUPING = YES
[58128]318INLINE_GROUPED_CLASSES = NO
319INLINE_SIMPLE_STRUCTS = NO
[6288]320TYPEDEF_HIDES_STRUCT = NO
[58128]321LOOKUP_CACHE_SIZE = 0
[1]322#---------------------------------------------------------------------------
323# Build related configuration options
324#---------------------------------------------------------------------------
325EXTRACT_ALL = YES
326EXTRACT_PRIVATE = YES
[58128]327EXTRACT_PACKAGE = NO
[1]328EXTRACT_STATIC = YES
329EXTRACT_LOCAL_CLASSES = YES
330EXTRACT_LOCAL_METHODS = NO
[6288]331EXTRACT_ANON_NSPACES = NO
[1]332HIDE_UNDOC_MEMBERS = NO
333HIDE_UNDOC_CLASSES = NO
334HIDE_FRIEND_COMPOUNDS = NO
335HIDE_IN_BODY_DOCS = NO
[61997]336INTERNAL_DOCS = YES
[1]337CASE_SENSE_NAMES = NO
338HIDE_SCOPE_NAMES = NO
[58128]339HIDE_COMPOUND_REFERENCE= NO
[1]340SHOW_INCLUDE_FILES = YES
[58128]341SHOW_GROUPED_MEMB_INC = NO
342FORCE_LOCAL_INCLUDES = NO
[1]343INLINE_INFO = YES
344SORT_MEMBER_DOCS = YES
345SORT_BRIEF_DOCS = NO
[58128]346SORT_MEMBERS_CTORS_1ST = NO
347SORT_GROUP_NAMES = NO
[1]348SORT_BY_SCOPE_NAME = NO
[58128]349STRICT_PROTO_MATCHING = NO
[1]350GENERATE_TODOLIST = YES
351GENERATE_TESTLIST = YES
352GENERATE_BUGLIST = YES
353GENERATE_DEPRECATEDLIST= YES
354ENABLED_SECTIONS =
355MAX_INITIALIZER_LINES = 30
356SHOW_USED_FILES = YES
[58128]357SHOW_FILES = YES
358SHOW_NAMESPACES = YES
[6288]359FILE_VERSION_FILTER =
[58128]360LAYOUT_FILE =
361CITE_BIB_FILES =
[1]362#---------------------------------------------------------------------------
[58128]363# Configuration options related to warning and progress messages
[1]364#---------------------------------------------------------------------------
[9298]365QUIET = YES
[1]366WARNINGS = YES
[12653]367##Later: WARN_IF_UNDOCUMENTED = YES
368WARN_IF_UNDOCUMENTED = NO
[1]369WARN_IF_DOC_ERROR = YES
[6288]370WARN_NO_PARAMDOC = NO
[1]371WARN_FORMAT = "$file:$line: $text"
[6288]372#WARN_LOGFILE = later
[1]373#---------------------------------------------------------------------------
[58128]374# Configuration options related to the input files
[1]375#---------------------------------------------------------------------------
[6288]376# INPUT = later
377INPUT_ENCODING = UTF-8
[1]378FILE_PATTERNS =
379RECURSIVE = NO
380EXCLUDE =
381EXCLUDE_SYMLINKS = NO
382EXCLUDE_PATTERNS =
[6288]383EXCLUDE_SYMBOLS =
[1]384EXAMPLE_PATH =
385EXAMPLE_PATTERNS =
386EXAMPLE_RECURSIVE = NO
[10039]387IMAGE_PATH = \
388 doc \
389 doc/tg/Networking-diagrams \
390 doc/tg/USB-diagrams \
[41857]391 doc/tg/diagrams \
392 doc/VMM
[1]393INPUT_FILTER =
[6288]394FILTER_PATTERNS =
[1]395FILTER_SOURCE_FILES = NO
[58128]396FILTER_SOURCE_PATTERNS =
397USE_MDFILE_AS_MAINPAGE =
[1]398#---------------------------------------------------------------------------
[58128]399# Configuration options related to source browsing
[1]400#---------------------------------------------------------------------------
401SOURCE_BROWSER = NO
402INLINE_SOURCES = NO
403STRIP_CODE_COMMENTS = YES
404REFERENCED_BY_RELATION = YES
405REFERENCES_RELATION = YES
[6288]406REFERENCES_LINK_SOURCE = YES
[58128]407SOURCE_TOOLTIPS = YES
[6288]408USE_HTAGS = NO
[1]409VERBATIM_HEADERS = YES
[58128]410CLANG_ASSISTED_PARSING = NO
411CLANG_OPTIONS =
[1]412#---------------------------------------------------------------------------
[58128]413# Configuration options related to the alphabetical class index
[1]414#---------------------------------------------------------------------------
415ALPHABETICAL_INDEX = NO
416COLS_IN_ALPHA_INDEX = 5
417IGNORE_PREFIX =
418#---------------------------------------------------------------------------
[58128]419# Configuration options related to the HTML output
[1]420#---------------------------------------------------------------------------
421GENERATE_HTML = YES
422HTML_OUTPUT = html
423HTML_FILE_EXTENSION = .html
424HTML_HEADER =
425HTML_FOOTER =
426HTML_STYLESHEET =
[58128]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
[1]440GENERATE_HTMLHELP = NO
441CHM_FILE =
442HHC_LOCATION =
443GENERATE_CHI = NO
[58128]444CHM_INDEX_ENCODING =
[1]445BINARY_TOC = NO
446TOC_EXPAND = NO
[58128]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
[1]457DISABLE_INDEX = NO
[58128]458GENERATE_TREEVIEW = NO
[1]459ENUM_VALUES_PER_LINE = 4
460TREEVIEW_WIDTH = 250
[58128]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 =
[1]476#---------------------------------------------------------------------------
[58128]477# Configuration options related to the LaTeX output
[1]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 =
[58128]487LATEX_FOOTER =
488LATEX_EXTRA_STYLESHEET =
489LATEX_EXTRA_FILES =
[1]490PDF_HYPERLINKS = NO
491USE_PDFLATEX = NO
492LATEX_BATCHMODE = NO
493LATEX_HIDE_INDICES = NO
[58128]494LATEX_SOURCE_CODE = NO
495LATEX_BIB_STYLE = plain
[1]496#---------------------------------------------------------------------------
[58128]497# Configuration options related to the RTF output
[1]498#---------------------------------------------------------------------------
499GENERATE_RTF = NO
500RTF_OUTPUT = rtf
501COMPACT_RTF = NO
502RTF_HYPERLINKS = NO
503RTF_STYLESHEET_FILE =
504RTF_EXTENSIONS_FILE =
[58128]505RTF_SOURCE_CODE = NO
[1]506#---------------------------------------------------------------------------
[58128]507# Configuration options related to the man page output
[1]508#---------------------------------------------------------------------------
509GENERATE_MAN = NO
510MAN_OUTPUT = man
511MAN_EXTENSION = .3
[58128]512MAN_SUBDIR =
[1]513MAN_LINKS = NO
514#---------------------------------------------------------------------------
[58128]515# Configuration options related to the XML output
[1]516#---------------------------------------------------------------------------
517GENERATE_XML = NO
518XML_OUTPUT = xml
519XML_PROGRAMLISTING = YES
520#---------------------------------------------------------------------------
[58128]521# Configuration options related to the DOCBOOK output
[1]522#---------------------------------------------------------------------------
[58128]523GENERATE_DOCBOOK = NO
524DOCBOOK_OUTPUT = docbook
525DOCBOOK_PROGRAMLISTING = NO
526#---------------------------------------------------------------------------
527# Configuration options for the AutoGen Definitions output
528#---------------------------------------------------------------------------
[1]529GENERATE_AUTOGEN_DEF = NO
530#---------------------------------------------------------------------------
[58128]531# Configuration options related to the Perl module output
[1]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
[6288]544# INCLUDE_PATH = later
545# INCLUDE_FILE_PATTERNS = later
[58128]546
[25642]547PREDEFINED = \
548 DOXYGEN_RUNNING \
549 RT_C_DECLS_END \
550 RT_C_DECLS_BEGIN \
[58089]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" \
[58126]564 "RTLOG_COMMA_SRC_POS_DECL=, int SRC_POS" \
[58089]565 \
566 RT_IPRT_FORMAT_ATTR(a,b)= \
567 RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a,b)= \
[58106]568 RT_NO_THROW_PROTO= \
569 RTASN1CONTEXTTAG_IMPL_CURSOR_INLINES(a)=
[58089]570
571# decl and calling conventions.
572PREDEFINED += \
573 "DECLINLINE(type)=inline type" \
[61809]574 APICBOTHCBDECL(type)=type \
[58089]575 DECL_FORCE_INLINE(type)=DECLINLINE(type) \
576 DECL_NO_INLINE(type)=type \
577 DECLCALLBACK(type)=type \
578 DECLEXPORT(type)=type \
579 DECLIMPORT(type)=type \
580 DECLHIDDEN(type)=type \
581 DECL_HIDDEN_CONST(type)=type \
582 DECLASM(type)=type \
[75145]583 RT_ASM_DECL_PRAGMA_WATCOM(type)=type \
584 RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \
[58089]585 DECLNORETURN(type)=type \
586 VBOXCALL= \
[58106]587 RTCALL= \
588 DECLVBGL(type)=type \
589 DECLR0VBGL(type)=type \
[58116]590 USBLIB_DECL(type)=type \
[58126]591 VMMDECL(type)=type \
592 VMMR0DECL(type)=type \
593 VMMR3DECL(type)=type \
594 VMMRCDECL(type)=type \
595 VMMRZDECL(type)=type \
[58116]596 VMMR0_INT_DECL(type)=type \
597 VMMR3_INT_DECL(type)=type \
598 VMMRC_INT_DECL(type)=type \
[58126]599 VMMRZ_INT_DECL(type)=type \
600 GMMR0DECL(type)=type \
[65122]601 GMMR3DECL(type)=type \
[65158]602 VBOX_DND_FN_DECL_LOG(x)=x \
603 DECLSPEC_HIDDEN= \
604 VMSVGA3DCOCOA_DECL(type)=type \
[65168]605 VBOX_LISTENER_DECLARE(a)= \
606 VBOX_WITH_RAW_MODE_NOT_R0
[58106]607
[58626]608# BS3Kit
609PREDEFINED += \
610 BS3_FAR= \
611 BS3_NEAR= \
[60597]612 BS3_FAR_DATA= \
[58626]613 BS3_DECL(a_Type)=a_Type \
[60597]614 BS3_DECL_NEAR(a_Type)=a_Type \
615 BS3_DECL_FAR(a_Type)=a_Type \
[60598]616 BS3_DECL_CALLBACK(a_Type)=a_Type \
[64367]617 BS3_DECL_NEAR_CALLBACK(a_Type)=a_Type \
[59481]618 BS3_CMN_NM(a_Name)=a_Name \
[60586]619 BS3_CMN_FAR_NM(a_Name)=a_Name \
620 BS3_CMN_FN_NM(a_Name)=a_Name \
621 BS3_DATA_NM(a_Name)=a_Name \
622 TMPL_NM(a_Name)=a_Name##_mmm \
623 TMPL_FAR_NM(a_Name)=a_Name##_mmm \
[60597]624 "BS3_CMN_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
625 "BS3_CMN_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
[64367]626 "BS3_CMN_PROTO_FARSTUB(a_cbParam16, a_RetType, a_Name, a_Params)=a_RetType a_Name a_Params" \
[60597]627 "BS3_CMN_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name a_Params" \
628 "BS3_MODE_PROTO_STUB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
629 "BS3_MODE_PROTO_NOSB(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
630 "BS3_MODE_DEF(a_RetType,a_Name,a_Params)=a_RetType a_Name##_mmm a_Params" \
631 "BS3_PTR_UNION_TEMPLATE(a_BaseName,a_Modifiers)=typedef union a_BaseName { a_Modifiers void *pv } a_BaseName, * P##a_BaseName; }" \
632 "BS3_XPTR_MEMBER(a_Type,a_Name)=a_Type * a_Name" \
[58626]633
[60586]634
[58116]635# templated fun.
636PREDEFINED += \
637 "PGM_BTH_DECL(type,name)=type pgmBth##name" \
638 "PGM_SHW_DECL(type,name)=type pgmShw##name" \
639 "PGM_GST_DECL(type,name)=type pgmGst##name" \
640 "PGM_BTH_NAME(name)=pgmBth##name" \
641 "PGM_SHW_NAME(name)=pgmShw##name" \
642 "PGM_GST_NAME(name)=pgmGst##name" \
643 PGM_ALL_CB_DECL(type)=type \
644 PGM_ALL_CB2_DECL(type)=type \
[58126]645 PGMPHYS_DATATYPE=uintXX_t \
646 "PGMPHYSFN_READNAME(a,b,c)=PGMR3PhysReadUxx(a,b,c)" \
647 "PGMPHYSFN_WRITENAME(a,b,c,d)=PGMR3PhysWriteUxx(a,b,c,d)" \
[58116]648
[58089]649# context hacks.
650PREDEFINED += RCPTRTYPE(RCType)=RCType
651PREDEFINED += R3PTRTYPE(R3Type)=R3Type
652PREDEFINED += R0PTRTYPE(R0Type)=R0Type
653PREDEFINED += HCPTRTYPE(HCType)=HCType
654PREDEFINED += R3R0PTRTYPE(R3R0Type)=R3R0Type
[58127]655PREDEFINED += \
656 "CTX_SUFF(var)=var##R3" \
657 "CTX_SUFF_Z(var)=var##RZ" \
658 "CTX_MID(first,last)=firstr##R3##last" \
659 "CTX_MID_Z(first,last)=firstr##RZ##last" \
[58106]660
[58089]661# Compile assertion hacks.
662PREDEFINED += \
[39688]663 AssertCompileNS(expr) \
664 AssertCompile(expr) \
665 AssertCompileSize(type, size) \
666 AssertCompileSizeAlignment(type, align) \
667 AssertCompileMemberAlignment(type, member, align) \
668 AssertCompileMemberOffset(type, member, off) \
669 AssertCompile2MemberOffsets(type, member1, member2) \
670 AssertCompileAdjacentMembers(type, member1, member2) \
671 AssertCompileMembersAtSameOffset(type1, member1, type2, member2) \
672 AssertCompileMemberSize(type, member, size) \
673 AssertCompileMemberSizeAlignment(type, member, align) \
674 AssertCompileMembersSameSize(type1, member1, type2, member2) \
675 AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)
[58106]676
[12653]677# COM/XPCOM hacks.
[58106]678PREDEFINED += \
679 STDMETHODIMP=HRESULT \
[65105]680 IFACEMETHODIMP=HRESULT \
681 IFACEMETHODIMP_(t)=t \
[58106]682 "COMGETTER(n)=get_##n" \
683 "COMSETTER(n)=set_##n" \
684 "ComSafeArrayIn(aType,aArg)=aType *aArg" \
685 "ComSafeArrayOut(aType, aArg)=aType **aArg" \
[65088]686 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(a)= \
687 DECLARE_NOT_AGGREGATABLE(a)= \
688 DECLARE_CLASSFACTORY()= \
689 DECLARE_CLASSFACTORY_SINGLETON(a)= \
690 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(a,b)= \
691 "DECLARE_EMPTY_CTOR_DTOR(a):=a(); virtual ~a();"
[58106]692
[12653]693# COM hacks from From http://www.stack.nl/~dimitri/doxygen/preprocessing.html
[58106]694PREDEFINED += \
695 "DECLARE_INTERFACE(name)=class name" \
696 "STDMETHOD_(result,name)=virtual result name" \
697 "PURE= = 0" \
698 THIS_= \
699 THIS= \
[65426]700 NTSTATUS=long \
[65433]701 LONG=long \
[65436]702 NTAPI= \
[65433]703 WINAPI= \
[58106]704 DECLARE_REGISTRY_RESOURCEID=// \
705 DECLARE_PROTECT_FINAL_CONSTRUCT=// \
706 "DECLARE_AGGREGATABLE(Class)= " \
707 "DECLARE_REGISTRY_RESOURCEID(Id)= " \
708 DECLARE_MESSAGE_MAP= \
709 BEGIN_MESSAGE_MAP=/* \
710 END_MESSAGE_MAP=*/// \
711 BEGIN_COM_MAP=/* \
712 END_COM_MAP=*/// \
713 BEGIN_PROP_MAP=/* \
714 END_PROP_MAP=*/// \
715 BEGIN_MSG_MAP=/* \
716 END_MSG_MAP=*/// \
717 BEGIN_PROPERTY_MAP=/* \
718 END_PROPERTY_MAP=*/// \
719 BEGIN_OBJECT_MAP=/* \
720 END_OBJECT_MAP()=*/// \
721 DECLARE_VIEW_STATUS=// \
722 "STDMETHOD(a)=HRESULT a" \
723 "ATL_NO_VTABLE= " \
724 "__declspec(a)= " \
725 BEGIN_CONNECTION_POINT_MAP=/* \
726 END_CONNECTION_POINT_MAP=*/// \
727 "DECLARE_DYNAMIC(class)= " \
728 "IMPLEMENT_DYNAMIC(class1, class2)= " \
729 "DECLARE_DYNCREATE(class)= " \
730 "IMPLEMENT_DYNCREATE(class1, class2)= " \
731 "IMPLEMENT_SERIAL(class1, class2, class3)= " \
732 "DECLARE_MESSAGE_MAP()= " \
733 TRY=try \
734 "CATCH_ALL(e)= catch(...)" \
735 END_CATCH_ALL= \
736 "THROW_LAST()= throw"\
737 "RUNTIME_CLASS(class)=class" \
738 "MAKEINTRESOURCE(nId)=nId" \
739 "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
740 "ASSERT(x)=assert(x)" \
741 "ASSERT_VALID(x)=assert(x)" \
742 "TRACE0(x)=printf(x)" \
743 "OS_ERR(A,B)={ #A, B }" \
744 __cplusplus \
745 "DECLARE_OLECREATE(class)= " \
746 "BEGIN_DISPATCH_MAP(class1, class2)= " \
747 "BEGIN_INTERFACE_MAP(class1, class2)= " \
748 "INTERFACE_PART(class, id, name)= " \
749 "END_INTERFACE_MAP()=" \
750 "DISP_FUNCTION(class, name, function, result, id)=" \
751 "END_DISPATCH_MAP()=" \
[62073]752 "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11)=" \
753 RT_GCC_EXTENSION= \
754 "CPUM_STRUCT_NM(n)=" \
[62693]755 "CPUM_UNION_NM(n)=" \
[75438]756 "DECL_NO_RETURN(type)=type" \
757 VBOX_WITH_HGCM
[12648]758
[1]759EXPAND_AS_DEFINED = \
[12648]760 RCPTRTYPE \
[6288]761 R3PTRTYPE \
762 R0PTRTYPE \
[12648]763 HCPTRTYPE \
[6288]764 R3R0PTRTYPE \
[1]765 \
[6288]766 ARCH_BITS \
767 R3_ARCH_BITS \
768 R0_ARCH_BITS \
769 GC_ARCH_BITS \
770 HC_ARCH_BITS \
771 \
[1]772 DECLEXPORT \
773 DECLIMPORT \
774 DECLASM \
775 DECLASMTYPE \
776 DECLCALLBACK \
777 DECLCALLBACKMEMBER \
[64294]778 DECLCALLBACKPTR \
[1]779 DECLHCCALLBACKMEMBER \
[12653]780 DECLRCCALLBACKMEMBER \
[6288]781 DECLR3CALLBACKMEMBER \
782 DECLR0CALLBACKMEMBER \
[1]783 DECLINLINE \
[25645]784 DECL_FORCE_INLINE \
785 DECLHIDDEN \
[1]786 CTXSUFF \
787 OTHERCTXSUFF \
788 CTXMID \
789 OTHERCTXMID \
790 \
[12653]791 INPTR \
[6288]792 COMSETTER \
793 COMGETTER \
794 STDMETHOD \
[12653]795 STDMETHOD_ \
[6288]796 STDMETHODIMP \
[65105]797 IFACEMETHODIMP \
[6288]798 \
[1]799 DBGDECL \
800 DISDECL \
[6288]801 GMMR0DECL \
802 GVMMR0DECL \
[1]803 INTNETDECL \
[25642]804 INTNETRCDECL \
[1]805 INTNETR0DECL \
806 INTNETR3DECL \
807 PDMBOTHCBDECL \
[61808]808 APICBOTHCBDECL \
[6288]809 PGM_BTH_DECL \
810 PGM_GST_DECL \
811 PGM_SHW_DECL \
[1]812 REMDECL \
[25642]813 REMRCDECL \
[1]814 REMR0DECL \
815 REMR3DECL \
816 RTDECL \
[25642]817 RTRCDECL \
[1]818 RTR0DECL \
819 RTR3DECL \
820 RTDATADECL \
821 SUPDECL \
822 SUPR0DECL \
823 SUPR3DECL \
[6288]824 VBGLR3DECL \
825 VBOXDDU_DECL \
[1]826 VMMDECL \
[25642]827 VMMRCDECL \
[1]828 VMMR0DECL \
[25647]829 VMMR3DECL \
[66499]830 VMM_INT_DECL \
831 VD_BACKEND_CALLBACK_GET_COMMENT_DEF_NOT_SUPPORTED \
832 VD_BACKEND_CALLBACK_SET_COMMENT_DEF_NOT_SUPPORTED \
833 VD_BACKEND_CALLBACK_GET_UUID_DEF_NOT_SUPPORTED \
834 VD_BACKEND_CALLBACK_SET_UUID_DEF_NOT_SUPPORTED
[1]835
[6288]836SKIP_FUNCTION_MACROS = NO
[1]837#---------------------------------------------------------------------------
[58128]838# Configuration options related to external references
[1]839#---------------------------------------------------------------------------
840TAGFILES =
841GENERATE_TAGFILE =
842ALLEXTERNALS = NO
843EXTERNAL_GROUPS = YES
[58128]844EXTERNAL_PAGES = YES
[1]845PERL_PATH = /usr/bin/perl
846#---------------------------------------------------------------------------
847# Configuration options related to the dot tool
848#---------------------------------------------------------------------------
849CLASS_DIAGRAMS = YES
[6288]850MSCGEN_PATH =
[58128]851DIA_PATH =
[1]852HIDE_UNDOC_RELATIONS = YES
853HAVE_DOT = NO
[58128]854DOT_NUM_THREADS = 0
855DOT_FONTNAME = Helvetica
856DOT_FONTSIZE = 10
857DOT_FONTPATH =
[1]858CLASS_GRAPH = YES
859COLLABORATION_GRAPH = YES
[6288]860GROUP_GRAPHS = YES
[1]861UML_LOOK = YES
[58128]862UML_LIMIT_NUM_FIELDS = 10
[1]863TEMPLATE_RELATIONS = YES
864INCLUDE_GRAPH = YES
865INCLUDED_BY_GRAPH = YES
866CALL_GRAPH = YES
[6288]867CALLER_GRAPH = YES
[1]868GRAPHICAL_HIERARCHY = YES
[6288]869DIRECTORY_GRAPH = YES
[1]870DOT_IMAGE_FORMAT = png
[58128]871INTERACTIVE_SVG = NO
[1]872DOT_PATH =
873DOTFILE_DIRS =
[58128]874MSCFILE_DIRS =
875DIAFILE_DIRS =
876PLANTUML_JAR_PATH =
877PLANTUML_INCLUDE_PATH =
[6288]878DOT_GRAPH_MAX_NODES = 50
[1]879MAX_DOT_GRAPH_DEPTH = 0
[6288]880DOT_TRANSPARENT = YES
881DOT_MULTI_TARGETS = NO
[1]882GENERATE_LEGEND = YES
883DOT_CLEANUP = YES
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use