annotate Doxyfile @ 146:032877e14560

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