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