VirtualBox

source: vbox/trunk/src/VBox/Main/Doxyfile.Main@ 46654

最後變更 在這個檔案從46654是 33540,由 vboxsync 提交於 14 年 前

*: spelling fixes, thanks Timeless!

  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 58.1 KB
 
1# Doxyfile 1.5.6
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# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
28PROJECT_NAME = "VirtualBox Main API"
29
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
34PROJECT_NUMBER =
35
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
39# where doxygen was started. If left blank the current directory will be used.
40
41OUTPUT_DIRECTORY = $(DOCDIR)
42
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS = NO
51
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61# and Ukrainian.
62
63OUTPUT_LANGUAGE = English
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
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
89ABBREVIATE_BRIEF = "The $name class" \
90 "The $name interface" \
91 "is" \
92 "provides" \
93 "represents" \
94 "a" \
95 "an" \
96 "the"
97
98# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
99# Doxygen will generate a detailed section even if there is only a brief
100# description.
101
102ALWAYS_DETAILED_SEC = NO
103
104# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
105# inherited members of a class in the documentation of that class as if those
106# members were ordinary class members. Constructors, destructors and assignment
107# operators of the base classes will not be shown.
108
109INLINE_INHERITED_MEMB = NO
110
111# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
112# path before files name in the file list and in the header files. If set
113# to NO the shortest path that makes the file name unique will be used.
114
115FULL_PATH_NAMES = NO
116
117# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
118# can be used to strip a user-defined part of the path. Stripping is
119# only done if one of the specified strings matches the left-hand part of
120# the path. The tag can be used to show relative paths in the file list.
121# If left blank the directory from which doxygen is run is used as the
122# path to strip.
123
124STRIP_FROM_PATH =
125
126# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
127# the path mentioned in the documentation of a class, which tells
128# the reader which header file to include in order to use a class.
129# If left blank only the name of the header file containing the class
130# definition is used. Otherwise one should specify the include paths that
131# are normally passed to the compiler using the -I flag.
132
133STRIP_FROM_INC_PATH =
134
135# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
136# (but less readable) file names. This can be useful is your file systems
137# doesn't support long names like on DOS, Mac, or CD-ROM.
138
139SHORT_NAMES = NO
140
141# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
142# will interpret the first line (until the first dot) of a JavaDoc-style
143# comment as the brief description. If set to NO, the JavaDoc
144# comments will behave just like regular Qt-style comments
145# (thus requiring an explicit @brief command for a brief description.)
146
147JAVADOC_AUTOBRIEF = YES
148
149# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
150# interpret the first line (until the first dot) of a Qt-style
151# comment as the brief description. If set to NO, the comments
152# will behave just like regular Qt-style comments (thus requiring
153# an explicit \brief command for a brief description.)
154
155QT_AUTOBRIEF = NO
156
157# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
158# treat a multi-line C++ special comment block (i.e. a block of //! or ///
159# comments) as a brief description. This used to be the default behaviour.
160# The new default is to treat a multi-line C++ comment block as a detailed
161# description. Set this tag to YES if you prefer the old behaviour instead.
162
163MULTILINE_CPP_IS_BRIEF = NO
164
165# If the DETAILS_AT_TOP tag is set to YES then Doxygen
166# will output the detailed description near the top, like JavaDoc.
167# If set to NO, the detailed description appears after the member
168# documentation.
169
170DETAILS_AT_TOP = NO
171
172# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173# member inherits the documentation from any documented member that it
174# re-implements.
175
176INHERIT_DOCS = YES
177
178# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179# a new page for each member. If set to NO, the documentation of a member will
180# be part of the file/class/namespace that contains it.
181
182SEPARATE_MEMBER_PAGES = NO
183
184# The TAB_SIZE tag can be used to set the number of spaces in a tab.
185# Doxygen uses this value to replace tabs by spaces in code fragments.
186
187TAB_SIZE = 4
188
189# This tag can be used to specify a number of aliases that acts
190# as commands in the documentation. An alias has the form "name=value".
191# For example adding "sideeffect=\par Side Effects:\n" will allow you to
192# put the command \sideeffect (or @sideeffect) in the documentation, which
193# will result in a user-defined paragraph with heading "Side Effects:".
194# You can put \n's in the value part of an alias to insert newlines.
195
196ALIASES =
197
198# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
199# sources only. Doxygen will then generate output that is more tailored for C.
200# For instance, some of the names that are used will be different. The list
201# of all members will be omitted, etc.
202
203OPTIMIZE_OUTPUT_FOR_C = NO
204
205# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
206# sources only. Doxygen will then generate output that is more tailored for
207# Java. For instance, namespaces will be presented as packages, qualified
208# scopes will look different, etc.
209
210OPTIMIZE_OUTPUT_JAVA = NO
211
212# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
213# sources only. Doxygen will then generate output that is more tailored for
214# Fortran.
215
216OPTIMIZE_FOR_FORTRAN = NO
217
218# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
219# sources. Doxygen will then generate output that is tailored for
220# VHDL.
221
222OPTIMIZE_OUTPUT_VHDL = NO
223
224# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
225# to include (a tag file for) the STL sources as input, then you should
226# set this tag to YES in order to let doxygen match functions declarations and
227# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
228# func(std::string) {}). This also make the inheritance and collaboration
229# diagrams that involve STL classes more complete and accurate.
230
231BUILTIN_STL_SUPPORT = NO
232
233# If you use Microsoft's C++/CLI language, you should set this option to YES to
234# enable parsing support.
235
236CPP_CLI_SUPPORT = NO
237
238# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
239# Doxygen will parse them like normal C++ but will assume all classes use public
240# instead of private inheritance when no explicit protection keyword is present.
241
242SIP_SUPPORT = NO
243
244# For Microsoft's IDL there are propget and propput attributes to indicate getter
245# and setter methods for a property. Setting this option to YES (the default)
246# will make doxygen to replace the get and set methods by a property in the
247# documentation. This will only work if the methods are indeed getting or
248# setting a simple type. If this is not the case, or you want to show the
249# methods anyway, you should set this option to NO.
250
251IDL_PROPERTY_SUPPORT = YES
252
253# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
254# tag is set to YES, then doxygen will reuse the documentation of the first
255# member in the group (if any) for the other members of the group. By default
256# all members of a group must be documented explicitly.
257
258DISTRIBUTE_GROUP_DOC = NO
259
260# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
261# the same type (for instance a group of public functions) to be put as a
262# subgroup of that type (e.g. under the Public Functions section). Set it to
263# NO to prevent subgrouping. Alternatively, this can be done per class using
264# the \nosubgrouping command.
265
266SUBGROUPING = YES
267
268# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
269# is documented as struct, union, or enum with the name of the typedef. So
270# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
271# with name TypeT. When disabled the typedef will appear as a member of a file,
272# namespace, or class. And the struct will be named TypeS. This can typically
273# be useful for C code in case the coding convention dictates that all compound
274# types are typedef'ed and only the typedef is referenced, never the tag name.
275
276TYPEDEF_HIDES_STRUCT = NO
277
278#---------------------------------------------------------------------------
279# Build related configuration options
280#---------------------------------------------------------------------------
281
282# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
283# documentation are documented, even if no documentation was available.
284# Private class members and static file members will be hidden unless
285# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
286
287EXTRACT_ALL = YES
288
289# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
290# will be included in the documentation.
291
292EXTRACT_PRIVATE = YES
293
294# If the EXTRACT_STATIC tag is set to YES all static members of a file
295# will be included in the documentation.
296
297EXTRACT_STATIC = YES
298
299# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
300# defined locally in source files will be included in the documentation.
301# If set to NO only classes defined in header files are included.
302
303EXTRACT_LOCAL_CLASSES = YES
304
305# This flag is only useful for Objective-C code. When set to YES local
306# methods, which are defined in the implementation section but not in
307# the interface are included in the documentation.
308# If set to NO (the default) only methods in the interface are included.
309
310EXTRACT_LOCAL_METHODS = NO
311
312# If this flag is set to YES, the members of anonymous namespaces will be
313# extracted and appear in the documentation as a namespace called
314# 'anonymous_namespace{file}', where file will be replaced with the base
315# name of the file that contains the anonymous namespace. By default
316# anonymous namespace are hidden.
317
318EXTRACT_ANON_NSPACES = NO
319
320# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
321# undocumented members of documented classes, files or namespaces.
322# If set to NO (the default) these members will be included in the
323# various overviews, but no documentation section is generated.
324# This option has no effect if EXTRACT_ALL is enabled.
325
326HIDE_UNDOC_MEMBERS = NO
327
328# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
329# undocumented classes that are normally visible in the class hierarchy.
330# If set to NO (the default) these classes will be included in the various
331# overviews. This option has no effect if EXTRACT_ALL is enabled.
332
333HIDE_UNDOC_CLASSES = NO
334
335# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
336# friend (class|struct|union) declarations.
337# If set to NO (the default) these declarations will be included in the
338# documentation.
339
340HIDE_FRIEND_COMPOUNDS = NO
341
342# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
343# documentation blocks found inside the body of a function.
344# If set to NO (the default) these blocks will be appended to the
345# function's detailed documentation block.
346
347HIDE_IN_BODY_DOCS = NO
348
349# The INTERNAL_DOCS tag determines if documentation
350# that is typed after a \internal command is included. If the tag is set
351# to NO (the default) then the documentation will be excluded.
352# Set it to YES to include the internal documentation.
353
354INTERNAL_DOCS = YES
355
356# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
357# file names in lower-case letters. If set to YES upper-case letters are also
358# allowed. This is useful if you have classes or files whose names only differ
359# in case and if your file system supports case sensitive file names. Windows
360# and Mac users are advised to set this option to NO.
361
362CASE_SENSE_NAMES = NO
363
364# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
365# will show members with their full class and namespace scopes in the
366# documentation. If set to YES the scope will be hidden.
367
368HIDE_SCOPE_NAMES = NO
369
370# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
371# will put a list of the files that are included by a file in the documentation
372# of that file.
373
374SHOW_INCLUDE_FILES = NO
375
376# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
377# is inserted in the documentation for inline members.
378
379INLINE_INFO = YES
380
381# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
382# will sort the (detailed) documentation of file and class members
383# alphabetically by member name. If set to NO the members will appear in
384# declaration order.
385
386SORT_MEMBER_DOCS = NO
387
388# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
389# brief documentation of file, namespace and class members alphabetically
390# by member name. If set to NO (the default) the members will appear in
391# declaration order.
392
393SORT_BRIEF_DOCS = NO
394
395# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
396# hierarchy of group names into alphabetical order. If set to NO (the default)
397# the group names will appear in their defined order.
398
399SORT_GROUP_NAMES = NO
400
401# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
402# sorted by fully-qualified names, including namespaces. If set to
403# NO (the default), the class list will be sorted only by class name,
404# not including the namespace part.
405# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
406# Note: This option applies only to the class list, not to the
407# alphabetical list.
408
409SORT_BY_SCOPE_NAME = NO
410
411# The GENERATE_TODOLIST tag can be used to enable (YES) or
412# disable (NO) the todo list. This list is created by putting \todo
413# commands in the documentation.
414
415GENERATE_TODOLIST = YES
416
417# The GENERATE_TESTLIST tag can be used to enable (YES) or
418# disable (NO) the test list. This list is created by putting \test
419# commands in the documentation.
420
421GENERATE_TESTLIST = YES
422
423# The GENERATE_BUGLIST tag can be used to enable (YES) or
424# disable (NO) the bug list. This list is created by putting \bug
425# commands in the documentation.
426
427GENERATE_BUGLIST = YES
428
429# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
430# disable (NO) the deprecated list. This list is created by putting
431# \deprecated commands in the documentation.
432
433GENERATE_DEPRECATEDLIST= YES
434
435# The ENABLED_SECTIONS tag can be used to enable conditional
436# documentation sections, marked by \if sectionname ... \endif.
437
438ENABLED_SECTIONS =
439
440# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
441# the initial value of a variable or define consists of for it to appear in
442# the documentation. If the initializer consists of more lines than specified
443# here it will be hidden. Use a value of 0 to hide initializers completely.
444# The appearance of the initializer of individual variables and defines in the
445# documentation can be controlled using \showinitializer or \hideinitializer
446# command in the documentation regardless of this setting.
447
448MAX_INITIALIZER_LINES = 30
449
450# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
451# at the bottom of the documentation of classes and structs. If set to YES the
452# list will mention the files that were used to generate the documentation.
453
454SHOW_USED_FILES = NO
455
456# If the sources in your project are distributed over multiple directories
457# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
458# in the documentation. The default is NO.
459
460SHOW_DIRECTORIES = NO
461
462# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
463# This will remove the Files entry from the Quick Index and from the
464# Folder Tree View (if specified). The default is YES.
465
466SHOW_FILES = YES
467
468# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
469# Namespaces page. This will remove the Namespaces entry from the Quick Index
470# and from the Folder Tree View (if specified). The default is YES.
471
472SHOW_NAMESPACES = YES
473
474# The FILE_VERSION_FILTER tag can be used to specify a program or script that
475# doxygen should invoke to get the current version for each file (typically from
476# the version control system). Doxygen will invoke the program by executing (via
477# popen()) the command <command> <input-file>, where <command> is the value of
478# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
479# provided by doxygen. Whatever the program writes to standard output
480# is used as the file version. See the manual for examples.
481
482FILE_VERSION_FILTER =
483
484#---------------------------------------------------------------------------
485# configuration options related to warning and progress messages
486#---------------------------------------------------------------------------
487
488# The QUIET tag can be used to turn on/off the messages that are generated
489# by doxygen. Possible values are YES and NO. If left blank NO is used.
490
491QUIET = YES
492
493# The WARNINGS tag can be used to turn on/off the warning messages that are
494# generated by doxygen. Possible values are YES and NO. If left blank
495# NO is used.
496
497WARNINGS = YES
498
499# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
500# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
501# automatically be disabled.
502
503WARN_IF_UNDOCUMENTED = YES
504
505# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
506# potential errors in the documentation, such as not documenting some
507# parameters in a documented function, or documenting parameters that
508# don't exist or using markup commands wrongly.
509
510WARN_IF_DOC_ERROR = YES
511
512# This WARN_NO_PARAMDOC option can be abled to get warnings for
513# functions that are documented, but have no documentation for their parameters
514# or return value. If set to NO (the default) doxygen will only warn about
515# wrong or incomplete parameter documentation, but not about the absence of
516# documentation.
517
518WARN_NO_PARAMDOC = NO
519
520# The WARN_FORMAT tag determines the format of the warning messages that
521# doxygen can produce. The string should contain the $file, $line, and $text
522# tags, which will be replaced by the file and line number from which the
523# warning originated and the warning text. Optionally the format may contain
524# $version, which will be replaced by the version of the file (if it could
525# be obtained via FILE_VERSION_FILTER)
526
527WARN_FORMAT = "$file:$line: $text"
528
529# The WARN_LOGFILE tag can be used to specify a file to which warning
530# and error messages should be written. If left blank the output is written
531# to stderr.
532
533WARN_LOGFILE = $(PATH_TARGET)/Main.err
534
535#---------------------------------------------------------------------------
536# configuration options related to the input files
537#---------------------------------------------------------------------------
538
539# The INPUT tag can be used to specify the files and/or directories that contain
540# documented source files. You may enter file names like "myfile.cpp" or
541# directories like "/usr/src/myproject". Separate the files or directories
542# with spaces.
543
544INPUT = $(PATH_TARGET)/VirtualBox.idl
545
546# This tag can be used to specify the character encoding of the source files
547# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
548# also the default input encoding. Doxygen uses libiconv (or the iconv built
549# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
550# the list of possible encodings.
551
552INPUT_ENCODING = UTF-8
553
554# If the value of the INPUT tag contains directories, you can use the
555# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
556# and *.h) to filter out the source-files in the directories. If left
557# blank the following patterns are tested:
558# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
559# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
560
561FILE_PATTERNS =
562
563# The RECURSIVE tag can be used to turn specify whether or not subdirectories
564# should be searched for input files as well. Possible values are YES and NO.
565# If left blank NO is used.
566
567RECURSIVE = NO
568
569# The EXCLUDE tag can be used to specify files and/or directories that should
570# excluded from the INPUT source files. This way you can easily exclude a
571# subdirectory from a directory tree whose root is specified with the INPUT tag.
572
573EXCLUDE =
574
575# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
576# directories that are symbolic links (a Unix filesystem feature) are excluded
577# from the input.
578
579EXCLUDE_SYMLINKS = NO
580
581# If the value of the INPUT tag contains directories, you can use the
582# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
583# certain files from those directories. Note that the wildcards are matched
584# against the file with absolute path, so to exclude all test directories
585# for example use the pattern */test/*
586
587EXCLUDE_PATTERNS =
588
589# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
590# (namespaces, classes, functions, etc.) that should be excluded from the
591# output. The symbol name can be a fully qualified name, a word, or if the
592# wildcard * is used, a substring. Examples: ANamespace, AClass,
593# AClass::ANamespace, ANamespace::*Test
594
595EXCLUDE_SYMBOLS =
596
597# The EXAMPLE_PATH tag can be used to specify one or more files or
598# directories that contain example code fragments that are included (see
599# the \include command).
600
601EXAMPLE_PATH =
602
603# If the value of the EXAMPLE_PATH tag contains directories, you can use the
604# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
605# and *.h) to filter out the source-files in the directories. If left
606# blank all files are included.
607
608EXAMPLE_PATTERNS =
609
610# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
611# searched for input files to be used with the \include or \dontinclude
612# commands irrespective of the value of the RECURSIVE tag.
613# Possible values are YES and NO. If left blank NO is used.
614
615EXAMPLE_RECURSIVE = NO
616
617# The IMAGE_PATH tag can be used to specify one or more files or
618# directories that contain image that are included in the documentation (see
619# the \image command).
620
621IMAGE_PATH = doc
622
623# The INPUT_FILTER tag can be used to specify a program that doxygen should
624# invoke to filter for each input file. Doxygen will invoke the filter program
625# by executing (via popen()) the command <filter> <input-file>, where <filter>
626# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
627# input file. Doxygen will then use the output that the filter program writes
628# to standard output. If FILTER_PATTERNS is specified, this tag will be
629# ignored.
630
631INPUT_FILTER =
632
633# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
634# basis. Doxygen will compare the file name with each pattern and apply the
635# filter if there is a match. The filters are a list of the form:
636# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
637# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
638# is applied to all files.
639
640FILTER_PATTERNS =
641
642# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
643# INPUT_FILTER) will be used to filter the input files when producing source
644# files to browse (i.e. when SOURCE_BROWSER is set to YES).
645
646FILTER_SOURCE_FILES = NO
647
648#---------------------------------------------------------------------------
649# configuration options related to source browsing
650#---------------------------------------------------------------------------
651
652# If the SOURCE_BROWSER tag is set to YES then a list of source files will
653# be generated. Documented entities will be cross-referenced with these sources.
654# Note: To get rid of all source code in the generated output, make sure also
655# VERBATIM_HEADERS is set to NO.
656
657SOURCE_BROWSER = NO
658
659# Setting the INLINE_SOURCES tag to YES will include the body
660# of functions and classes directly in the documentation.
661
662INLINE_SOURCES = NO
663
664# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
665# doxygen to hide any special comment blocks from generated source code
666# fragments. Normal C and C++ comments will always remain visible.
667
668STRIP_CODE_COMMENTS = YES
669
670# If the REFERENCED_BY_RELATION tag is set to YES
671# then for each documented function all documented
672# functions referencing it will be listed.
673
674REFERENCED_BY_RELATION = YES
675
676# If the REFERENCES_RELATION tag is set to YES
677# then for each documented function all documented entities
678# called/used by that function will be listed.
679
680REFERENCES_RELATION = YES
681
682# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
683# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
684# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
685# link to the source code. Otherwise they will link to the documentstion.
686
687REFERENCES_LINK_SOURCE = YES
688
689# If the USE_HTAGS tag is set to YES then the references to source code
690# will point to the HTML generated by the htags(1) tool instead of doxygen
691# built-in source browser. The htags tool is part of GNU's global source
692# tagging system (see http://www.gnu.org/software/global/global.html). You
693# will need version 4.8.6 or higher.
694
695USE_HTAGS = NO
696
697# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
698# will generate a verbatim copy of the header file for each class for
699# which an include is specified. Set to NO to disable this.
700
701VERBATIM_HEADERS = YES
702
703#---------------------------------------------------------------------------
704# configuration options related to the alphabetical class index
705#---------------------------------------------------------------------------
706
707# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
708# of all compounds will be generated. Enable this if the project
709# contains a lot of classes, structs, unions or interfaces.
710
711ALPHABETICAL_INDEX = NO
712
713# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
714# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
715# in which this list will be split (can be a number in the range [1..20])
716
717COLS_IN_ALPHA_INDEX = 5
718
719# In case all classes in a project start with a common prefix, all
720# classes will be put under the same header in the alphabetical index.
721# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
722# should be ignored while generating the index headers.
723
724IGNORE_PREFIX =
725
726#---------------------------------------------------------------------------
727# configuration options related to the HTML output
728#---------------------------------------------------------------------------
729
730# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
731# generate HTML output.
732
733GENERATE_HTML = YES
734
735# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
736# If a relative path is entered the value of OUTPUT_DIRECTORY will be
737# put in front of it. If left blank `html' will be used as the default path.
738
739HTML_OUTPUT = html
740
741# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
742# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
743# doxygen will generate files with .html extension.
744
745HTML_FILE_EXTENSION = .html
746
747# The HTML_HEADER tag can be used to specify a personal HTML header for
748# each generated HTML page. If it is left blank doxygen will generate a
749# standard header.
750
751HTML_HEADER =
752
753# The HTML_FOOTER tag can be used to specify a personal HTML footer for
754# each generated HTML page. If it is left blank doxygen will generate a
755# standard footer.
756
757HTML_FOOTER =
758
759# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
760# style sheet that is used by each HTML page. It can be used to
761# fine-tune the look of the HTML output. If the tag is left blank doxygen
762# will generate a default style sheet. Note that doxygen will try to copy
763# the style sheet file to the HTML output directory, so don't put your own
764# stylesheet in the HTML output directory as well, or it will be erased!
765
766HTML_STYLESHEET =
767
768# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
769# files or namespaces will be aligned in HTML using tables. If set to
770# NO a bullet list will be used.
771
772HTML_ALIGN_MEMBERS = YES
773
774# If the GENERATE_HTMLHELP tag is set to YES, additional index files
775# will be generated that can be used as input for tools like the
776# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
777# of the generated HTML documentation.
778
779GENERATE_HTMLHELP = YES
780
781# If the GENERATE_DOCSET tag is set to YES, additional index files
782# will be generated that can be used as input for Apple's Xcode 3
783# integrated development environment, introduced with OSX 10.5 (Leopard).
784# To create a documentation set, doxygen will generate a Makefile in the
785# HTML output directory. Running make will produce the docset in that
786# directory and running "make install" will install the docset in
787# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
788# it at startup.
789
790GENERATE_DOCSET = NO
791
792# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
793# feed. A documentation feed provides an umbrella under which multiple
794# documentation sets from a single provider (such as a company or product suite)
795# can be grouped.
796
797DOCSET_FEEDNAME = "Doxygen generated docs"
798
799# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
800# should uniquely identify the documentation set bundle. This should be a
801# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
802# will append .docset to the name.
803
804DOCSET_BUNDLE_ID = org.doxygen.Project
805
806# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
807# documentation will contain sections that can be hidden and shown after the
808# page has loaded. For this to work a browser that supports
809# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
810# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
811
812HTML_DYNAMIC_SECTIONS = NO
813
814# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
815# be used to specify the file name of the resulting .chm file. You
816# can add a path in front of the file if the result should not be
817# written to the html output directory.
818
819CHM_FILE = $(PATH_CHM)
820
821# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
822# be used to specify the location (absolute path including file name) of
823# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
824# the HTML help compiler on the generated index.hhp.
825
826HHC_LOCATION =
827
828# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
829# controls if a separate .chi index file is generated (YES) or that
830# it should be included in the master .chm file (NO).
831
832GENERATE_CHI = NO
833
834# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
835# is used to encode HtmlHelp index (hhk), content (hhc) and project file
836# content.
837
838CHM_INDEX_ENCODING =
839
840# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
841# controls whether a binary table of contents is generated (YES) or a
842# normal table of contents (NO) in the .chm file.
843
844BINARY_TOC = NO
845
846# The TOC_EXPAND flag can be set to YES to add extra items for group members
847# to the contents of the HTML help documentation and to the tree view.
848
849TOC_EXPAND = NO
850
851# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
852# top of each HTML page. The value NO (the default) enables the index and
853# the value YES disables it.
854
855DISABLE_INDEX = NO
856
857# This tag can be used to set the number of enum values (range [1..20])
858# that doxygen will group on one line in the generated HTML documentation.
859
860ENUM_VALUES_PER_LINE = 4
861
862# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
863# structure should be generated to display hierarchical information.
864# If the tag value is set to FRAME, a side panel will be generated
865# containing a tree-like index structure (just like the one that
866# is generated for HTML Help). For this to work a browser that supports
867# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
868# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
869# probably better off using the HTML help feature. Other possible values
870# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
871# and Class Hierarchy pages using a tree view instead of an ordered list;
872# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
873# disables this behavior completely. For backwards compatibility with previous
874# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
875# respectively.
876
877GENERATE_TREEVIEW = NO
878
879# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
880# used to set the initial width (in pixels) of the frame in which the tree
881# is shown.
882
883TREEVIEW_WIDTH = 250
884
885# Use this tag to change the font size of Latex formulas included
886# as images in the HTML documentation. The default is 10. Note that
887# when you change the font size after a successful doxygen run you need
888# to manually remove any form_*.png images from the HTML output directory
889# to force them to be regenerated.
890
891FORMULA_FONTSIZE = 10
892
893#---------------------------------------------------------------------------
894# configuration options related to the LaTeX output
895#---------------------------------------------------------------------------
896
897# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
898# generate Latex output.
899
900GENERATE_LATEX = NO
901
902# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
903# If a relative path is entered the value of OUTPUT_DIRECTORY will be
904# put in front of it. If left blank `latex' will be used as the default path.
905
906LATEX_OUTPUT = latex
907
908# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
909# invoked. If left blank `latex' will be used as the default command name.
910
911LATEX_CMD_NAME = latex
912
913# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
914# generate index for LaTeX. If left blank `makeindex' will be used as the
915# default command name.
916
917MAKEINDEX_CMD_NAME = makeindex
918
919# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
920# LaTeX documents. This may be useful for small projects and may help to
921# save some trees in general.
922
923COMPACT_LATEX = NO
924
925# The PAPER_TYPE tag can be used to set the paper type that is used
926# by the printer. Possible values are: a4, a4wide, letter, legal and
927# executive. If left blank a4wide will be used.
928
929PAPER_TYPE = a4wide
930
931# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
932# packages that should be included in the LaTeX output.
933
934EXTRA_PACKAGES =
935
936# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
937# the generated latex document. The header should contain everything until
938# the first chapter. If it is left blank doxygen will generate a
939# standard header. Notice: only use this tag if you know what you are doing!
940
941LATEX_HEADER =
942
943# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
944# is prepared for conversion to pdf (using ps2pdf). The pdf file will
945# contain links (just like the HTML output) instead of page references
946# This makes the output suitable for online browsing using a pdf viewer.
947
948PDF_HYPERLINKS = NO
949
950# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
951# plain latex in the generated Makefile. Set this option to YES to get a
952# higher quality PDF documentation.
953
954USE_PDFLATEX = NO
955
956# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
957# command to the generated LaTeX files. This will instruct LaTeX to keep
958# running if errors occur, instead of asking the user for help.
959# This option is also used when generating formulas in HTML.
960
961LATEX_BATCHMODE = NO
962
963# If LATEX_HIDE_INDICES is set to YES then doxygen will not
964# include the index chapters (such as File Index, Compound Index, etc.)
965# in the output.
966
967LATEX_HIDE_INDICES = NO
968
969#---------------------------------------------------------------------------
970# configuration options related to the RTF output
971#---------------------------------------------------------------------------
972
973# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
974# The RTF output is optimized for Word 97 and may not look very pretty with
975# other RTF readers or editors.
976
977GENERATE_RTF = NO
978
979# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
980# If a relative path is entered the value of OUTPUT_DIRECTORY will be
981# put in front of it. If left blank `rtf' will be used as the default path.
982
983RTF_OUTPUT = rtf
984
985# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
986# RTF documents. This may be useful for small projects and may help to
987# save some trees in general.
988
989COMPACT_RTF = NO
990
991# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
992# will contain hyperlink fields. The RTF file will
993# contain links (just like the HTML output) instead of page references.
994# This makes the output suitable for online browsing using WORD or other
995# programs which support those fields.
996# Note: wordpad (write) and others do not support links.
997
998RTF_HYPERLINKS = NO
999
1000# Load stylesheet definitions from file. Syntax is similar to doxygen's
1001# config file, i.e. a series of assignments. You only have to provide
1002# replacements, missing definitions are set to their default value.
1003
1004RTF_STYLESHEET_FILE =
1005
1006# Set optional variables used in the generation of an rtf document.
1007# Syntax is similar to doxygen's config file.
1008
1009RTF_EXTENSIONS_FILE =
1010
1011#---------------------------------------------------------------------------
1012# configuration options related to the man page output
1013#---------------------------------------------------------------------------
1014
1015# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1016# generate man pages
1017
1018GENERATE_MAN = NO
1019
1020# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1021# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1022# put in front of it. If left blank `man' will be used as the default path.
1023
1024MAN_OUTPUT = man
1025
1026# The MAN_EXTENSION tag determines the extension that is added to
1027# the generated man pages (default is the subroutine's section .3)
1028
1029MAN_EXTENSION = .3
1030
1031# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1032# then it will generate one additional man file for each entity
1033# documented in the real man page(s). These additional files
1034# only source the real man page, but without them the man command
1035# would be unable to find the correct page. The default is NO.
1036
1037MAN_LINKS = NO
1038
1039#---------------------------------------------------------------------------
1040# configuration options related to the XML output
1041#---------------------------------------------------------------------------
1042
1043# If the GENERATE_XML tag is set to YES Doxygen will
1044# generate an XML file that captures the structure of
1045# the code including all documentation.
1046
1047GENERATE_XML = NO
1048
1049# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1050# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1051# put in front of it. If left blank `xml' will be used as the default path.
1052
1053XML_OUTPUT = xml
1054
1055# The XML_SCHEMA tag can be used to specify an XML schema,
1056# which can be used by a validating XML parser to check the
1057# syntax of the XML files.
1058
1059XML_SCHEMA =
1060
1061# The XML_DTD tag can be used to specify an XML DTD,
1062# which can be used by a validating XML parser to check the
1063# syntax of the XML files.
1064
1065XML_DTD =
1066
1067# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1068# dump the program listings (including syntax highlighting
1069# and cross-referencing information) to the XML output. Note that
1070# enabling this will significantly increase the size of the XML output.
1071
1072XML_PROGRAMLISTING = YES
1073
1074#---------------------------------------------------------------------------
1075# configuration options for the AutoGen Definitions output
1076#---------------------------------------------------------------------------
1077
1078# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1079# generate an AutoGen Definitions (see autogen.sf.net) file
1080# that captures the structure of the code including all
1081# documentation. Note that this feature is still experimental
1082# and incomplete at the moment.
1083
1084GENERATE_AUTOGEN_DEF = NO
1085
1086#---------------------------------------------------------------------------
1087# configuration options related to the Perl module output
1088#---------------------------------------------------------------------------
1089
1090# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1091# generate a Perl module file that captures the structure of
1092# the code including all documentation. Note that this
1093# feature is still experimental and incomplete at the
1094# moment.
1095
1096GENERATE_PERLMOD = NO
1097
1098# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1099# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1100# to generate PDF and DVI output from the Perl module output.
1101
1102PERLMOD_LATEX = NO
1103
1104# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1105# nicely formatted so it can be parsed by a human reader. This is useful
1106# if you want to understand what is going on. On the other hand, if this
1107# tag is set to NO the size of the Perl module output will be much smaller
1108# and Perl will parse it just the same.
1109
1110PERLMOD_PRETTY = YES
1111
1112# The names of the make variables in the generated doxyrules.make file
1113# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1114# This is useful so different doxyrules.make files included by the same
1115# Makefile don't overwrite each other's variables.
1116
1117PERLMOD_MAKEVAR_PREFIX =
1118
1119#---------------------------------------------------------------------------
1120# Configuration options related to the preprocessor
1121#---------------------------------------------------------------------------
1122
1123# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1124# evaluate all C-preprocessor directives found in the sources and include
1125# files.
1126
1127ENABLE_PREPROCESSING = YES
1128
1129# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1130# names in the source code. If set to NO (the default) only conditional
1131# compilation will be performed. Macro expansion can be done in a controlled
1132# way by setting EXPAND_ONLY_PREDEF to YES.
1133
1134MACRO_EXPANSION = YES
1135
1136# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1137# then the macro expansion is limited to the macros specified with the
1138# PREDEFINED and EXPAND_AS_DEFINED tags.
1139
1140EXPAND_ONLY_PREDEF = YES
1141
1142# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1143# in the INCLUDE_PATH (see below) will be search if a #include is found.
1144
1145SEARCH_INCLUDES = YES
1146
1147# The INCLUDE_PATH tag can be used to specify one or more directories that
1148# contain include files that are not input files but should be processed by
1149# the preprocessor.
1150
1151INCLUDE_PATH = include
1152
1153# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1154# patterns (like *.h and *.hpp) to filter out the header-files in the
1155# directories. If left blank, the patterns specified with FILE_PATTERNS will
1156# be used.
1157
1158INCLUDE_FILE_PATTERNS =
1159
1160# The PREDEFINED tag can be used to specify one or more macro names that
1161# are defined before the preprocessor is started (similar to the -D option of
1162# gcc). The argument of the tag is a list of macros of the form: name
1163# or name=definition (no spaces). If the definition and the = are
1164# omitted =1 is assumed. To prevent a macro definition from being
1165# undefined via #undef or recursively expanded use the := operator
1166# instead of the = operator.
1167
1168PREDEFINED = \
1169 DOXYGEN_RUNNING \
1170 RT_C_DECLS_END \
1171 RT_C_DECLS_BEGIN
1172
1173# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1174# this tag can be used to specify a list of macro names that should be expanded.
1175# The macro definition that is found in the sources will be used.
1176# Use the PREDEFINED tag if you want to use a different macro definition.
1177
1178EXPAND_AS_DEFINED = \
1179 DECLEXPORT \
1180 DECLIMPORT \
1181 DECLASM \
1182 DECLASMTYPE \
1183 DECLCALLBACK \
1184 VMMR3DECL \
1185 VMMR0DECL \
1186 VMMRCDECL \
1187 VMMDECL \
1188 DBGDECL \
1189 DISDECL \
1190 SUPR3DECL \
1191 SUPR0DECL \
1192 SUPDECL \
1193 RTR3DECL \
1194 RTR0DECL \
1195 RTRCDECL \
1196 RTDECL
1197
1198
1199
1200# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1201# doxygen's preprocessor will remove all function-like macros that are alone
1202# on a line, have an all uppercase name, and do not end with a semicolon. Such
1203# function macros are typically used for boiler-plate code, and will confuse
1204# the parser if not removed.
1205
1206SKIP_FUNCTION_MACROS = YES
1207
1208#---------------------------------------------------------------------------
1209# Configuration::additions related to external references
1210#---------------------------------------------------------------------------
1211
1212# The TAGFILES option can be used to specify one or more tagfiles.
1213# Optionally an initial location of the external documentation
1214# can be added for each tagfile. The format of a tag file without
1215# this location is as follows:
1216# TAGFILES = file1 file2 ...
1217# Adding location for the tag files is done as follows:
1218# TAGFILES = file1=loc1 "file2 = loc2" ...
1219# where "loc1" and "loc2" can be relative or absolute paths or
1220# URLs. If a location is present for each tag, the installdox tool
1221# does not have to be run to correct the links.
1222# Note that each tag file must have a unique name
1223# (where the name does NOT include the path)
1224# If a tag file is not located in the directory in which doxygen
1225# is run, you must also specify the path to the tagfile here.
1226
1227TAGFILES =
1228
1229# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1230# a tag file that is based on the input files it reads.
1231
1232GENERATE_TAGFILE =
1233
1234# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1235# in the class index. If set to NO only the inherited external classes
1236# will be listed.
1237
1238ALLEXTERNALS = NO
1239
1240# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1241# in the modules index. If set to NO, only the current project's groups will
1242# be listed.
1243
1244EXTERNAL_GROUPS = YES
1245
1246# The PERL_PATH should be the absolute path and name of the perl script
1247# interpreter (i.e. the result of `which perl').
1248
1249PERL_PATH = /usr/bin/perl
1250
1251#---------------------------------------------------------------------------
1252# Configuration options related to the dot tool
1253#---------------------------------------------------------------------------
1254
1255# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1256# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1257# or super classes. Setting the tag to NO turns the diagrams off. Note that
1258# this option is superseded by the HAVE_DOT option below. This is only a
1259# fallback. It is recommended to install and use dot, since it yields more
1260# powerful graphs.
1261
1262CLASS_DIAGRAMS = YES
1263
1264# You can define message sequence charts within doxygen comments using the \msc
1265# command. Doxygen will then run the mscgen tool (see
1266# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1267# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1268# the mscgen tool resides. If left empty the tool is assumed to be found in the
1269# default search path.
1270
1271MSCGEN_PATH =
1272
1273# If set to YES, the inheritance and collaboration graphs will hide
1274# inheritance and usage relations if the target is undocumented
1275# or is not a class.
1276
1277HIDE_UNDOC_RELATIONS = YES
1278
1279# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1280# available from the path. This tool is part of Graphviz, a graph visualization
1281# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1282# have no effect if this option is set to NO (the default)
1283
1284HAVE_DOT = NO
1285
1286# By default doxygen will write a font called FreeSans.ttf to the output
1287# directory and reference it in all dot files that doxygen generates. This
1288# font does not include all possible unicode characters however, so when you need
1289# these (or just want a differently looking font) you can specify the font name
1290# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1291# which can be done by putting it in a standard location or by setting the
1292# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1293# containing the font.
1294
1295DOT_FONTNAME = FreeSans
1296
1297# By default doxygen will tell dot to use the output directory to look for the
1298# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1299# different font using DOT_FONTNAME you can set the path where dot
1300# can find it using this tag.
1301
1302DOT_FONTPATH =
1303
1304# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1305# will generate a graph for each documented class showing the direct and
1306# indirect inheritance relations. Setting this tag to YES will force the
1307# the CLASS_DIAGRAMS tag to NO.
1308
1309CLASS_GRAPH = YES
1310
1311# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1312# will generate a graph for each documented class showing the direct and
1313# indirect implementation dependencies (inheritance, containment, and
1314# class references variables) of the class with other documented classes.
1315
1316COLLABORATION_GRAPH = YES
1317
1318# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1319# will generate a graph for groups, showing the direct groups dependencies
1320
1321GROUP_GRAPHS = YES
1322
1323# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1324# collaboration diagrams in a style similar to the OMG's Unified Modeling
1325# Language.
1326
1327UML_LOOK = YES
1328
1329# If set to YES, the inheritance and collaboration graphs will show the
1330# relations between templates and their instances.
1331
1332TEMPLATE_RELATIONS = YES
1333
1334# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1335# tags are set to YES then doxygen will generate a graph for each documented
1336# file showing the direct and indirect include dependencies of the file with
1337# other documented files.
1338
1339INCLUDE_GRAPH = YES
1340
1341# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1342# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1343# documented header file showing the documented files that directly or
1344# indirectly include this file.
1345
1346INCLUDED_BY_GRAPH = YES
1347
1348# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1349# doxygen will generate a call dependency graph for every global function
1350# or class method. Note that enabling this option will significantly increase
1351# the time of a run. So in most cases it will be better to enable call graphs
1352# for selected functions only using the \callgraph command.
1353
1354CALL_GRAPH = YES
1355
1356# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1357# doxygen will generate a caller dependency graph for every global function
1358# or class method. Note that enabling this option will significantly increase
1359# the time of a run. So in most cases it will be better to enable caller
1360# graphs for selected functions only using the \callergraph command.
1361
1362CALLER_GRAPH = NO
1363
1364# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1365# will graphical hierarchy of all classes instead of a textual one.
1366
1367GRAPHICAL_HIERARCHY = YES
1368
1369# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1370# then doxygen will show the dependencies a directory has on other directories
1371# in a graphical way. The dependency relations are determined by the #include
1372# relations between the files in the directories.
1373
1374DIRECTORY_GRAPH = YES
1375
1376# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1377# generated by dot. Possible values are png, jpg, or gif
1378# If left blank png will be used.
1379
1380DOT_IMAGE_FORMAT = png
1381
1382# The tag DOT_PATH can be used to specify the path where the dot tool can be
1383# found. If left blank, it is assumed the dot tool can be found in the path.
1384
1385DOT_PATH =
1386
1387# The DOTFILE_DIRS tag can be used to specify one or more directories that
1388# contain dot files that are included in the documentation (see the
1389# \dotfile command).
1390
1391DOTFILE_DIRS =
1392
1393# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1394# nodes that will be shown in the graph. If the number of nodes in a graph
1395# becomes larger than this value, doxygen will truncate the graph, which is
1396# visualized by representing a node as a red box. Note that doxygen if the
1397# number of direct children of the root node in a graph is already larger than
1398# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1399# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1400
1401DOT_GRAPH_MAX_NODES = 50
1402
1403# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1404# graphs generated by dot. A depth value of 3 means that only nodes reachable
1405# from the root by following a path via at most 3 edges will be shown. Nodes
1406# that lay further from the root node will be omitted. Note that setting this
1407# option to 1 or 2 may greatly reduce the computation time needed for large
1408# code bases. Also note that the size of a graph can be further restricted by
1409# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1410
1411MAX_DOT_GRAPH_DEPTH = 0
1412
1413# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1414# background. This is enabled by default, which results in a transparent
1415# background. Warning: Depending on the platform used, enabling this option
1416# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1417# become hard to read).
1418
1419DOT_TRANSPARENT = YES
1420
1421# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1422# files in one run (i.e. multiple -o and -T options on the command line). This
1423# makes dot run faster, but since only newer versions of dot (>1.8.10)
1424# support this, this feature is disabled by default.
1425
1426DOT_MULTI_TARGETS = NO
1427
1428# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1429# generate a legend page explaining the meaning of the various boxes and
1430# arrows in the dot generated graphs.
1431
1432GENERATE_LEGEND = YES
1433
1434# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1435# remove the intermediate dot files that are used to generate
1436# the various graphs.
1437
1438DOT_CLEANUP = YES
1439
1440#---------------------------------------------------------------------------
1441# Configuration::additions related to the search engine
1442#---------------------------------------------------------------------------
1443
1444# The SEARCHENGINE tag specifies whether or not a search engine should be
1445# used. If set to NO the values of all tags below this one will be ignored.
1446
1447SEARCHENGINE = NO
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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