VirtualBox

source: vbox/trunk/src/VBox/Runtime/Doxyfile@ 10794

最後變更 在這個檔案從10794是 9298,由 vboxsync 提交於 16 年 前

doxy: be less verbose (with bird's permission)

  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 46.2 KB
 
1# Doxyfile 1.3.7
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = IPRT
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER =
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33#OUTPUT_DIRECTORY =
34
35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 2 levels of 10 sub-directories under the output directory of each output
37# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of source
39# files, where putting all generated files in the same directory would otherwise
40# cause performance problems for the file system.
41
42CREATE_SUBDIRS = NO
43
44# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are:
48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
49# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
50# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
51# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
52
53OUTPUT_LANGUAGE = English
54
55# This tag can be used to specify the encoding used in the generated output.
56# The encoding is not always determined by the language that is chosen,
57# but also whether or not the output is meant for Windows or non-Windows users.
58# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
59# forces the Windows encoding (this is the default for the Windows binary),
60# whereas setting the tag to NO uses a Unix-style encoding (the default for
61# all platforms other than Windows).
62
63# USE_WINDOWS_ENCODING = YES
64
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is used
83# as the annotated text. Otherwise, the brief description is used as-is. If left
84# blank, the following values are used ("$name" is automatically replaced with the
85# name of the entity): "The $name class" "The $name widget" "The $name file"
86# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
87
88ABBREVIATE_BRIEF =
89
90# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91# Doxygen will generate a detailed section even if there is only a brief
92# description.
93
94ALWAYS_DETAILED_SEC = NO
95
96# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
97# members of a class in the documentation of that class as if those members were
98# ordinary class members. Constructors, destructors and assignment operators of
99# the base classes will not be shown.
100
101INLINE_INHERITED_MEMB = NO
102
103# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104# path before files name in the file list and in the header files. If set
105# to NO the shortest path that makes the file name unique will be used.
106
107FULL_PATH_NAMES = NO
108
109# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110# can be used to strip a user-defined part of the path. Stripping is
111# only done if one of the specified strings matches the left-hand part of
112# the path. The tag can be used to show relative paths in the file list.
113# If left blank the directory from which doxygen is run is used as the
114# path to strip.
115
116STRIP_FROM_PATH =
117
118# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119# the path mentioned in the documentation of a class, which tells
120# the reader which header file to include in order to use a class.
121# If left blank only the name of the header file containing the class
122# definition is used. Otherwise one should specify the include paths that
123# are normally passed to the compiler using the -I flag.
124
125STRIP_FROM_INC_PATH =
126
127# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128# (but less readable) file names. This can be useful is your file systems
129# doesn't support long names like on DOS, Mac, or CD-ROM.
130
131SHORT_NAMES = NO
132
133# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134# will interpret the first line (until the first dot) of a JavaDoc-style
135# comment as the brief description. If set to NO, the JavaDoc
136# comments will behave just like the Qt-style comments (thus requiring an
137# explicit @brief command for a brief description.
138
139JAVADOC_AUTOBRIEF = YES
140
141# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
142# treat a multi-line C++ special comment block (i.e. a block of //! or ///
143# comments) as a brief description. This used to be the default behaviour.
144# The new default is to treat a multi-line C++ comment block as a detailed
145# description. Set this tag to YES if you prefer the old behaviour instead.
146
147MULTILINE_CPP_IS_BRIEF = NO
148
149# If the DETAILS_AT_TOP tag is set to YES then Doxygen
150# will output the detailed description near the top, like JavaDoc.
151# If set to NO, the detailed description appears after the member
152# documentation.
153
154DETAILS_AT_TOP = NO
155
156# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
157# member inherits the documentation from any documented member that it
158# re-implements.
159
160INHERIT_DOCS = YES
161
162# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
163# tag is set to YES, then doxygen will reuse the documentation of the first
164# member in the group (if any) for the other members of the group. By default
165# all members of a group must be documented explicitly.
166
167DISTRIBUTE_GROUP_DOC = NO
168
169# The TAB_SIZE tag can be used to set the number of spaces in a tab.
170# Doxygen uses this value to replace tabs by spaces in code fragments.
171
172TAB_SIZE = 4
173
174# This tag can be used to specify a number of aliases that acts
175# as commands in the documentation. An alias has the form "name=value".
176# For example adding "sideeffect=\par Side Effects:\n" will allow you to
177# put the command \sideeffect (or @sideeffect) in the documentation, which
178# will result in a user-defined paragraph with heading "Side Effects:".
179# You can put \n's in the value part of an alias to insert newlines.
180
181ALIASES = \
182 "note=@remark" \
183
184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
185# only. Doxygen will then generate output that is more tailored for C.
186# For instance, some of the names that are used will be different. The list
187# of all members will be omitted, etc.
188
189OPTIMIZE_OUTPUT_FOR_C = YES
190
191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
192# only. Doxygen will then generate output that is more tailored for Java.
193# For instance, namespaces will be presented as packages, qualified scopes
194# will look different, etc.
195
196OPTIMIZE_OUTPUT_JAVA = NO
197
198# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
199# the same type (for instance a group of public functions) to be put as a
200# subgroup of that type (e.g. under the Public Functions section). Set it to
201# NO to prevent subgrouping. Alternatively, this can be done per class using
202# the \nosubgrouping command.
203
204SUBGROUPING = YES
205
206#---------------------------------------------------------------------------
207# Build related configuration options
208#---------------------------------------------------------------------------
209
210# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
211# documentation are documented, even if no documentation was available.
212# Private class members and static file members will be hidden unless
213# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
214
215EXTRACT_ALL = YES
216
217# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
218# will be included in the documentation.
219
220EXTRACT_PRIVATE = YES
221
222# If the EXTRACT_STATIC tag is set to YES all static members of a file
223# will be included in the documentation.
224
225EXTRACT_STATIC = YES
226
227# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
228# defined locally in source files will be included in the documentation.
229# If set to NO only classes defined in header files are included.
230
231EXTRACT_LOCAL_CLASSES = YES
232
233# This flag is only useful for Objective-C code. When set to YES local
234# methods, which are defined in the implementation section but not in
235# the interface are included in the documentation.
236# If set to NO (the default) only methods in the interface are included.
237
238EXTRACT_LOCAL_METHODS = NO
239
240# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
241# undocumented members of documented classes, files or namespaces.
242# If set to NO (the default) these members will be included in the
243# various overviews, but no documentation section is generated.
244# This option has no effect if EXTRACT_ALL is enabled.
245
246HIDE_UNDOC_MEMBERS = NO
247
248# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
249# undocumented classes that are normally visible in the class hierarchy.
250# If set to NO (the default) these classes will be included in the various
251# overviews. This option has no effect if EXTRACT_ALL is enabled.
252
253HIDE_UNDOC_CLASSES = NO
254
255# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
256# friend (class|struct|union) declarations.
257# If set to NO (the default) these declarations will be included in the
258# documentation.
259
260HIDE_FRIEND_COMPOUNDS = NO
261
262# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
263# documentation blocks found inside the body of a function.
264# If set to NO (the default) these blocks will be appended to the
265# function's detailed documentation block.
266
267HIDE_IN_BODY_DOCS = NO
268
269# The INTERNAL_DOCS tag determines if documentation
270# that is typed after a \internal command is included. If the tag is set
271# to NO (the default) then the documentation will be excluded.
272# Set it to YES to include the internal documentation.
273
274INTERNAL_DOCS = YES
275
276# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
277# file names in lower-case letters. If set to YES upper-case letters are also
278# allowed. This is useful if you have classes or files whose names only differ
279# in case and if your file system supports case sensitive file names. Windows
280# users are advised to set this option to NO.
281
282CASE_SENSE_NAMES = NO
283
284# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
285# will show members with their full class and namespace scopes in the
286# documentation. If set to YES the scope will be hidden.
287
288HIDE_SCOPE_NAMES = NO
289
290# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
291# will put a list of the files that are included by a file in the documentation
292# of that file.
293
294SHOW_INCLUDE_FILES = YES
295
296# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
297# is inserted in the documentation for inline members.
298
299INLINE_INFO = YES
300
301# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
302# will sort the (detailed) documentation of file and class members
303# alphabetically by member name. If set to NO the members will appear in
304# declaration order.
305
306SORT_MEMBER_DOCS = YES
307
308# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
309# brief documentation of file, namespace and class members alphabetically
310# by member name. If set to NO (the default) the members will appear in
311# declaration order.
312
313SORT_BRIEF_DOCS = NO
314
315# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
316# sorted by fully-qualified names, including namespaces. If set to
317# NO (the default), the class list will be sorted only by class name,
318# not including the namespace part.
319# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
320# Note: This option applies only to the class list, not to the
321# alphabetical list.
322
323SORT_BY_SCOPE_NAME = NO
324
325# The GENERATE_TODOLIST tag can be used to enable (YES) or
326# disable (NO) the todo list. This list is created by putting \todo
327# commands in the documentation.
328
329GENERATE_TODOLIST = YES
330
331# The GENERATE_TESTLIST tag can be used to enable (YES) or
332# disable (NO) the test list. This list is created by putting \test
333# commands in the documentation.
334
335GENERATE_TESTLIST = YES
336
337# The GENERATE_BUGLIST tag can be used to enable (YES) or
338# disable (NO) the bug list. This list is created by putting \bug
339# commands in the documentation.
340
341GENERATE_BUGLIST = YES
342
343# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
344# disable (NO) the deprecated list. This list is created by putting
345# \deprecated commands in the documentation.
346
347GENERATE_DEPRECATEDLIST= YES
348
349# The ENABLED_SECTIONS tag can be used to enable conditional
350# documentation sections, marked by \if sectionname ... \endif.
351
352ENABLED_SECTIONS =
353
354# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
355# the initial value of a variable or define consists of for it to appear in
356# the documentation. If the initializer consists of more lines than specified
357# here it will be hidden. Use a value of 0 to hide initializers completely.
358# The appearance of the initializer of individual variables and defines in the
359# documentation can be controlled using \showinitializer or \hideinitializer
360# command in the documentation regardless of this setting.
361
362MAX_INITIALIZER_LINES = 30
363
364# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
365# at the bottom of the documentation of classes and structs. If set to YES the
366# list will mention the files that were used to generate the documentation.
367
368SHOW_USED_FILES = YES
369
370#---------------------------------------------------------------------------
371# configuration options related to warning and progress messages
372#---------------------------------------------------------------------------
373
374# The QUIET tag can be used to turn on/off the messages that are generated
375# by doxygen. Possible values are YES and NO. If left blank NO is used.
376
377QUIET = YES
378
379# The WARNINGS tag can be used to turn on/off the warning messages that are
380# generated by doxygen. Possible values are YES and NO. If left blank
381# NO is used.
382
383WARNINGS = YES
384
385# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
386# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
387# automatically be disabled.
388
389WARN_IF_UNDOCUMENTED = YES
390
391# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
392# potential errors in the documentation, such as not documenting some
393# parameters in a documented function, or documenting parameters that
394# don't exist or using markup commands wrongly.
395
396WARN_IF_DOC_ERROR = YES
397
398# The WARN_FORMAT tag determines the format of the warning messages that
399# doxygen can produce. The string should contain the $file, $line, and $text
400# tags, which will be replaced by the file and line number from which the
401# warning originated and the warning text.
402
403WARN_FORMAT = "$file:$line: $text"
404
405# The WARN_LOGFILE tag can be used to specify a file to which warning
406# and error messages should be written. If left blank the output is written
407# to stderr.
408
409#WARN_LOGFILE =
410
411#---------------------------------------------------------------------------
412# configuration options related to the input files
413#---------------------------------------------------------------------------
414
415# The INPUT tag can be used to specify the files and/or directories that contain
416# documented source files. You may enter file names like "myfile.cpp" or
417# directories like "/usr/src/myproject". Separate the files or directories
418# with spaces.
419
420#INPUT =
421
422
423
424# If the value of the INPUT tag contains directories, you can use the
425# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
426# and *.h) to filter out the source-files in the directories. If left
427# blank the following patterns are tested:
428# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
429# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
430
431#FILE_PATTERNS =
432
433
434
435# The RECURSIVE tag can be used to turn specify whether or not subdirectories
436# should be searched for input files as well. Possible values are YES and NO.
437# If left blank NO is used.
438
439RECURSIVE = NO
440
441# The EXCLUDE tag can be used to specify files and/or directories that should
442# excluded from the INPUT source files. This way you can easily exclude a
443# subdirectory from a directory tree whose root is specified with the INPUT tag.
444
445EXCLUDE =
446
447# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
448# that are symbolic links (a Unix filesystem feature) are excluded from the input.
449
450EXCLUDE_SYMLINKS = NO
451
452# If the value of the INPUT tag contains directories, you can use the
453# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
454# certain files from those directories.
455
456EXCLUDE_PATTERNS =
457
458# The EXAMPLE_PATH tag can be used to specify one or more files or
459# directories that contain example code fragments that are included (see
460# the \include command).
461
462EXAMPLE_PATH =
463
464# If the value of the EXAMPLE_PATH tag contains directories, you can use the
465# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
466# and *.h) to filter out the source-files in the directories. If left
467# blank all files are included.
468
469EXAMPLE_PATTERNS =
470
471# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
472# searched for input files to be used with the \include or \dontinclude
473# commands irrespective of the value of the RECURSIVE tag.
474# Possible values are YES and NO. If left blank NO is used.
475
476EXAMPLE_RECURSIVE = NO
477
478# The IMAGE_PATH tag can be used to specify one or more files or
479# directories that contain image that are included in the documentation (see
480# the \image command).
481
482IMAGE_PATH =
483
484# The INPUT_FILTER tag can be used to specify a program that doxygen should
485# invoke to filter for each input file. Doxygen will invoke the filter program
486# by executing (via popen()) the command <filter> <input-file>, where <filter>
487# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
488# input file. Doxygen will then use the output that the filter program writes
489# to standard output.
490
491INPUT_FILTER =
492
493# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
494# INPUT_FILTER) will be used to filter the input files when producing source
495# files to browse (i.e. when SOURCE_BROWSER is set to YES).
496
497FILTER_SOURCE_FILES = NO
498
499#---------------------------------------------------------------------------
500# configuration options related to source browsing
501#---------------------------------------------------------------------------
502
503# If the SOURCE_BROWSER tag is set to YES then a list of source files will
504# be generated. Documented entities will be cross-referenced with these sources.
505# Note: To get rid of all source code in the generated output, make sure also
506# VERBATIM_HEADERS is set to NO.
507
508SOURCE_BROWSER = NO
509
510# Setting the INLINE_SOURCES tag to YES will include the body
511# of functions and classes directly in the documentation.
512
513INLINE_SOURCES = NO
514
515# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
516# doxygen to hide any special comment blocks from generated source code
517# fragments. Normal C and C++ comments will always remain visible.
518
519STRIP_CODE_COMMENTS = NO
520
521# If the REFERENCED_BY_RELATION tag is set to YES (the default)
522# then for each documented function all documented
523# functions referencing it will be listed.
524
525REFERENCED_BY_RELATION = YES
526
527# If the REFERENCES_RELATION tag is set to YES (the default)
528# then for each documented function all documented entities
529# called/used by that function will be listed.
530
531REFERENCES_RELATION = YES
532
533# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
534# will generate a verbatim copy of the header file for each class for
535# which an include is specified. Set to NO to disable this.
536
537VERBATIM_HEADERS = YES
538
539#---------------------------------------------------------------------------
540# configuration options related to the alphabetical class index
541#---------------------------------------------------------------------------
542
543# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
544# of all compounds will be generated. Enable this if the project
545# contains a lot of classes, structs, unions or interfaces.
546
547ALPHABETICAL_INDEX = NO
548
549# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
550# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
551# in which this list will be split (can be a number in the range [1..20])
552
553COLS_IN_ALPHA_INDEX = 5
554
555# In case all classes in a project start with a common prefix, all
556# classes will be put under the same header in the alphabetical index.
557# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
558# should be ignored while generating the index headers.
559
560IGNORE_PREFIX =
561
562#---------------------------------------------------------------------------
563# configuration options related to the HTML output
564#---------------------------------------------------------------------------
565
566# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
567# generate HTML output.
568
569GENERATE_HTML = YES
570
571# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
572# If a relative path is entered the value of OUTPUT_DIRECTORY will be
573# put in front of it. If left blank `html' will be used as the default path.
574
575HTML_OUTPUT = html
576
577# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
578# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
579# doxygen will generate files with .html extension.
580
581HTML_FILE_EXTENSION = .html
582
583# The HTML_HEADER tag can be used to specify a personal HTML header for
584# each generated HTML page. If it is left blank doxygen will generate a
585# standard header.
586
587HTML_HEADER =
588
589# The HTML_FOOTER tag can be used to specify a personal HTML footer for
590# each generated HTML page. If it is left blank doxygen will generate a
591# standard footer.
592
593HTML_FOOTER =
594
595# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
596# style sheet that is used by each HTML page. It can be used to
597# fine-tune the look of the HTML output. If the tag is left blank doxygen
598# will generate a default style sheet. Note that doxygen will try to copy
599# the style sheet file to the HTML output directory, so don't put your own
600# stylesheet in the HTML output directory as well, or it will be erased!
601
602HTML_STYLESHEET =
603
604# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
605# files or namespaces will be aligned in HTML using tables. If set to
606# NO a bullet list will be used.
607
608HTML_ALIGN_MEMBERS = YES
609
610# If the GENERATE_HTMLHELP tag is set to YES, additional index files
611# will be generated that can be used as input for tools like the
612# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
613# of the generated HTML documentation.
614
615GENERATE_HTMLHELP = NO
616
617# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
618# be used to specify the file name of the resulting .chm file. You
619# can add a path in front of the file if the result should not be
620# written to the html output directory.
621
622CHM_FILE =
623
624# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
625# be used to specify the location (absolute path including file name) of
626# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
627# the HTML help compiler on the generated index.hhp.
628
629HHC_LOCATION =
630
631# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
632# controls if a separate .chi index file is generated (YES) or that
633# it should be included in the master .chm file (NO).
634
635GENERATE_CHI = NO
636
637# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
638# controls whether a binary table of contents is generated (YES) or a
639# normal table of contents (NO) in the .chm file.
640
641BINARY_TOC = NO
642
643# The TOC_EXPAND flag can be set to YES to add extra items for group members
644# to the contents of the HTML help documentation and to the tree view.
645
646TOC_EXPAND = NO
647
648# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
649# top of each HTML page. The value NO (the default) enables the index and
650# the value YES disables it.
651
652DISABLE_INDEX = YES
653
654# This tag can be used to set the number of enum values (range [1..20])
655# that doxygen will group on one line in the generated HTML documentation.
656
657ENUM_VALUES_PER_LINE = 4
658
659# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
660# generated containing a tree-like index structure (just like the one that
661# is generated for HTML Help). For this to work a browser that supports
662# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
663# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
664# probably better off using the HTML help feature.
665
666GENERATE_TREEVIEW = YES
667
668# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
669# used to set the initial width (in pixels) of the frame in which the tree
670# is shown.
671
672TREEVIEW_WIDTH = 250
673
674#---------------------------------------------------------------------------
675# configuration options related to the LaTeX output
676#---------------------------------------------------------------------------
677
678# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
679# generate Latex output.
680
681GENERATE_LATEX = NO
682
683# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
684# If a relative path is entered the value of OUTPUT_DIRECTORY will be
685# put in front of it. If left blank `latex' will be used as the default path.
686
687LATEX_OUTPUT = latex
688
689# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
690# invoked. If left blank `latex' will be used as the default command name.
691
692LATEX_CMD_NAME = latex
693
694# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
695# generate index for LaTeX. If left blank `makeindex' will be used as the
696# default command name.
697
698MAKEINDEX_CMD_NAME = makeindex
699
700# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
701# LaTeX documents. This may be useful for small projects and may help to
702# save some trees in general.
703
704COMPACT_LATEX = NO
705
706# The PAPER_TYPE tag can be used to set the paper type that is used
707# by the printer. Possible values are: a4, a4wide, letter, legal and
708# executive. If left blank a4wide will be used.
709
710PAPER_TYPE = a4wide
711
712# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
713# packages that should be included in the LaTeX output.
714
715EXTRA_PACKAGES =
716
717# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
718# the generated latex document. The header should contain everything until
719# the first chapter. If it is left blank doxygen will generate a
720# standard header. Notice: only use this tag if you know what you are doing!
721
722LATEX_HEADER =
723
724# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
725# is prepared for conversion to pdf (using ps2pdf). The pdf file will
726# contain links (just like the HTML output) instead of page references
727# This makes the output suitable for online browsing using a pdf viewer.
728
729PDF_HYPERLINKS = NO
730
731# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
732# plain latex in the generated Makefile. Set this option to YES to get a
733# higher quality PDF documentation.
734
735USE_PDFLATEX = NO
736
737# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
738# command to the generated LaTeX files. This will instruct LaTeX to keep
739# running if errors occur, instead of asking the user for help.
740# This option is also used when generating formulas in HTML.
741
742LATEX_BATCHMODE = NO
743
744# If LATEX_HIDE_INDICES is set to YES then doxygen will not
745# include the index chapters (such as File Index, Compound Index, etc.)
746# in the output.
747
748LATEX_HIDE_INDICES = NO
749
750#---------------------------------------------------------------------------
751# configuration options related to the RTF output
752#---------------------------------------------------------------------------
753
754# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
755# The RTF output is optimized for Word 97 and may not look very pretty with
756# other RTF readers or editors.
757
758GENERATE_RTF = NO
759
760# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
761# If a relative path is entered the value of OUTPUT_DIRECTORY will be
762# put in front of it. If left blank `rtf' will be used as the default path.
763
764RTF_OUTPUT = rtf
765
766# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
767# RTF documents. This may be useful for small projects and may help to
768# save some trees in general.
769
770COMPACT_RTF = NO
771
772# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
773# will contain hyperlink fields. The RTF file will
774# contain links (just like the HTML output) instead of page references.
775# This makes the output suitable for online browsing using WORD or other
776# programs which support those fields.
777# Note: wordpad (write) and others do not support links.
778
779RTF_HYPERLINKS = NO
780
781# Load stylesheet definitions from file. Syntax is similar to doxygen's
782# config file, i.e. a series of assignments. You only have to provide
783# replacements, missing definitions are set to their default value.
784
785RTF_STYLESHEET_FILE =
786
787# Set optional variables used in the generation of an rtf document.
788# Syntax is similar to doxygen's config file.
789
790RTF_EXTENSIONS_FILE =
791
792#---------------------------------------------------------------------------
793# configuration options related to the man page output
794#---------------------------------------------------------------------------
795
796# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
797# generate man pages
798
799GENERATE_MAN = NO
800
801# The MAN_OUTPUT tag is used to specify where the man pages will be put.
802# If a relative path is entered the value of OUTPUT_DIRECTORY will be
803# put in front of it. If left blank `man' will be used as the default path.
804
805MAN_OUTPUT = man
806
807# The MAN_EXTENSION tag determines the extension that is added to
808# the generated man pages (default is the subroutine's section .3)
809
810MAN_EXTENSION = .3
811
812# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
813# then it will generate one additional man file for each entity
814# documented in the real man page(s). These additional files
815# only source the real man page, but without them the man command
816# would be unable to find the correct page. The default is NO.
817
818MAN_LINKS = NO
819
820#---------------------------------------------------------------------------
821# configuration options related to the XML output
822#---------------------------------------------------------------------------
823
824# If the GENERATE_XML tag is set to YES Doxygen will
825# generate an XML file that captures the structure of
826# the code including all documentation.
827
828GENERATE_XML = NO
829
830# The XML_OUTPUT tag is used to specify where the XML pages will be put.
831# If a relative path is entered the value of OUTPUT_DIRECTORY will be
832# put in front of it. If left blank `xml' will be used as the default path.
833
834XML_OUTPUT = xml
835
836# The XML_SCHEMA tag can be used to specify an XML schema,
837# which can be used by a validating XML parser to check the
838# syntax of the XML files.
839
840XML_SCHEMA =
841
842# The XML_DTD tag can be used to specify an XML DTD,
843# which can be used by a validating XML parser to check the
844# syntax of the XML files.
845
846XML_DTD =
847
848# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
849# dump the program listings (including syntax highlighting
850# and cross-referencing information) to the XML output. Note that
851# enabling this will significantly increase the size of the XML output.
852
853XML_PROGRAMLISTING = YES
854
855#---------------------------------------------------------------------------
856# configuration options for the AutoGen Definitions output
857#---------------------------------------------------------------------------
858
859# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
860# generate an AutoGen Definitions (see autogen.sf.net) file
861# that captures the structure of the code including all
862# documentation. Note that this feature is still experimental
863# and incomplete at the moment.
864
865GENERATE_AUTOGEN_DEF = NO
866
867#---------------------------------------------------------------------------
868# configuration options related to the Perl module output
869#---------------------------------------------------------------------------
870
871# If the GENERATE_PERLMOD tag is set to YES Doxygen will
872# generate a Perl module file that captures the structure of
873# the code including all documentation. Note that this
874# feature is still experimental and incomplete at the
875# moment.
876
877GENERATE_PERLMOD = NO
878
879# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
880# the necessary Makefile rules, Perl scripts and LaTeX code to be able
881# to generate PDF and DVI output from the Perl module output.
882
883PERLMOD_LATEX = NO
884
885# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
886# nicely formatted so it can be parsed by a human reader. This is useful
887# if you want to understand what is going on. On the other hand, if this
888# tag is set to NO the size of the Perl module output will be much smaller
889# and Perl will parse it just the same.
890
891PERLMOD_PRETTY = YES
892
893# The names of the make variables in the generated doxyrules.make file
894# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
895# This is useful so different doxyrules.make files included by the same
896# Makefile don't overwrite each other's variables.
897
898PERLMOD_MAKEVAR_PREFIX =
899
900#---------------------------------------------------------------------------
901# Configuration options related to the preprocessor
902#---------------------------------------------------------------------------
903
904# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
905# evaluate all C-preprocessor directives found in the sources and include
906# files.
907
908ENABLE_PREPROCESSING = YES
909
910# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
911# names in the source code. If set to NO (the default) only conditional
912# compilation will be performed. Macro expansion can be done in a controlled
913# way by setting EXPAND_ONLY_PREDEF to YES.
914
915MACRO_EXPANSION = YES
916
917# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
918# then the macro expansion is limited to the macros specified with the
919# PREDEFINED and EXPAND_AS_PREDEFINED tags.
920
921EXPAND_ONLY_PREDEF = YES
922
923# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
924# in the INCLUDE_PATH (see below) will be search if a #include is found.
925
926SEARCH_INCLUDES = YES
927
928# The INCLUDE_PATH tag can be used to specify one or more directories that
929# contain include files that are not input files but should be processed by
930# the preprocessor.
931
932#INCLUDE_PATH =
933
934# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
935# patterns (like *.h and *.hpp) to filter out the header-files in the
936# directories. If left blank, the patterns specified with FILE_PATTERNS will
937# be used.
938
939#INCLUDE_FILE_PATTERNS =
940
941# The PREDEFINED tag can be used to specify one or more macro names that
942# are defined before the preprocessor is started (similar to the -D option of
943# gcc). The argument of the tag is a list of macros of the form: name
944# or name=definition (no spaces). If the definition and the = are
945# omitted =1 is assumed.
946
947PREDEFINED = DOXYGEN_RUNNING __DOXYGEN__ \
948 __END_DECLS= \
949 __BEGIN_DECLS= \
950 VBOX=1 \
951 RT_STRICT=1 \
952 __cplusplus=1 \
953 RTCALL= \
954 ARCH_BITS=HC_ARCH_BITS \
955 R3_ARCH_BITS=HC_ARCH_BITS \
956 R0_ARCH_BITS=HC_ARCH_BITS \
957 RTDECL(type)=type \
958
959# DECLCALLBACK(type)=type
960
961# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
962# this tag can be used to specify a list of macro names that should be expanded.
963# The macro definition that is found in the sources will be used.
964# Use the PREDEFINED tag if you want to use a different macro definition.
965
966EXPAND_AS_DEFINED = \
967 ARCH_BITS \
968 GC_ARCH_BITS \
969 HC_ARCH_BITS \
970 R3_ARCH_BITS \
971 R0_ARCH_BITS \
972 \
973 GCTYPE \
974 GCPTRTYPE \
975 HCPTRTYPE \
976 R0PTRTYPE \
977 R3PTRTYPE \
978 R3R0PTRTYPE \
979 \
980 DECLEXPORT \
981 DECLIMPORT \
982 DECLASM \
983 DECLASMTYPE \
984 DECLCALLBACK \
985 DECLCALLBACKMEMBER \
986 DECLHCCALLBACKMEMBER \
987 DECLGCCALLBACKMEMBER \
988 DECLR3CALLBACKMEMBER \
989 DECLR0CALLBACKMEMBER \
990 DECLINLINE \
991 RTR3DECL \
992 RTR0DECL \
993 RTGCDECL \
994 RTDECL \
995 RTDATADECL \
996 KAVL_FN \
997 \
998 CTXSUFF \
999 OTHERCTXSUFF \
1000 CTXMID \
1001 OTHERCTXMID \
1002
1003
1004# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1005# doxygen's preprocessor will remove all function-like macros that are alone
1006# on a line, have an all uppercase name, and do not end with a semicolon. Such
1007# function macros are typically used for boiler-plate code, and will confuse the
1008# parser if not removed.
1009
1010#SKIP_FUNCTION_MACROS = YES
1011
1012#---------------------------------------------------------------------------
1013# Configuration::additions related to external references
1014#---------------------------------------------------------------------------
1015
1016# The TAGFILES option can be used to specify one or more tagfiles.
1017# Optionally an initial location of the external documentation
1018# can be added for each tagfile. The format of a tag file without
1019# this location is as follows:
1020# TAGFILES = file1 file2 ...
1021# Adding location for the tag files is done as follows:
1022# TAGFILES = file1=loc1 "file2 = loc2" ...
1023# where "loc1" and "loc2" can be relative or absolute paths or
1024# URLs. If a location is present for each tag, the installdox tool
1025# does not have to be run to correct the links.
1026# Note that each tag file must have a unique name
1027# (where the name does NOT include the path)
1028# If a tag file is not located in the directory in which doxygen
1029# is run, you must also specify the path to the tagfile here.
1030
1031TAGFILES =
1032
1033# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1034# a tag file that is based on the input files it reads.
1035
1036GENERATE_TAGFILE =
1037
1038# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1039# in the class index. If set to NO only the inherited external classes
1040# will be listed.
1041
1042ALLEXTERNALS = NO
1043
1044# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1045# in the modules index. If set to NO, only the current project's groups will
1046# be listed.
1047
1048EXTERNAL_GROUPS = YES
1049
1050# The PERL_PATH should be the absolute path and name of the perl script
1051# interpreter (i.e. the result of `which perl').
1052
1053PERL_PATH = /usr/bin/perl
1054
1055#---------------------------------------------------------------------------
1056# Configuration options related to the dot tool
1057#---------------------------------------------------------------------------
1058
1059# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1060# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1061# super classes. Setting the tag to NO turns the diagrams off. Note that this
1062# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1063# recommended to install and use dot, since it yields more powerful graphs.
1064
1065CLASS_DIAGRAMS = YES
1066
1067# If set to YES, the inheritance and collaboration graphs will hide
1068# inheritance and usage relations if the target is undocumented
1069# or is not a class.
1070
1071HIDE_UNDOC_RELATIONS = YES
1072
1073# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1074# available from the path. This tool is part of Graphviz, a graph visualization
1075# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1076# have no effect if this option is set to NO (the default)
1077
1078HAVE_DOT = NO
1079
1080# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1081# will generate a graph for each documented class showing the direct and
1082# indirect inheritance relations. Setting this tag to YES will force the
1083# the CLASS_DIAGRAMS tag to NO.
1084
1085CLASS_GRAPH = YES
1086
1087# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1088# will generate a graph for each documented class showing the direct and
1089# indirect implementation dependencies (inheritance, containment, and
1090# class references variables) of the class with other documented classes.
1091
1092COLLABORATION_GRAPH = YES
1093
1094# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1095# collaboration diagrams in a style similar to the OMG's Unified Modeling
1096# Language.
1097
1098UML_LOOK = YES
1099
1100# If set to YES, the inheritance and collaboration graphs will show the
1101# relations between templates and their instances.
1102
1103TEMPLATE_RELATIONS = YES
1104
1105# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1106# tags are set to YES then doxygen will generate a graph for each documented
1107# file showing the direct and indirect include dependencies of the file with
1108# other documented files.
1109
1110INCLUDE_GRAPH = YES
1111
1112# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1113# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1114# documented header file showing the documented files that directly or
1115# indirectly include this file.
1116
1117INCLUDED_BY_GRAPH = YES
1118
1119# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1120# generate a call dependency graph for every global function or class method.
1121# Note that enabling this option will significantly increase the time of a run.
1122# So in most cases it will be better to enable call graphs for selected
1123# functions only using the \callgraph command.
1124
1125CALL_GRAPH = YES
1126
1127# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1128# will graphical hierarchy of all classes instead of a textual one.
1129
1130GRAPHICAL_HIERARCHY = YES
1131
1132# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1133# generated by dot. Possible values are png, jpg, or gif
1134# If left blank png will be used.
1135
1136DOT_IMAGE_FORMAT = png
1137
1138# The tag DOT_PATH can be used to specify the path where the dot tool can be
1139# found. If left blank, it is assumed the dot tool can be found on the path.
1140
1141DOT_PATH =
1142
1143# The DOTFILE_DIRS tag can be used to specify one or more directories that
1144# contain dot files that are included in the documentation (see the
1145# \dotfile command).
1146
1147DOTFILE_DIRS =
1148
1149# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1150# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1151# this value, doxygen will try to truncate the graph, so that it fits within
1152# the specified constraint. Beware that most browsers cannot cope with very
1153# large images.
1154
1155MAX_DOT_GRAPH_WIDTH = 1024
1156
1157# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1158# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1159# this value, doxygen will try to truncate the graph, so that it fits within
1160# the specified constraint. Beware that most browsers cannot cope with very
1161# large images.
1162
1163MAX_DOT_GRAPH_HEIGHT = 1024
1164
1165# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1166# graphs generated by dot. A depth value of 3 means that only nodes reachable
1167# from the root by following a path via at most 3 edges will be shown. Nodes that
1168# lay further from the root node will be omitted. Note that setting this option to
1169# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1170# note that a graph may be further truncated if the graph's image dimensions are
1171# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1172# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1173
1174MAX_DOT_GRAPH_DEPTH = 0
1175
1176# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1177# generate a legend page explaining the meaning of the various boxes and
1178# arrows in the dot generated graphs.
1179
1180GENERATE_LEGEND = YES
1181
1182# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1183# remove the intermediate dot files that are used to generate
1184# the various graphs.
1185
1186DOT_CLEANUP = YES
1187
1188#---------------------------------------------------------------------------
1189# Configuration::additions related to the search engine
1190#---------------------------------------------------------------------------
1191
1192# The SEARCHENGINE tag specifies whether or not a search engine should be
1193# used. If set to NO the values of all tags below this one will be ignored.
1194
1195SEARCHENGINE = NO
1196
1197#
1198# The next bit is generated by the Makefile.
1199#
1200
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette