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