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