VirtualBox

source: vbox/trunk/Doxyfile.Core@ 8245

Last change on this file since 8245 was 7171, checked in by vboxsync, 17 years ago

DOXYGEN_RUNNING.

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