VirtualBox

source: vbox/trunk/Doxyfile.Core@ 10494

Last change on this file since 10494 was 10448, checked in by vboxsync, 16 years ago

Corrected the xrefitem for the cfgm macros again.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.4 KB
Line 
1# Doxyfile 1.5.4
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = VBox
8PROJECT_NUMBER =
9# OUTPUT_DIRECTORY = later
10CREATE_SUBDIRS = NO
11OUTPUT_LANGUAGE = English
12BRIEF_MEMBER_DESC = YES
13REPEAT_BRIEF = YES
14ABBREVIATE_BRIEF =
15ALWAYS_DETAILED_SEC = NO
16INLINE_INHERITED_MEMB = NO
17FULL_PATH_NAMES = NO
18STRIP_FROM_PATH =
19STRIP_FROM_INC_PATH =
20SHORT_NAMES = NO
21JAVADOC_AUTOBRIEF = YES
22QT_AUTOBRIEF = NO
23MULTILINE_CPP_IS_BRIEF = NO
24DETAILS_AT_TOP = NO
25INHERIT_DOCS = YES
26SEPARATE_MEMBER_PAGES = NO
27TAB_SIZE = 4
28ALIASES = \
29 "note=@remark" \
30 "thread=@par Thread Context:\n" \
31 "vmstate=@par VM State In:\n" \
32 "vmstateto=@par VM State Out:\n"
33
34# The following is for Global Configuration options.
35ALIASES += \
36 gcfgm{6}="\xrefitem lst_gcfgm \"GCFGM\" \"Global Configuration Values\" \
37<b>Name:</b> \1 <br> \
38<b>Type:</b> \2 <br> \
39<b>Unit:</b> \6 <br> \
40<b>Min:</b> \3 <br> \
41<b>Max:</b> \4 <br> \
42<b>Default:</b> \5 <br> \
43"
44ALIASES += \
45 gcfgm{5}="\xrefitem lst_gcfgm \"GCFGM\" \"Global Configuration Values\" \
46<b>Name:</b> \1 <br> \
47<b>Type:</b> \2 <br> \
48<b>Min:</b> \3 <br> \
49<b>Max:</b> \4 <br> \
50<b>Default:</b> \5 <br> \
51"
52ALIASES += \
53 gcfgm{4}="\xrefitem lst_gcfgm \"GCFGM\" \"Global Configuration Values\" \
54<b>Name:</b> \1 <br> \
55<b>Type:</b> \2 <br> \
56<b>Min:</b> \3 <br> \
57<b>Max:</b> \4 <br> \
58"
59ALIASES += \
60 gcfgm{3}="\xrefitem lst_gcfgm \"GCFGM\" \"Global Configuration Values\" \
61<b>Name:</b> \1 <br> \
62<b>Type:</b> \2 <br> \
63<b>Default:</b> \3 <br> \
64"
65ALIASES += \
66 gcfgm{2}="\xrefitem lst_gcfgm \"GCFGM\" \"Global Configuration Values\" \
67<b>Name:</b> \1 <br> \
68<b>Type:</b> \2 <br> \
69"
70
71# The following is for per-VM Configuration options.
72ALIASES += \
73 cfgm{6}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
74<b>Name:</b> \1 <br> \
75<b>Type:</b> \2 <br> \
76<b>Unit:</b> \6 <br> \
77<b>Min:</b> \3 <br> \
78<b>Max:</b> \4 <br> \
79<b>Default:</b> \5 <br> \
80"
81ALIASES += \
82 cfgm{5}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
83<b>Name:</b> \1 <br> \
84<b>Type:</b> \2 <br> \
85<b>Min:</b> \3 <br> \
86<b>Max:</b> \4 <br> \
87<b>Default:</b> \5 <br> \
88"
89ALIASES += \
90 cfgm{4}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
91<b>Name:</b> \1 <br> \
92<b>Type:</b> \2 <br> \
93<b>Min:</b> \3 <br> \
94<b>Max:</b> \4 <br> \
95"
96ALIASES += \
97 cfgm{3}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
98<b>Name:</b> \1 <br> \
99<b>Type:</b> \2 <br> \
100<b>Default:</b> \3 <br> \
101"
102ALIASES += \
103 cfgm{2}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
104<b>Name:</b> \1 <br> \
105<b>Type:</b> \2 <br> \
106"
107
108# The following is for device configuration options.
109ALIASES += \
110 devcfgm{6}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
111<b>Name:</b> [Device Instance]/\1 <br> \
112<b>Type:</b> \2 <br> \
113<b>Unit:</b> \6 <br> \
114<b>Min:</b> \3 <br> \
115<b>Max:</b> \4 <br> \
116<b>Default:</b> \5 <br> \
117"
118ALIASES += \
119 devcfgm{5}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
120<b>Name:</b> [Device Instance]/\1 <br> \
121<b>Type:</b> \2 <br> \
122<b>Min:</b> \3 <br> \
123<b>Max:</b> \4 <br> \
124<b>Default:</b> \5 <br> \
125"
126ALIASES += \
127 devcfgm{4}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
128<b>Name:</b> [Device Instance]/\1 <br> \
129<b>Type:</b> \2 <br> \
130<b>Min:</b> \3 <br> \
131<b>Max:</b> \4 <br> \
132"
133ALIASES += \
134 devcfgm{3}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
135<b>Name:</b> [Device Instance]/\1 <br> \
136<b>Type:</b> \2 <br> \
137<b>Default:</b> \3 <br> \
138"
139ALIASES += \
140 devcfgm{2}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
141<b>Name:</b> [Device Instance]/\1 <br> \
142<b>Type:</b> \2 <br> \
143"
144
145# The following is for driver configuration options.
146ALIASES += \
147 drvcfgm{6}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
148<b>Name:</b> [Driver Instance]/\1 <br> \
149<b>Type:</b> \2 <br> \
150<b>Unit:</b> \6 <br> \
151<b>Min:</b> \3 <br> \
152<b>Max:</b> \4 <br> \
153<b>Default:</b> \5 <br> \
154"
155ALIASES += \
156 drvcfgm{5}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
157<b>Name:</b> [Driver Instance]/\1 <br> \
158<b>Type:</b> \2 <br> \
159<b>Min:</b> \3 <br> \
160<b>Max:</b> \4 <br> \
161<b>Default:</b> \5 <br> \
162"
163ALIASES += \
164 drvcfgm{4}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
165<b>Name:</b> [Driver Instance]/\1 <br> \
166<b>Type:</b> \2 <br> \
167<b>Min:</b> \3 <br> \
168<b>Max:</b> \4 <br> \
169"
170ALIASES += \
171 drvcfgm{3}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
172<b>Name:</b> [Driver Instance]/\1 <br> \
173<b>Type:</b> \2 <br> \
174<b>Default:</b> \3 <br> \
175"
176ALIASES += \
177 drvcfgm{2}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
178<b>Name:</b> [Driver Instance]/\1 <br> \
179<b>Type:</b> \2 <br> \
180"
181
182# The following is for USB device configuration options.
183ALIASES += \
184 usbcfgm{6}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
185<b>Name:</b> [USB Device Instance]/\1 <br> \
186<b>Type:</b> \2 <br> \
187<b>Unit:</b> \6 <br> \
188<b>Min:</b> \3 <br> \
189<b>Max:</b> \4 <br> \
190<b>Default:</b> \5 <br> \
191"
192ALIASES += \
193 usbcfgm{5}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
194<b>Name:</b> [USB Device Instance]/\1 <br> \
195<b>Type:</b> \2 <br> \
196<b>Min:</b> \3 <br> \
197<b>Max:</b> \4 <br> \
198<b>Default:</b> \5 <br> \
199"
200ALIASES += \
201 usbcfgm{4}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
202<b>Name:</b> [USB Device Instance]/\1 <br> \
203<b>Type:</b> \2 <br> \
204<b>Min:</b> \3 <br> \
205<b>Max:</b> \4 <br> \
206"
207ALIASES += \
208 usbcfgm{3}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
209<b>Name:</b> [USB Device Instance]/\1 <br> \
210<b>Type:</b> \2 <br> \
211<b>Default:</b> \3 <br> \
212"
213ALIASES += \
214 usbcfgm{2}="\xrefitem lst_cfgm \"CFGM\" \"VM Configuration Values\" \
215<b>Name:</b> [USB Device Instance]/\1 <br> \
216<b>Type:</b> \2 <br> \
217"
218
219
220OPTIMIZE_OUTPUT_FOR_C = YES
221OPTIMIZE_OUTPUT_JAVA = NO
222BUILTIN_STL_SUPPORT = NO
223CPP_CLI_SUPPORT = NO
224SIP_SUPPORT = NO
225DISTRIBUTE_GROUP_DOC = NO
226SUBGROUPING = YES
227TYPEDEF_HIDES_STRUCT = NO
228
229#---------------------------------------------------------------------------
230# Build related configuration options
231#---------------------------------------------------------------------------
232EXTRACT_ALL = YES
233EXTRACT_PRIVATE = YES
234EXTRACT_STATIC = YES
235EXTRACT_LOCAL_CLASSES = YES
236EXTRACT_LOCAL_METHODS = NO
237EXTRACT_ANON_NSPACES = NO
238HIDE_UNDOC_MEMBERS = NO
239HIDE_UNDOC_CLASSES = NO
240HIDE_FRIEND_COMPOUNDS = NO
241HIDE_IN_BODY_DOCS = NO
242INTERNAL_DOCS = NO
243CASE_SENSE_NAMES = NO
244HIDE_SCOPE_NAMES = NO
245SHOW_INCLUDE_FILES = YES
246INLINE_INFO = YES
247SORT_MEMBER_DOCS = YES
248SORT_BRIEF_DOCS = NO
249SORT_BY_SCOPE_NAME = NO
250GENERATE_TODOLIST = YES
251GENERATE_TESTLIST = YES
252GENERATE_BUGLIST = YES
253GENERATE_DEPRECATEDLIST= YES
254ENABLED_SECTIONS =
255MAX_INITIALIZER_LINES = 30
256SHOW_USED_FILES = YES
257SHOW_DIRECTORIES = NO
258FILE_VERSION_FILTER =
259
260#---------------------------------------------------------------------------
261# configuration options related to warning and progress messages
262#---------------------------------------------------------------------------
263QUIET = YES
264WARNINGS = YES
265WARN_IF_UNDOCUMENTED = YES
266WARN_IF_DOC_ERROR = YES
267WARN_NO_PARAMDOC = NO
268WARN_FORMAT = "$file:$line: $text"
269#WARN_LOGFILE = later
270
271#---------------------------------------------------------------------------
272# configuration options related to the input files
273#---------------------------------------------------------------------------
274# INPUT = later
275INPUT_ENCODING = UTF-8
276FILE_PATTERNS =
277RECURSIVE = NO
278EXCLUDE =
279EXCLUDE_SYMLINKS = NO
280EXCLUDE_PATTERNS =
281EXCLUDE_SYMBOLS =
282EXAMPLE_PATH =
283EXAMPLE_PATTERNS =
284EXAMPLE_RECURSIVE = NO
285IMAGE_PATH = \
286 doc \
287 doc/tg/Networking-diagrams \
288 doc/tg/USB-diagrams \
289 doc/tg/iagrams
290INPUT_FILTER =
291FILTER_PATTERNS =
292FILTER_SOURCE_FILES = NO
293
294#---------------------------------------------------------------------------
295# configuration options related to source browsing
296#---------------------------------------------------------------------------
297SOURCE_BROWSER = NO
298INLINE_SOURCES = NO
299STRIP_CODE_COMMENTS = YES
300REFERENCED_BY_RELATION = YES
301REFERENCES_RELATION = YES
302REFERENCES_LINK_SOURCE = YES
303USE_HTAGS = NO
304VERBATIM_HEADERS = YES
305
306#---------------------------------------------------------------------------
307# configuration options related to the alphabetical class index
308#---------------------------------------------------------------------------
309ALPHABETICAL_INDEX = NO
310COLS_IN_ALPHA_INDEX = 5
311IGNORE_PREFIX =
312
313#---------------------------------------------------------------------------
314# configuration options related to the HTML output
315#---------------------------------------------------------------------------
316GENERATE_HTML = YES
317HTML_OUTPUT = html
318HTML_FILE_EXTENSION = .html
319HTML_HEADER =
320HTML_FOOTER =
321HTML_STYLESHEET =
322HTML_ALIGN_MEMBERS = YES
323GENERATE_HTMLHELP = NO
324HTML_DYNAMIC_SECTIONS = NO
325CHM_FILE =
326HHC_LOCATION =
327GENERATE_CHI = NO
328BINARY_TOC = NO
329TOC_EXPAND = NO
330DISABLE_INDEX = NO
331ENUM_VALUES_PER_LINE = 4
332GENERATE_TREEVIEW = NO
333TREEVIEW_WIDTH = 250
334
335#---------------------------------------------------------------------------
336# configuration options related to the LaTeX output
337#---------------------------------------------------------------------------
338GENERATE_LATEX = NO
339LATEX_OUTPUT = latex
340LATEX_CMD_NAME = latex
341MAKEINDEX_CMD_NAME = makeindex
342COMPACT_LATEX = NO
343PAPER_TYPE = a4wide
344EXTRA_PACKAGES =
345LATEX_HEADER =
346PDF_HYPERLINKS = NO
347USE_PDFLATEX = NO
348LATEX_BATCHMODE = NO
349LATEX_HIDE_INDICES = NO
350
351#---------------------------------------------------------------------------
352# configuration options related to the RTF output
353#---------------------------------------------------------------------------
354GENERATE_RTF = NO
355RTF_OUTPUT = rtf
356COMPACT_RTF = NO
357RTF_HYPERLINKS = NO
358RTF_STYLESHEET_FILE =
359RTF_EXTENSIONS_FILE =
360
361#---------------------------------------------------------------------------
362# configuration options related to the man page output
363#---------------------------------------------------------------------------
364GENERATE_MAN = NO
365MAN_OUTPUT = man
366MAN_EXTENSION = .3
367MAN_LINKS = NO
368
369#---------------------------------------------------------------------------
370# configuration options related to the XML output
371#---------------------------------------------------------------------------
372GENERATE_XML = NO
373XML_OUTPUT = xml
374XML_SCHEMA =
375XML_DTD =
376XML_PROGRAMLISTING = YES
377
378#---------------------------------------------------------------------------
379# configuration options for the AutoGen Definitions output
380#---------------------------------------------------------------------------
381GENERATE_AUTOGEN_DEF = NO
382
383#---------------------------------------------------------------------------
384# configuration options related to the Perl module output
385#---------------------------------------------------------------------------
386GENERATE_PERLMOD = NO
387PERLMOD_LATEX = NO
388PERLMOD_PRETTY = YES
389PERLMOD_MAKEVAR_PREFIX =
390
391#---------------------------------------------------------------------------
392# Configuration options related to the preprocessor
393#---------------------------------------------------------------------------
394ENABLE_PREPROCESSING = YES
395MACRO_EXPANSION = YES
396EXPAND_ONLY_PREDEF = YES
397SEARCH_INCLUDES = YES
398# INCLUDE_PATH = later
399# INCLUDE_FILE_PATTERNS = later
400PREDEFINED = DOXYGEN_RUNNING __DOXYGEN__ __END_DECLS __BEGIN_DECLS VBOX
401# Fix these:
402# PREDEFINED += DECLCALLBACK(a)=a
403# PREDEFINED += COMGETTER(a)=get##a
404# PREDEFINED += COMSETTER(a)=set##a
405EXPAND_AS_DEFINED = \
406 GCTYPE \
407 GCPTRTYPE \
408 HCPTRTYPE \
409 R3PTRTYPE \
410 R0PTRTYPE \
411 R3R0PTRTYPE \
412 \
413 ARCH_BITS \
414 R3_ARCH_BITS \
415 R0_ARCH_BITS \
416 GC_ARCH_BITS \
417 HC_ARCH_BITS \
418 \
419 DECLEXPORT \
420 DECLIMPORT \
421 DECLASM \
422 DECLASMTYPE \
423 DECLCALLBACK \
424 DECLCALLBACKMEMBER \
425 DECLHCCALLBACKMEMBER \
426 DECLGCCALLBACKMEMBER \
427 DECLR3CALLBACKMEMBER \
428 DECLR0CALLBACKMEMBER \
429 DECLINLINE \
430 CTXSUFF \
431 OTHERCTXSUFF \
432 CTXMID \
433 OTHERCTXMID \
434 \
435 COMSETTER \
436 COMGETTER \
437 INPTR \
438 STDMETHOD \
439 STDMETHODIMP \
440 \
441 CFGMDECL \
442 CFGMGCDECL \
443 CFGMR0DECL \
444 CFGMR3DECL \
445 CPUMDECL \
446 CPUMGCDECL \
447 CPUMR0DECL \
448 CPUMR3DECL \
449 CSAMDECL \
450 CSAMGCDECL \
451 CSAMR0DECL \
452 CSAMR3DECL \
453 DBGCR3DECL \
454 DBGDECL \
455 DBGFDECL \
456 DBGFGCDECL \
457 DBGFR0DECL \
458 DBGFR3DECL \
459 DBGGCDECL \
460 DBGR0DECL \
461 DISDECL \
462 EMDECL \
463 EMGCDECL \
464 EMR0DECL \
465 EMR3DECL \
466 GMMR0DECL \
467 GVMMR0DECL \
468 HWACCMDECL \
469 HWACCMGCDECL \
470 HWACCMR0DECL \
471 HWACCMR3DECL \
472 IDEDECL \
473 IDEGCDECL \
474 IDER0DECL \
475 IDER3DECL \
476 INTNETDECL \
477 INTNETGCDECL \
478 INTNETR0DECL \
479 INTNETR3DECL \
480 IOMDECL \
481 IOMGCDECL \
482 IOMR0DECL \
483 IOMR3DECL \
484 MMDECL \
485 MMGCDECL \
486 MMR0DECL \
487 MMR3DECL \
488 PATMDECL \
489 PATMGCDECL \
490 PATMR0DECL \
491 PATMR3DECL \
492 PDMBOTHCBDECL \
493 PDMDECL \
494 PDMGCDECL \
495 PDMR0DECL \
496 PDMR3DECL \
497 PGM_BTH_DECL \
498 PGM_GST_DECL \
499 PGM_SHW_DECL \
500 PGMDECL \
501 PGMGCDECL \
502 PGMR0DECL \
503 PGMR3DECL \
504 REMDECL \
505 REMGCDECL \
506 REMR0DECL \
507 REMR3DECL \
508 RTDECL \
509 RTGCDECL \
510 RTR0DECL \
511 RTR3DECL \
512 RTDATADECL \
513 SELMDECL \
514 SELMGCDECL \
515 SELMR0DECL \
516 SELMR3DECL \
517 SSMDECL \
518 SSMGCDECL \
519 SSMR3DECL \
520 SSMR0DECL \
521 STAMDECL \
522 STAMGCDECL \
523 STAMR0DECL \
524 STAMR3DECL \
525 SUPDECL \
526 SUPR0DECL \
527 SUPR3DECL \
528 TMDECL \
529 TMGCDECL \
530 TMR0DECL \
531 TMR3DECL \
532 TRPMDECL \
533 TRPMGCDECL \
534 TRPMR0DECL \
535 TRPMR3DECL \
536 USBR3DECL \
537 VBGLR3DECL \
538 VBOXDDU_DECL \
539 VGADECL \
540 VGAGCDECL \
541 VGAR0DECL \
542 VGAR3DECL \
543 VMDECL \
544 VMDECL \
545 VMGCDECL \
546 VMMDECL \
547 VMMGCDECL \
548 VMMR0DECL \
549 VMMR3DECL \
550 VMR0DECL \
551 VMR3DECL \
552
553SKIP_FUNCTION_MACROS = NO
554
555#---------------------------------------------------------------------------
556# Configuration::additions related to external references
557#---------------------------------------------------------------------------
558TAGFILES =
559GENERATE_TAGFILE =
560ALLEXTERNALS = NO
561EXTERNAL_GROUPS = YES
562PERL_PATH = /usr/bin/perl
563
564#---------------------------------------------------------------------------
565# Configuration options related to the dot tool
566#---------------------------------------------------------------------------
567CLASS_DIAGRAMS = YES
568MSCGEN_PATH =
569HIDE_UNDOC_RELATIONS = YES
570HAVE_DOT = NO
571CLASS_GRAPH = YES
572COLLABORATION_GRAPH = YES
573GROUP_GRAPHS = YES
574UML_LOOK = YES
575TEMPLATE_RELATIONS = YES
576INCLUDE_GRAPH = YES
577INCLUDED_BY_GRAPH = YES
578CALL_GRAPH = YES
579CALLER_GRAPH = YES
580GRAPHICAL_HIERARCHY = YES
581DIRECTORY_GRAPH = YES
582DOT_IMAGE_FORMAT = png
583DOT_PATH =
584DOTFILE_DIRS =
585DOT_GRAPH_MAX_NODES = 50
586MAX_DOT_GRAPH_DEPTH = 0
587DOT_TRANSPARENT = YES
588DOT_MULTI_TARGETS = NO
589GENERATE_LEGEND = YES
590DOT_CLEANUP = YES
591
592#---------------------------------------------------------------------------
593# Configuration::additions related to the search engine
594#---------------------------------------------------------------------------
595SEARCHENGINE = NO
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