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