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