VirtualBox

source: vbox/trunk/Doxyfile.Core@ 10159

Last change on this file since 10159 was 10039, checked in by vboxsync, 16 years ago

Make use of the networking overview diagram.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.2 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_gcfgm \"GCFGM\" \"Global 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_gcfgm \"GCFGM\" \"Global 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_gcfgm \"GCFGM\" \"Global 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_gcfgm \"GCFGM\" \"Global 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_gcfgm \"GCFGM\" \"Global Configuration Values\" \
104<b>Name:</b> \1 <br> \
105<b>Type:</b> \2 <br> \
106"
107
108OPTIMIZE_OUTPUT_FOR_C = YES
109OPTIMIZE_OUTPUT_JAVA = NO
110BUILTIN_STL_SUPPORT = NO
111CPP_CLI_SUPPORT = NO
112SIP_SUPPORT = NO
113DISTRIBUTE_GROUP_DOC = NO
114SUBGROUPING = YES
115TYPEDEF_HIDES_STRUCT = NO
116
117#---------------------------------------------------------------------------
118# Build related configuration options
119#---------------------------------------------------------------------------
120EXTRACT_ALL = YES
121EXTRACT_PRIVATE = YES
122EXTRACT_STATIC = YES
123EXTRACT_LOCAL_CLASSES = YES
124EXTRACT_LOCAL_METHODS = NO
125EXTRACT_ANON_NSPACES = NO
126HIDE_UNDOC_MEMBERS = NO
127HIDE_UNDOC_CLASSES = NO
128HIDE_FRIEND_COMPOUNDS = NO
129HIDE_IN_BODY_DOCS = NO
130INTERNAL_DOCS = NO
131CASE_SENSE_NAMES = NO
132HIDE_SCOPE_NAMES = NO
133SHOW_INCLUDE_FILES = YES
134INLINE_INFO = YES
135SORT_MEMBER_DOCS = YES
136SORT_BRIEF_DOCS = NO
137SORT_BY_SCOPE_NAME = NO
138GENERATE_TODOLIST = YES
139GENERATE_TESTLIST = YES
140GENERATE_BUGLIST = YES
141GENERATE_DEPRECATEDLIST= YES
142ENABLED_SECTIONS =
143MAX_INITIALIZER_LINES = 30
144SHOW_USED_FILES = YES
145SHOW_DIRECTORIES = NO
146FILE_VERSION_FILTER =
147
148#---------------------------------------------------------------------------
149# configuration options related to warning and progress messages
150#---------------------------------------------------------------------------
151QUIET = YES
152WARNINGS = YES
153WARN_IF_UNDOCUMENTED = YES
154WARN_IF_DOC_ERROR = YES
155WARN_NO_PARAMDOC = NO
156WARN_FORMAT = "$file:$line: $text"
157#WARN_LOGFILE = later
158
159#---------------------------------------------------------------------------
160# configuration options related to the input files
161#---------------------------------------------------------------------------
162# INPUT = later
163INPUT_ENCODING = UTF-8
164FILE_PATTERNS =
165RECURSIVE = NO
166EXCLUDE =
167EXCLUDE_SYMLINKS = NO
168EXCLUDE_PATTERNS =
169EXCLUDE_SYMBOLS =
170EXAMPLE_PATH =
171EXAMPLE_PATTERNS =
172EXAMPLE_RECURSIVE = NO
173IMAGE_PATH = \
174 doc \
175 doc/tg/Networking-diagrams \
176 doc/tg/USB-diagrams \
177 doc/tg/iagrams
178INPUT_FILTER =
179FILTER_PATTERNS =
180FILTER_SOURCE_FILES = NO
181
182#---------------------------------------------------------------------------
183# configuration options related to source browsing
184#---------------------------------------------------------------------------
185SOURCE_BROWSER = NO
186INLINE_SOURCES = NO
187STRIP_CODE_COMMENTS = YES
188REFERENCED_BY_RELATION = YES
189REFERENCES_RELATION = YES
190REFERENCES_LINK_SOURCE = YES
191USE_HTAGS = NO
192VERBATIM_HEADERS = YES
193
194#---------------------------------------------------------------------------
195# configuration options related to the alphabetical class index
196#---------------------------------------------------------------------------
197ALPHABETICAL_INDEX = NO
198COLS_IN_ALPHA_INDEX = 5
199IGNORE_PREFIX =
200
201#---------------------------------------------------------------------------
202# configuration options related to the HTML output
203#---------------------------------------------------------------------------
204GENERATE_HTML = YES
205HTML_OUTPUT = html
206HTML_FILE_EXTENSION = .html
207HTML_HEADER =
208HTML_FOOTER =
209HTML_STYLESHEET =
210HTML_ALIGN_MEMBERS = YES
211GENERATE_HTMLHELP = NO
212HTML_DYNAMIC_SECTIONS = NO
213CHM_FILE =
214HHC_LOCATION =
215GENERATE_CHI = NO
216BINARY_TOC = NO
217TOC_EXPAND = NO
218DISABLE_INDEX = NO
219ENUM_VALUES_PER_LINE = 4
220GENERATE_TREEVIEW = NO
221TREEVIEW_WIDTH = 250
222
223#---------------------------------------------------------------------------
224# configuration options related to the LaTeX output
225#---------------------------------------------------------------------------
226GENERATE_LATEX = NO
227LATEX_OUTPUT = latex
228LATEX_CMD_NAME = latex
229MAKEINDEX_CMD_NAME = makeindex
230COMPACT_LATEX = NO
231PAPER_TYPE = a4wide
232EXTRA_PACKAGES =
233LATEX_HEADER =
234PDF_HYPERLINKS = NO
235USE_PDFLATEX = NO
236LATEX_BATCHMODE = NO
237LATEX_HIDE_INDICES = NO
238
239#---------------------------------------------------------------------------
240# configuration options related to the RTF output
241#---------------------------------------------------------------------------
242GENERATE_RTF = NO
243RTF_OUTPUT = rtf
244COMPACT_RTF = NO
245RTF_HYPERLINKS = NO
246RTF_STYLESHEET_FILE =
247RTF_EXTENSIONS_FILE =
248
249#---------------------------------------------------------------------------
250# configuration options related to the man page output
251#---------------------------------------------------------------------------
252GENERATE_MAN = NO
253MAN_OUTPUT = man
254MAN_EXTENSION = .3
255MAN_LINKS = NO
256
257#---------------------------------------------------------------------------
258# configuration options related to the XML output
259#---------------------------------------------------------------------------
260GENERATE_XML = NO
261XML_OUTPUT = xml
262XML_SCHEMA =
263XML_DTD =
264XML_PROGRAMLISTING = YES
265
266#---------------------------------------------------------------------------
267# configuration options for the AutoGen Definitions output
268#---------------------------------------------------------------------------
269GENERATE_AUTOGEN_DEF = NO
270
271#---------------------------------------------------------------------------
272# configuration options related to the Perl module output
273#---------------------------------------------------------------------------
274GENERATE_PERLMOD = NO
275PERLMOD_LATEX = NO
276PERLMOD_PRETTY = YES
277PERLMOD_MAKEVAR_PREFIX =
278
279#---------------------------------------------------------------------------
280# Configuration options related to the preprocessor
281#---------------------------------------------------------------------------
282ENABLE_PREPROCESSING = YES
283MACRO_EXPANSION = YES
284EXPAND_ONLY_PREDEF = YES
285SEARCH_INCLUDES = YES
286# INCLUDE_PATH = later
287# INCLUDE_FILE_PATTERNS = later
288PREDEFINED = DOXYGEN_RUNNING __DOXYGEN__ __END_DECLS __BEGIN_DECLS VBOX
289# Fix these:
290# PREDEFINED += DECLCALLBACK(a)=a
291# PREDEFINED += COMGETTER(a)=get##a
292# PREDEFINED += COMSETTER(a)=set##a
293EXPAND_AS_DEFINED = \
294 GCTYPE \
295 GCPTRTYPE \
296 HCPTRTYPE \
297 R3PTRTYPE \
298 R0PTRTYPE \
299 R3R0PTRTYPE \
300 \
301 ARCH_BITS \
302 R3_ARCH_BITS \
303 R0_ARCH_BITS \
304 GC_ARCH_BITS \
305 HC_ARCH_BITS \
306 \
307 DECLEXPORT \
308 DECLIMPORT \
309 DECLASM \
310 DECLASMTYPE \
311 DECLCALLBACK \
312 DECLCALLBACKMEMBER \
313 DECLHCCALLBACKMEMBER \
314 DECLGCCALLBACKMEMBER \
315 DECLR3CALLBACKMEMBER \
316 DECLR0CALLBACKMEMBER \
317 DECLINLINE \
318 CTXSUFF \
319 OTHERCTXSUFF \
320 CTXMID \
321 OTHERCTXMID \
322 \
323 COMSETTER \
324 COMGETTER \
325 INPTR \
326 STDMETHOD \
327 STDMETHODIMP \
328 \
329 CFGMDECL \
330 CFGMGCDECL \
331 CFGMR0DECL \
332 CFGMR3DECL \
333 CPUMDECL \
334 CPUMGCDECL \
335 CPUMR0DECL \
336 CPUMR3DECL \
337 CSAMDECL \
338 CSAMGCDECL \
339 CSAMR0DECL \
340 CSAMR3DECL \
341 DBGCR3DECL \
342 DBGDECL \
343 DBGFDECL \
344 DBGFGCDECL \
345 DBGFR0DECL \
346 DBGFR3DECL \
347 DBGGCDECL \
348 DBGR0DECL \
349 DISDECL \
350 EMDECL \
351 EMGCDECL \
352 EMR0DECL \
353 EMR3DECL \
354 GMMR0DECL \
355 GVMMR0DECL \
356 HWACCMDECL \
357 HWACCMGCDECL \
358 HWACCMR0DECL \
359 HWACCMR3DECL \
360 IDEDECL \
361 IDEGCDECL \
362 IDER0DECL \
363 IDER3DECL \
364 INTNETDECL \
365 INTNETGCDECL \
366 INTNETR0DECL \
367 INTNETR3DECL \
368 IOMDECL \
369 IOMGCDECL \
370 IOMR0DECL \
371 IOMR3DECL \
372 MMDECL \
373 MMGCDECL \
374 MMR0DECL \
375 MMR3DECL \
376 PATMDECL \
377 PATMGCDECL \
378 PATMR0DECL \
379 PATMR3DECL \
380 PDMBOTHCBDECL \
381 PDMDECL \
382 PDMGCDECL \
383 PDMR0DECL \
384 PDMR3DECL \
385 PGM_BTH_DECL \
386 PGM_GST_DECL \
387 PGM_SHW_DECL \
388 PGMDECL \
389 PGMGCDECL \
390 PGMR0DECL \
391 PGMR3DECL \
392 REMDECL \
393 REMGCDECL \
394 REMR0DECL \
395 REMR3DECL \
396 RTDECL \
397 RTGCDECL \
398 RTR0DECL \
399 RTR3DECL \
400 RTDATADECL \
401 SELMDECL \
402 SELMGCDECL \
403 SELMR0DECL \
404 SELMR3DECL \
405 SSMDECL \
406 SSMGCDECL \
407 SSMR3DECL \
408 SSMR0DECL \
409 STAMDECL \
410 STAMGCDECL \
411 STAMR0DECL \
412 STAMR3DECL \
413 SUPDECL \
414 SUPR0DECL \
415 SUPR3DECL \
416 TMDECL \
417 TMGCDECL \
418 TMR0DECL \
419 TMR3DECL \
420 TRPMDECL \
421 TRPMGCDECL \
422 TRPMR0DECL \
423 TRPMR3DECL \
424 USBR3DECL \
425 VBGLR3DECL \
426 VBOXDDU_DECL \
427 VGADECL \
428 VGAGCDECL \
429 VGAR0DECL \
430 VGAR3DECL \
431 VMDECL \
432 VMDECL \
433 VMGCDECL \
434 VMMDECL \
435 VMMGCDECL \
436 VMMR0DECL \
437 VMMR3DECL \
438 VMR0DECL \
439 VMR3DECL \
440
441SKIP_FUNCTION_MACROS = NO
442
443#---------------------------------------------------------------------------
444# Configuration::additions related to external references
445#---------------------------------------------------------------------------
446TAGFILES =
447GENERATE_TAGFILE =
448ALLEXTERNALS = NO
449EXTERNAL_GROUPS = YES
450PERL_PATH = /usr/bin/perl
451
452#---------------------------------------------------------------------------
453# Configuration options related to the dot tool
454#---------------------------------------------------------------------------
455CLASS_DIAGRAMS = YES
456MSCGEN_PATH =
457HIDE_UNDOC_RELATIONS = YES
458HAVE_DOT = NO
459CLASS_GRAPH = YES
460COLLABORATION_GRAPH = YES
461GROUP_GRAPHS = YES
462UML_LOOK = YES
463TEMPLATE_RELATIONS = YES
464INCLUDE_GRAPH = YES
465INCLUDED_BY_GRAPH = YES
466CALL_GRAPH = YES
467CALLER_GRAPH = YES
468GRAPHICAL_HIERARCHY = YES
469DIRECTORY_GRAPH = YES
470DOT_IMAGE_FORMAT = png
471DOT_PATH =
472DOTFILE_DIRS =
473DOT_GRAPH_MAX_NODES = 50
474MAX_DOT_GRAPH_DEPTH = 0
475DOT_TRANSPARENT = YES
476DOT_MULTI_TARGETS = NO
477GENERATE_LEGEND = YES
478DOT_CLEANUP = YES
479
480#---------------------------------------------------------------------------
481# Configuration::additions related to the search engine
482#---------------------------------------------------------------------------
483SEARCHENGINE = 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