VirtualBox

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

Last change on this file since 14515 was 11848, checked in by vboxsync, 16 years ago

docs, other sdk cleanups

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 46.7 KB
Line 
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 = "VirtualBox Main API"
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
33OUTPUT_DIRECTORY = $(DOCDIR)
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
63USE_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 = "The $name class" "The $name interface" "is" "provides" "represents" "a" "an" "the"
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
183# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
184# only. Doxygen will then generate output that is more tailored for C.
185# For instance, some of the names that are used will be different. The list
186# of all members will be omitted, etc.
187
188OPTIMIZE_OUTPUT_FOR_C = NO
189
190# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
191# only. Doxygen will then generate output that is more tailored for Java.
192# For instance, namespaces will be presented as packages, qualified scopes
193# will look different, etc.
194
195OPTIMIZE_OUTPUT_JAVA = NO
196
197# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
198# the same type (for instance a group of public functions) to be put as a
199# subgroup of that type (e.g. under the Public Functions section). Set it to
200# NO to prevent subgrouping. Alternatively, this can be done per class using
201# the \nosubgrouping command.
202
203SUBGROUPING = YES
204
205#---------------------------------------------------------------------------
206# Build related configuration options
207#---------------------------------------------------------------------------
208
209# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
210# documentation are documented, even if no documentation was available.
211# Private class members and static file members will be hidden unless
212# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
213
214EXTRACT_ALL = YES
215
216# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
217# will be included in the documentation.
218
219EXTRACT_PRIVATE = YES
220
221# If the EXTRACT_STATIC tag is set to YES all static members of a file
222# will be included in the documentation.
223
224EXTRACT_STATIC = YES
225
226# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
227# defined locally in source files will be included in the documentation.
228# If set to NO only classes defined in header files are included.
229
230EXTRACT_LOCAL_CLASSES = YES
231
232# This flag is only useful for Objective-C code. When set to YES local
233# methods, which are defined in the implementation section but not in
234# the interface are included in the documentation.
235# If set to NO (the default) only methods in the interface are included.
236
237EXTRACT_LOCAL_METHODS = NO
238
239# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
240# undocumented members of documented classes, files or namespaces.
241# If set to NO (the default) these members will be included in the
242# various overviews, but no documentation section is generated.
243# This option has no effect if EXTRACT_ALL is enabled.
244
245HIDE_UNDOC_MEMBERS = NO
246
247# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
248# undocumented classes that are normally visible in the class hierarchy.
249# If set to NO (the default) these classes will be included in the various
250# overviews. This option has no effect if EXTRACT_ALL is enabled.
251
252HIDE_UNDOC_CLASSES = NO
253
254# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
255# friend (class|struct|union) declarations.
256# If set to NO (the default) these declarations will be included in the
257# documentation.
258
259HIDE_FRIEND_COMPOUNDS = NO
260
261# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
262# documentation blocks found inside the body of a function.
263# If set to NO (the default) these blocks will be appended to the
264# function's detailed documentation block.
265
266HIDE_IN_BODY_DOCS = NO
267
268# The INTERNAL_DOCS tag determines if documentation
269# that is typed after a \internal command is included. If the tag is set
270# to NO (the default) then the documentation will be excluded.
271# Set it to YES to include the internal documentation.
272
273INTERNAL_DOCS = YES
274
275# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
276# file names in lower-case letters. If set to YES upper-case letters are also
277# allowed. This is useful if you have classes or files whose names only differ
278# in case and if your file system supports case sensitive file names. Windows
279# users are advised to set this option to NO.
280
281CASE_SENSE_NAMES = NO
282
283# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
284# will show members with their full class and namespace scopes in the
285# documentation. If set to YES the scope will be hidden.
286
287HIDE_SCOPE_NAMES = NO
288
289# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
290# will put a list of the files that are included by a file in the documentation
291# of that file.
292
293SHOW_INCLUDE_FILES = NO
294
295# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
296# is inserted in the documentation for inline members.
297
298INLINE_INFO = YES
299
300# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
301# will sort the (detailed) documentation of file and class members
302# alphabetically by member name. If set to NO the members will appear in
303# declaration order.
304
305SORT_MEMBER_DOCS = NO
306
307# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
308# brief documentation of file, namespace and class members alphabetically
309# by member name. If set to NO (the default) the members will appear in
310# declaration order.
311
312SORT_BRIEF_DOCS = NO
313
314# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
315# sorted by fully-qualified names, including namespaces. If set to
316# NO (the default), the class list will be sorted only by class name,
317# not including the namespace part.
318# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
319# Note: This option applies only to the class list, not to the
320# alphabetical list.
321
322SORT_BY_SCOPE_NAME = NO
323
324# The GENERATE_TODOLIST tag can be used to enable (YES) or
325# disable (NO) the todo list. This list is created by putting \todo
326# commands in the documentation.
327
328GENERATE_TODOLIST = YES
329
330# The GENERATE_TESTLIST tag can be used to enable (YES) or
331# disable (NO) the test list. This list is created by putting \test
332# commands in the documentation.
333
334GENERATE_TESTLIST = YES
335
336# The GENERATE_BUGLIST tag can be used to enable (YES) or
337# disable (NO) the bug list. This list is created by putting \bug
338# commands in the documentation.
339
340GENERATE_BUGLIST = YES
341
342# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
343# disable (NO) the deprecated list. This list is created by putting
344# \deprecated commands in the documentation.
345
346GENERATE_DEPRECATEDLIST= YES
347
348# The ENABLED_SECTIONS tag can be used to enable conditional
349# documentation sections, marked by \if sectionname ... \endif.
350
351ENABLED_SECTIONS =
352
353# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
354# the initial value of a variable or define consists of for it to appear in
355# the documentation. If the initializer consists of more lines than specified
356# here it will be hidden. Use a value of 0 to hide initializers completely.
357# The appearance of the initializer of individual variables and defines in the
358# documentation can be controlled using \showinitializer or \hideinitializer
359# command in the documentation regardless of this setting.
360
361MAX_INITIALIZER_LINES = 30
362
363# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
364# at the bottom of the documentation of classes and structs. If set to YES the
365# list will mention the files that were used to generate the documentation.
366
367SHOW_USED_FILES = NO
368
369#---------------------------------------------------------------------------
370# configuration options related to warning and progress messages
371#---------------------------------------------------------------------------
372
373# The QUIET tag can be used to turn on/off the messages that are generated
374# by doxygen. Possible values are YES and NO. If left blank NO is used.
375
376QUIET = YES
377
378# The WARNINGS tag can be used to turn on/off the warning messages that are
379# generated by doxygen. Possible values are YES and NO. If left blank
380# NO is used.
381
382WARNINGS = YES
383
384# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
385# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
386# automatically be disabled.
387
388WARN_IF_UNDOCUMENTED = YES
389
390# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
391# potential errors in the documentation, such as not documenting some
392# parameters in a documented function, or documenting parameters that
393# don't exist or using markup commands wrongly.
394
395WARN_IF_DOC_ERROR = YES
396
397# The WARN_FORMAT tag determines the format of the warning messages that
398# doxygen can produce. The string should contain the $file, $line, and $text
399# tags, which will be replaced by the file and line number from which the
400# warning originated and the warning text.
401
402WARN_FORMAT = "$file:$line: $text"
403
404# The WARN_LOGFILE tag can be used to specify a file to which warning
405# and error messages should be written. If left blank the output is written
406# to stderr.
407
408WARN_LOGFILE = $(PATH_TARGET)/Main.err
409
410#---------------------------------------------------------------------------
411# configuration options related to the input files
412#---------------------------------------------------------------------------
413
414# The INPUT tag can be used to specify the files and/or directories that contain
415# documented source files. You may enter file names like "myfile.cpp" or
416# directories like "/usr/src/myproject". Separate the files or directories
417# with spaces.
418
419INPUT = $(PATH_TARGET)/VirtualBox.idl
420
421
422# If the value of the INPUT tag contains directories, you can use the
423# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
424# and *.h) to filter out the source-files in the directories. If left
425# blank the following patterns are tested:
426# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
427# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
428
429FILE_PATTERNS =
430
431
432
433# The RECURSIVE tag can be used to turn specify whether or not subdirectories
434# should be searched for input files as well. Possible values are YES and NO.
435# If left blank NO is used.
436
437RECURSIVE = NO
438
439# The EXCLUDE tag can be used to specify files and/or directories that should
440# excluded from the INPUT source files. This way you can easily exclude a
441# subdirectory from a directory tree whose root is specified with the INPUT tag.
442
443EXCLUDE =
444
445# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
446# that are symbolic links (a Unix filesystem feature) are excluded from the input.
447
448EXCLUDE_SYMLINKS = NO
449
450# If the value of the INPUT tag contains directories, you can use the
451# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
452# certain files from those directories.
453
454EXCLUDE_PATTERNS =
455
456# The EXAMPLE_PATH tag can be used to specify one or more files or
457# directories that contain example code fragments that are included (see
458# the \include command).
459
460EXAMPLE_PATH =
461
462# If the value of the EXAMPLE_PATH tag contains directories, you can use the
463# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
464# and *.h) to filter out the source-files in the directories. If left
465# blank all files are included.
466
467EXAMPLE_PATTERNS =
468
469# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
470# searched for input files to be used with the \include or \dontinclude
471# commands irrespective of the value of the RECURSIVE tag.
472# Possible values are YES and NO. If left blank NO is used.
473
474EXAMPLE_RECURSIVE = NO
475
476# The IMAGE_PATH tag can be used to specify one or more files or
477# directories that contain image that are included in the documentation (see
478# the \image command).
479
480IMAGE_PATH = doc
481
482# The INPUT_FILTER tag can be used to specify a program that doxygen should
483# invoke to filter for each input file. Doxygen will invoke the filter program
484# by executing (via popen()) the command <filter> <input-file>, where <filter>
485# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
486# input file. Doxygen will then use the output that the filter program writes
487# to standard output.
488
489INPUT_FILTER =
490
491# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
492# INPUT_FILTER) will be used to filter the input files when producing source
493# files to browse (i.e. when SOURCE_BROWSER is set to YES).
494
495FILTER_SOURCE_FILES = NO
496
497#---------------------------------------------------------------------------
498# configuration options related to source browsing
499#---------------------------------------------------------------------------
500
501# If the SOURCE_BROWSER tag is set to YES then a list of source files will
502# be generated. Documented entities will be cross-referenced with these sources.
503# Note: To get rid of all source code in the generated output, make sure also
504# VERBATIM_HEADERS is set to NO.
505
506SOURCE_BROWSER = NO
507
508# Setting the INLINE_SOURCES tag to YES will include the body
509# of functions and classes directly in the documentation.
510
511INLINE_SOURCES = NO
512
513# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
514# doxygen to hide any special comment blocks from generated source code
515# fragments. Normal C and C++ comments will always remain visible.
516
517STRIP_CODE_COMMENTS = YES
518
519# If the REFERENCED_BY_RELATION tag is set to YES (the default)
520# then for each documented function all documented
521# functions referencing it will be listed.
522
523REFERENCED_BY_RELATION = YES
524
525# If the REFERENCES_RELATION tag is set to YES (the default)
526# then for each documented function all documented entities
527# called/used by that function will be listed.
528
529REFERENCES_RELATION = YES
530
531# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
532# will generate a verbatim copy of the header file for each class for
533# which an include is specified. Set to NO to disable this.
534
535VERBATIM_HEADERS = YES
536
537#---------------------------------------------------------------------------
538# configuration options related to the alphabetical class index
539#---------------------------------------------------------------------------
540
541# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
542# of all compounds will be generated. Enable this if the project
543# contains a lot of classes, structs, unions or interfaces.
544
545ALPHABETICAL_INDEX = NO
546
547# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
548# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
549# in which this list will be split (can be a number in the range [1..20])
550
551COLS_IN_ALPHA_INDEX = 5
552
553# In case all classes in a project start with a common prefix, all
554# classes will be put under the same header in the alphabetical index.
555# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
556# should be ignored while generating the index headers.
557
558IGNORE_PREFIX =
559
560#---------------------------------------------------------------------------
561# configuration options related to the HTML output
562#---------------------------------------------------------------------------
563
564# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
565# generate HTML output.
566
567GENERATE_HTML = YES
568
569# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
570# If a relative path is entered the value of OUTPUT_DIRECTORY will be
571# put in front of it. If left blank `html' will be used as the default path.
572
573HTML_OUTPUT = html
574
575# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
576# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
577# doxygen will generate files with .html extension.
578
579HTML_FILE_EXTENSION = .html
580
581# The HTML_HEADER tag can be used to specify a personal HTML header for
582# each generated HTML page. If it is left blank doxygen will generate a
583# standard header.
584
585HTML_HEADER =
586
587# The HTML_FOOTER tag can be used to specify a personal HTML footer for
588# each generated HTML page. If it is left blank doxygen will generate a
589# standard footer.
590
591HTML_FOOTER =
592
593# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
594# style sheet that is used by each HTML page. It can be used to
595# fine-tune the look of the HTML output. If the tag is left blank doxygen
596# will generate a default style sheet. Note that doxygen will try to copy
597# the style sheet file to the HTML output directory, so don't put your own
598# stylesheet in the HTML output directory as well, or it will be erased!
599
600HTML_STYLESHEET =
601
602# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
603# files or namespaces will be aligned in HTML using tables. If set to
604# NO a bullet list will be used.
605
606HTML_ALIGN_MEMBERS = YES
607
608# If the GENERATE_HTMLHELP tag is set to YES, additional index files
609# will be generated that can be used as input for tools like the
610# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
611# of the generated HTML documentation.
612
613GENERATE_HTMLHELP = YES
614
615# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
616# be used to specify the file name of the resulting .chm file. You
617# can add a path in front of the file if the result should not be
618# written to the html output directory.
619
620CHM_FILE = $(PATH_CHM)
621
622# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
623# be used to specify the location (absolute path including file name) of
624# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
625# the HTML help compiler on the generated index.hhp.
626
627HHC_LOCATION =
628
629# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
630# controls if a separate .chi index file is generated (YES) or that
631# it should be included in the master .chm file (NO).
632
633GENERATE_CHI = NO
634
635# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
636# controls whether a binary table of contents is generated (YES) or a
637# normal table of contents (NO) in the .chm file.
638
639BINARY_TOC = NO
640
641# The TOC_EXPAND flag can be set to YES to add extra items for group members
642# to the contents of the HTML help documentation and to the tree view.
643
644TOC_EXPAND = NO
645
646# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
647# top of each HTML page. The value NO (the default) enables the index and
648# the value YES disables it.
649
650DISABLE_INDEX = NO
651
652# This tag can be used to set the number of enum values (range [1..20])
653# that doxygen will group on one line in the generated HTML documentation.
654
655ENUM_VALUES_PER_LINE = 4
656
657# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
658# generated containing a tree-like index structure (just like the one that
659# is generated for HTML Help). For this to work a browser that supports
660# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
661# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
662# probably better off using the HTML help feature.
663
664GENERATE_TREEVIEW = NO
665
666# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
667# used to set the initial width (in pixels) of the frame in which the tree
668# is shown.
669
670TREEVIEW_WIDTH = 250
671
672#---------------------------------------------------------------------------
673# configuration options related to the LaTeX output
674#---------------------------------------------------------------------------
675
676# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
677# generate Latex output.
678
679GENERATE_LATEX = NO
680
681# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
682# If a relative path is entered the value of OUTPUT_DIRECTORY will be
683# put in front of it. If left blank `latex' will be used as the default path.
684
685LATEX_OUTPUT = latex
686
687# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
688# invoked. If left blank `latex' will be used as the default command name.
689
690LATEX_CMD_NAME = latex
691
692# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
693# generate index for LaTeX. If left blank `makeindex' will be used as the
694# default command name.
695
696MAKEINDEX_CMD_NAME = makeindex
697
698# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
699# LaTeX documents. This may be useful for small projects and may help to
700# save some trees in general.
701
702COMPACT_LATEX = NO
703
704# The PAPER_TYPE tag can be used to set the paper type that is used
705# by the printer. Possible values are: a4, a4wide, letter, legal and
706# executive. If left blank a4wide will be used.
707
708PAPER_TYPE = a4wide
709
710# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
711# packages that should be included in the LaTeX output.
712
713EXTRA_PACKAGES =
714
715# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
716# the generated latex document. The header should contain everything until
717# the first chapter. If it is left blank doxygen will generate a
718# standard header. Notice: only use this tag if you know what you are doing!
719
720LATEX_HEADER =
721
722# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
723# is prepared for conversion to pdf (using ps2pdf). The pdf file will
724# contain links (just like the HTML output) instead of page references
725# This makes the output suitable for online browsing using a pdf viewer.
726
727PDF_HYPERLINKS = NO
728
729# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
730# plain latex in the generated Makefile. Set this option to YES to get a
731# higher quality PDF documentation.
732
733USE_PDFLATEX = NO
734
735# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
736# command to the generated LaTeX files. This will instruct LaTeX to keep
737# running if errors occur, instead of asking the user for help.
738# This option is also used when generating formulas in HTML.
739
740LATEX_BATCHMODE = NO
741
742# If LATEX_HIDE_INDICES is set to YES then doxygen will not
743# include the index chapters (such as File Index, Compound Index, etc.)
744# in the output.
745
746LATEX_HIDE_INDICES = NO
747
748#---------------------------------------------------------------------------
749# configuration options related to the RTF output
750#---------------------------------------------------------------------------
751
752# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
753# The RTF output is optimized for Word 97 and may not look very pretty with
754# other RTF readers or editors.
755
756GENERATE_RTF = NO
757
758# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
759# If a relative path is entered the value of OUTPUT_DIRECTORY will be
760# put in front of it. If left blank `rtf' will be used as the default path.
761
762RTF_OUTPUT = rtf
763
764# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
765# RTF documents. This may be useful for small projects and may help to
766# save some trees in general.
767
768COMPACT_RTF = NO
769
770# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
771# will contain hyperlink fields. The RTF file will
772# contain links (just like the HTML output) instead of page references.
773# This makes the output suitable for online browsing using WORD or other
774# programs which support those fields.
775# Note: wordpad (write) and others do not support links.
776
777RTF_HYPERLINKS = NO
778
779# Load stylesheet definitions from file. Syntax is similar to doxygen's
780# config file, i.e. a series of assignments. You only have to provide
781# replacements, missing definitions are set to their default value.
782
783RTF_STYLESHEET_FILE =
784
785# Set optional variables used in the generation of an rtf document.
786# Syntax is similar to doxygen's config file.
787
788RTF_EXTENSIONS_FILE =
789
790#---------------------------------------------------------------------------
791# configuration options related to the man page output
792#---------------------------------------------------------------------------
793
794# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
795# generate man pages
796
797GENERATE_MAN = NO
798
799# The MAN_OUTPUT tag is used to specify where the man pages will be put.
800# If a relative path is entered the value of OUTPUT_DIRECTORY will be
801# put in front of it. If left blank `man' will be used as the default path.
802
803MAN_OUTPUT = man
804
805# The MAN_EXTENSION tag determines the extension that is added to
806# the generated man pages (default is the subroutine's section .3)
807
808MAN_EXTENSION = .3
809
810# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
811# then it will generate one additional man file for each entity
812# documented in the real man page(s). These additional files
813# only source the real man page, but without them the man command
814# would be unable to find the correct page. The default is NO.
815
816MAN_LINKS = NO
817
818#---------------------------------------------------------------------------
819# configuration options related to the XML output
820#---------------------------------------------------------------------------
821
822# If the GENERATE_XML tag is set to YES Doxygen will
823# generate an XML file that captures the structure of
824# the code including all documentation.
825
826GENERATE_XML = NO
827
828# The XML_OUTPUT tag is used to specify where the XML pages will be put.
829# If a relative path is entered the value of OUTPUT_DIRECTORY will be
830# put in front of it. If left blank `xml' will be used as the default path.
831
832XML_OUTPUT = xml
833
834# The XML_SCHEMA tag can be used to specify an XML schema,
835# which can be used by a validating XML parser to check the
836# syntax of the XML files.
837
838XML_SCHEMA =
839
840# The XML_DTD tag can be used to specify an XML DTD,
841# which can be used by a validating XML parser to check the
842# syntax of the XML files.
843
844XML_DTD =
845
846# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
847# dump the program listings (including syntax highlighting
848# and cross-referencing information) to the XML output. Note that
849# enabling this will significantly increase the size of the XML output.
850
851XML_PROGRAMLISTING = YES
852
853#---------------------------------------------------------------------------
854# configuration options for the AutoGen Definitions output
855#---------------------------------------------------------------------------
856
857# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
858# generate an AutoGen Definitions (see autogen.sf.net) file
859# that captures the structure of the code including all
860# documentation. Note that this feature is still experimental
861# and incomplete at the moment.
862
863GENERATE_AUTOGEN_DEF = NO
864
865#---------------------------------------------------------------------------
866# configuration options related to the Perl module output
867#---------------------------------------------------------------------------
868
869# If the GENERATE_PERLMOD tag is set to YES Doxygen will
870# generate a Perl module file that captures the structure of
871# the code including all documentation. Note that this
872# feature is still experimental and incomplete at the
873# moment.
874
875GENERATE_PERLMOD = NO
876
877# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
878# the necessary Makefile rules, Perl scripts and LaTeX code to be able
879# to generate PDF and DVI output from the Perl module output.
880
881PERLMOD_LATEX = NO
882
883# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
884# nicely formatted so it can be parsed by a human reader. This is useful
885# if you want to understand what is going on. On the other hand, if this
886# tag is set to NO the size of the Perl module output will be much smaller
887# and Perl will parse it just the same.
888
889PERLMOD_PRETTY = YES
890
891# The names of the make variables in the generated doxyrules.make file
892# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
893# This is useful so different doxyrules.make files included by the same
894# Makefile don't overwrite each other's variables.
895
896PERLMOD_MAKEVAR_PREFIX =
897
898#---------------------------------------------------------------------------
899# Configuration options related to the preprocessor
900#---------------------------------------------------------------------------
901
902# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
903# evaluate all C-preprocessor directives found in the sources and include
904# files.
905
906ENABLE_PREPROCESSING = YES
907
908# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
909# names in the source code. If set to NO (the default) only conditional
910# compilation will be performed. Macro expansion can be done in a controlled
911# way by setting EXPAND_ONLY_PREDEF to YES.
912
913MACRO_EXPANSION = YES
914
915# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
916# then the macro expansion is limited to the macros specified with the
917# PREDEFINED and EXPAND_AS_PREDEFINED tags.
918
919EXPAND_ONLY_PREDEF = YES
920
921# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
922# in the INCLUDE_PATH (see below) will be search if a #include is found.
923
924SEARCH_INCLUDES = YES
925
926# The INCLUDE_PATH tag can be used to specify one or more directories that
927# contain include files that are not input files but should be processed by
928# the preprocessor.
929
930INCLUDE_PATH = include
931
932# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
933# patterns (like *.h and *.hpp) to filter out the header-files in the
934# directories. If left blank, the patterns specified with FILE_PATTERNS will
935# be used.
936
937INCLUDE_FILE_PATTERNS =
938
939# The PREDEFINED tag can be used to specify one or more macro names that
940# are defined before the preprocessor is started (similar to the -D option of
941# gcc). The argument of the tag is a list of macros of the form: name
942# or name=definition (no spaces). If the definition and the = are
943# omitted =1 is assumed.
944
945PREDEFINED = __DOXYGEN__ __END_DECLS __BEGIN_DECLS
946
947# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
948# this tag can be used to specify a list of macro names that should be expanded.
949# The macro definition that is found in the sources will be used.
950# Use the PREDEFINED tag if you want to use a different macro definition.
951
952EXPAND_AS_DEFINED = \
953 GCTYPE \
954 DECLEXPORT \
955 DECLIMPORT \
956 DECLASM \
957 DECLASMTYPE \
958 DECLCALLBACK \
959 ASMINLINE \
960 VMMR3DECL \
961 VMMR0DECL \
962 VMMGCDECL \
963 VMMDECL \
964 DISDECL \
965 SUPR3DECL \
966 SUPR0DECL \
967 SUPDECL \
968 PDMR3DECL \
969 PDMR0DECL \
970 PDMGCDECL \
971 PDMDECL \
972 IOMR3DECL \
973 IOMR0DECL \
974 IOMGCDECL \
975 IOMDECL \
976 IDER3DECL \
977 IDER0DECL \
978 IDEGCDECL \
979 IDEDECL \
980 CFGMR3DECL \
981 CFGMR0DECL \
982 CFGMGCDECL \
983 CFGMDECL \
984 EMR3DECL \
985 EMR0DECL \
986 EMGCDECL \
987 EMDECL \
988 RTR3DECL \
989 RTR0DECL \
990 RTGCDECL \
991 RTDECL \
992 TRPMR3DECL \
993 TRPMR0DECL \
994 TRPMGCDECL \
995 TRPMDECL \
996 PGMR3DECL \
997 PGMR0DECL \
998 PGMGCDECL \
999 PGMDECL \
1000 MMR3DECL \
1001 MMR0DECL \
1002 MMGCDECL \
1003 MMDECL \
1004 SELMR3DECL \
1005 SELMR0DECL \
1006 SELMGCDECL \
1007 SELMDECL \
1008 PATMR3DECL \
1009 PATMR0DECL \
1010 PATMGCDECL \
1011 PATMDECL \
1012 STAMR3DECL \
1013 STAMR0DECL \
1014 STAMGCDECL \
1015 STAMDECL \
1016 VGAR3DECL \
1017 VGAR0DECL \
1018 VGAGCDECL \
1019 VGADECL \
1020 DBGFR3DECL \
1021 DBGFR0DECL \
1022 DBGFGCDECL \
1023 DBGFDECL \
1024 DBGCR3DECL \
1025 DBGR0DECL \
1026 DBGGCDECL \
1027 DBGDECL \
1028 CPUMR3DECL \
1029 CPUMR0DECL \
1030 CPUMGCDECL \
1031 CPUMDECL \
1032 VMDECL \
1033 VMR3DECL \
1034 VMR0DECL \
1035 VMGCDECL \
1036 VMDECL \
1037
1038
1039
1040# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1041# doxygen's preprocessor will remove all function-like macros that are alone
1042# on a line, have an all uppercase name, and do not end with a semicolon. Such
1043# function macros are typically used for boiler-plate code, and will confuse the
1044# parser if not removed.
1045
1046SKIP_FUNCTION_MACROS = YES
1047
1048#---------------------------------------------------------------------------
1049# Configuration::additions related to external references
1050#---------------------------------------------------------------------------
1051
1052# The TAGFILES option can be used to specify one or more tagfiles.
1053# Optionally an initial location of the external documentation
1054# can be added for each tagfile. The format of a tag file without
1055# this location is as follows:
1056# TAGFILES = file1 file2 ...
1057# Adding location for the tag files is done as follows:
1058# TAGFILES = file1=loc1 "file2 = loc2" ...
1059# where "loc1" and "loc2" can be relative or absolute paths or
1060# URLs. If a location is present for each tag, the installdox tool
1061# does not have to be run to correct the links.
1062# Note that each tag file must have a unique name
1063# (where the name does NOT include the path)
1064# If a tag file is not located in the directory in which doxygen
1065# is run, you must also specify the path to the tagfile here.
1066
1067TAGFILES =
1068
1069# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1070# a tag file that is based on the input files it reads.
1071
1072GENERATE_TAGFILE =
1073
1074# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1075# in the class index. If set to NO only the inherited external classes
1076# will be listed.
1077
1078ALLEXTERNALS = NO
1079
1080# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1081# in the modules index. If set to NO, only the current project's groups will
1082# be listed.
1083
1084EXTERNAL_GROUPS = YES
1085
1086# The PERL_PATH should be the absolute path and name of the perl script
1087# interpreter (i.e. the result of `which perl').
1088
1089PERL_PATH = /usr/bin/perl
1090
1091#---------------------------------------------------------------------------
1092# Configuration options related to the dot tool
1093#---------------------------------------------------------------------------
1094
1095# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1096# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1097# super classes. Setting the tag to NO turns the diagrams off. Note that this
1098# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1099# recommended to install and use dot, since it yields more powerful graphs.
1100
1101CLASS_DIAGRAMS = YES
1102
1103# If set to YES, the inheritance and collaboration graphs will hide
1104# inheritance and usage relations if the target is undocumented
1105# or is not a class.
1106
1107HIDE_UNDOC_RELATIONS = YES
1108
1109# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1110# available from the path. This tool is part of Graphviz, a graph visualization
1111# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1112# have no effect if this option is set to NO (the default)
1113
1114HAVE_DOT = NO
1115
1116# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1117# will generate a graph for each documented class showing the direct and
1118# indirect inheritance relations. Setting this tag to YES will force the
1119# the CLASS_DIAGRAMS tag to NO.
1120
1121CLASS_GRAPH = YES
1122
1123# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1124# will generate a graph for each documented class showing the direct and
1125# indirect implementation dependencies (inheritance, containment, and
1126# class references variables) of the class with other documented classes.
1127
1128COLLABORATION_GRAPH = YES
1129
1130# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1131# collaboration diagrams in a style similar to the OMG's Unified Modeling
1132# Language.
1133
1134UML_LOOK = YES
1135
1136# If set to YES, the inheritance and collaboration graphs will show the
1137# relations between templates and their instances.
1138
1139TEMPLATE_RELATIONS = YES
1140
1141# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1142# tags are set to YES then doxygen will generate a graph for each documented
1143# file showing the direct and indirect include dependencies of the file with
1144# other documented files.
1145
1146INCLUDE_GRAPH = YES
1147
1148# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1149# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1150# documented header file showing the documented files that directly or
1151# indirectly include this file.
1152
1153INCLUDED_BY_GRAPH = YES
1154
1155# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1156# generate a call dependency graph for every global function or class method.
1157# Note that enabling this option will significantly increase the time of a run.
1158# So in most cases it will be better to enable call graphs for selected
1159# functions only using the \callgraph command.
1160
1161CALL_GRAPH = YES
1162
1163# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1164# will graphical hierarchy of all classes instead of a textual one.
1165
1166GRAPHICAL_HIERARCHY = YES
1167
1168# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1169# generated by dot. Possible values are png, jpg, or gif
1170# If left blank png will be used.
1171
1172DOT_IMAGE_FORMAT = png
1173
1174# The tag DOT_PATH can be used to specify the path where the dot tool can be
1175# found. If left blank, it is assumed the dot tool can be found on the path.
1176
1177DOT_PATH =
1178
1179# The DOTFILE_DIRS tag can be used to specify one or more directories that
1180# contain dot files that are included in the documentation (see the
1181# \dotfile command).
1182
1183DOTFILE_DIRS =
1184
1185# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1186# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1187# this value, doxygen will try to truncate the graph, so that it fits within
1188# the specified constraint. Beware that most browsers cannot cope with very
1189# large images.
1190
1191MAX_DOT_GRAPH_WIDTH = 1024
1192
1193# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1194# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1195# this value, doxygen will try to truncate the graph, so that it fits within
1196# the specified constraint. Beware that most browsers cannot cope with very
1197# large images.
1198
1199MAX_DOT_GRAPH_HEIGHT = 1024
1200
1201# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1202# graphs generated by dot. A depth value of 3 means that only nodes reachable
1203# from the root by following a path via at most 3 edges will be shown. Nodes that
1204# lay further from the root node will be omitted. Note that setting this option to
1205# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1206# note that a graph may be further truncated if the graph's image dimensions are
1207# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1208# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1209
1210MAX_DOT_GRAPH_DEPTH = 0
1211
1212# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1213# generate a legend page explaining the meaning of the various boxes and
1214# arrows in the dot generated graphs.
1215
1216GENERATE_LEGEND = YES
1217
1218# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1219# remove the intermediate dot files that are used to generate
1220# the various graphs.
1221
1222DOT_CLEANUP = YES
1223
1224#---------------------------------------------------------------------------
1225# Configuration::additions related to the search engine
1226#---------------------------------------------------------------------------
1227
1228# The SEARCHENGINE tag specifies whether or not a search engine should be
1229# used. If set to NO the values of all tags below this one will be ignored.
1230
1231SEARCHENGINE = NO
Note: See TracBrowser for help on using the repository browser.

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