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