comparison 3rdparty/vmime/Doxyfile.in @ 0:a4671277546c tip

created the repository for the thymian project
author ferencd
date Tue, 17 Aug 2021 11:19:54 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:a4671277546c
1 #
2 # Doxygen settings for VMime
3 #
4 # All text after a hash (#) is considered a comment and will be ignored
5 # The format is:
6 # TAG = value [value, ...]
7 # For lists items can also be appended using:
8 # TAG += value [value, ...]
9 # Values that contain spaces should be placed between quotes (" ")
10 #
11
12 #---------------------------------------------------------------------------
13 # General configuration options
14 #---------------------------------------------------------------------------
15
16 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
17 # by quotes) that should identify the project.
18
19 PROJECT_NAME = VMime
20
21 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
22 # This could be handy for archiving the generated documentation or
23 # if some version control system is used.
24
25 PROJECT_NUMBER =
26
27 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
28 # base path where the generated documentation will be put.
29 # If a relative path is entered, it will be relative to the location
30 # where doxygen was started. If left blank the current directory will be used.
31
32 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc/
33
34 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
35 # documentation generated by doxygen is written. Doxygen will use this
36 # information to generate all constant output in the proper language.
37 # The default language is English, other supported languages are:
38 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
39 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
40 # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
41 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
42
43 OUTPUT_LANGUAGE = English
44
45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46 # documentation are documented, even if no documentation was available.
47 # Private class members and static file members will be hidden unless
48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50 EXTRACT_ALL = YES
51
52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53 # will be included in the documentation.
54
55 EXTRACT_PRIVATE = NO
56
57 # If the EXTRACT_STATIC tag is set to YES all static members of a file
58 # will be included in the documentation.
59
60 EXTRACT_STATIC = NO
61
62 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63 # defined locally in source files will be included in the documentation.
64 # If set to NO only classes defined in header files are included.
65
66 EXTRACT_LOCAL_CLASSES = NO
67
68 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69 # undocumented members of documented classes, files or namespaces.
70 # If set to NO (the default) these members will be included in the
71 # various overviews, but no documentation section is generated.
72 # This option has no effect if EXTRACT_ALL is enabled.
73
74 HIDE_UNDOC_MEMBERS = NO
75
76 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77 # undocumented classes that are normally visible in the class hierarchy.
78 # If set to NO (the default) these class will be included in the various
79 # overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81 HIDE_UNDOC_CLASSES = NO
82
83 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
84 # friend (class|struct|union) declarations.
85 # If set to NO (the default) these declarations will be included in the
86 # documentation.
87
88 HIDE_FRIEND_COMPOUNDS = YES
89
90 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
91 # documentation blocks found inside the body of a function.
92 # If set to NO (the default) these blocks will be appended to the
93 # function's detailed documentation block.
94
95 #HIDE_IN_BODY_DOCS = NO
96
97 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
98 # include brief member descriptions after the members that are listed in
99 # the file and class documentation (similar to JavaDoc).
100 # Set to NO to disable this.
101
102 BRIEF_MEMBER_DESC = NO
103
104 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
105 # the brief description of a member or function before the detailed description.
106 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 # brief descriptions will be completely suppressed.
108
109 REPEAT_BRIEF = YES
110
111 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
112 # Doxygen will generate a detailed section even if there is only a brief
113 # description.
114
115 ALWAYS_DETAILED_SEC = NO
116
117 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
118 # members of a class in the documentation of that class as if those members were
119 # ordinary class members. Constructors, destructors and assignment operators of
120 # the base classes will not be shown.
121
122 INLINE_INHERITED_MEMB = NO
123
124 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
125 # path before files name in the file list and in the header files. If set
126 # to NO the shortest path that makes the file name unique will be used.
127
128 FULL_PATH_NAMES = NO
129
130 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
131 # can be used to strip a user defined part of the path. Stripping is
132 # only done if one of the specified strings matches the left-hand part of
133 # the path. It is allowed to use relative paths in the argument list.
134
135 STRIP_FROM_PATH =
136
137 # The INTERNAL_DOCS tag determines if documentation
138 # that is typed after a \internal command is included. If the tag is set
139 # to NO (the default) then the documentation will be excluded.
140 # Set it to YES to include the internal documentation.
141
142 INTERNAL_DOCS = NO
143
144 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
145 # file names in lower case letters. If set to YES upper case letters are also
146 # allowed. This is useful if you have classes or files whose names only differ
147 # in case and if your file system supports case sensitive file names. Windows
148 # users are adviced to set this option to NO.
149
150 CASE_SENSE_NAMES = YES
151
152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
153 # (but less readable) file names. This can be useful is your file systems
154 # doesn't support long names like on DOS, Mac, or CD-ROM.
155
156 SHORT_NAMES = NO
157
158 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
159 # will show members with their full class and namespace scopes in the
160 # documentation. If set to YES the scope will be hidden.
161
162 HIDE_SCOPE_NAMES = YES
163
164 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
165 # will generate a verbatim copy of the header file for each class for
166 # which an include is specified. Set to NO to disable this.
167
168 VERBATIM_HEADERS = NO
169
170 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
171 # will put list of the files that are included by a file in the documentation
172 # of that file.
173
174 SHOW_INCLUDE_FILES = NO
175
176 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
177 # will interpret the first line (until the first dot) of a JavaDoc-style
178 # comment as the brief description. If set to NO, the JavaDoc
179 # comments will behave just like the Qt-style comments (thus requiring an
180 # explict @brief command for a brief description.
181
182 JAVADOC_AUTOBRIEF = YES
183
184 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
185 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
186 # comments) as a brief description. This used to be the default behaviour.
187 # The new default is to treat a multi-line C++ comment block as a detailed
188 # description. Set this tag to YES if you prefer the old behaviour instead.
189
190 MULTILINE_CPP_IS_BRIEF = NO
191
192 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
193 # will output the detailed description near the top, like JavaDoc.
194 # If set to NO, the detailed description appears after the member
195 # documentation.
196
197 DETAILS_AT_TOP = NO
198
199 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
200 # member inherits the documentation from any documented member that it
201 # reimplements.
202
203 INHERIT_DOCS = YES
204
205 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
206 # is inserted in the documentation for inline members.
207
208 INLINE_INFO = NO
209
210 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
211 # will sort the (detailed) documentation of file and class members
212 # alphabetically by member name. If set to NO the members will appear in
213 # declaration order.
214
215 SORT_MEMBER_DOCS = YES
216
217 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
218 # tag is set to YES, then doxygen will reuse the documentation of the first
219 # member in the group (if any) for the other members of the group. By default
220 # all members of a group must be documented explicitly.
221
222 DISTRIBUTE_GROUP_DOC = NO
223
224 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
225 # Doxygen uses this value to replace tabs by spaces in code fragments.
226
227 TAB_SIZE = 4
228
229 # The GENERATE_TODOLIST tag can be used to enable (YES) or
230 # disable (NO) the todo list. This list is created by putting \todo
231 # commands in the documentation.
232
233 GENERATE_TODOLIST = YES
234
235 # The GENERATE_TESTLIST tag can be used to enable (YES) or
236 # disable (NO) the test list. This list is created by putting \test
237 # commands in the documentation.
238
239 GENERATE_TESTLIST = YES
240
241 # The GENERATE_BUGLIST tag can be used to enable (YES) or
242 # disable (NO) the bug list. This list is created by putting \bug
243 # commands in the documentation.
244
245 GENERATE_BUGLIST = YES
246
247 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
248 # disable (NO) the deprecated list. This list is created by putting
249 # \deprecated commands in the documentation.
250
251 GENERATE_DEPRECATEDLIST= YES
252
253 # This tag can be used to specify a number of aliases that acts
254 # as commands in the documentation. An alias has the form "name=value".
255 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
256 # put the command \sideeffect (or @sideeffect) in the documentation, which
257 # will result in a user defined paragraph with heading "Side Effects:".
258 # You can put \n's in the value part of an alias to insert newlines.
259
260 ALIASES =
261
262 # The ENABLED_SECTIONS tag can be used to enable conditional
263 # documentation sections, marked by \if sectionname ... \endif.
264
265 ENABLED_SECTIONS =
266
267 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
268 # the initial value of a variable or define consist of for it to appear in
269 # the documentation. If the initializer consists of more lines than specified
270 # here it will be hidden. Use a value of 0 to hide initializers completely.
271 # The appearance of the initializer of individual variables and defines in the
272 # documentation can be controlled using \showinitializer or \hideinitializer
273 # command in the documentation regardless of this setting.
274
275 MAX_INITIALIZER_LINES = 30
276
277 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
278 # only. Doxygen will then generate output that is more tailored for C.
279 # For instance some of the names that are used will be different. The list
280 # of all members will be omitted, etc.
281
282 OPTIMIZE_OUTPUT_FOR_C = NO
283
284 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
285 # only. Doxygen will then generate output that is more tailored for Java.
286 # For instance namespaces will be presented as packages, qualified scopes
287 # will look different, etc.
288
289 OPTIMIZE_OUTPUT_JAVA = NO
290
291 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
292 # at the bottom of the documentation of classes and structs. If set to YES the
293 # list will mention the files that were used to generate the documentation.
294
295 SHOW_USED_FILES = YES
296
297 #---------------------------------------------------------------------------
298 # configuration options related to warning and progress messages
299 #---------------------------------------------------------------------------
300
301 # The QUIET tag can be used to turn on/off the messages that are generated
302 # by doxygen. Possible values are YES and NO. If left blank NO is used.
303
304 QUIET = YES
305
306 # The WARNINGS tag can be used to turn on/off the warning messages that are
307 # generated by doxygen. Possible values are YES and NO. If left blank
308 # NO is used.
309
310 WARNINGS = YES
311
312 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
313 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
314 # automatically be disabled.
315
316 WARN_IF_UNDOCUMENTED = YES
317
318 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
319 # potential errors in the documentation, such as not documenting some
320 # parameters in a documented function, or documenting parameters that
321 # don't exist or using markup commands wrongly.
322
323 #WARN_IF_DOC_ERROR = YES
324
325 # The WARN_FORMAT tag determines the format of the warning messages that
326 # doxygen can produce. The string should contain the $file, $line, and $text
327 # tags, which will be replaced by the file and line number from which the
328 # warning originated and the warning text.
329
330 WARN_FORMAT = "$file:$line: $text"
331
332 # The WARN_LOGFILE tag can be used to specify a file to which warning
333 # and error messages should be written. If left blank the output is written
334 # to stderr.
335
336 WARN_LOGFILE =
337
338 #---------------------------------------------------------------------------
339 # configuration options related to the input files
340 #---------------------------------------------------------------------------
341
342 # The INPUT tag can be used to specify the files and/or directories that contain
343 # documented source files. You may enter file names like "myfile.cpp" or
344 # directories like "/usr/src/myproject". Separate the files or directories
345 # with spaces.
346
347 INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/vmime/
348
349 # If the value of the INPUT tag contains directories, you can use the
350 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
351 # and *.h) to filter out the source-files in the directories. If left
352 # blank the following patterns are tested:
353 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
354 # *.h++ *.idl *.odl
355
356 FILE_PATTERNS =
357
358 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
359 # should be searched for input files as well. Possible values are YES and NO.
360 # If left blank NO is used.
361
362 RECURSIVE = YES
363
364 # The EXCLUDE tag can be used to specify files and/or directories that should
365 # excluded from the INPUT source files. This way you can easily exclude a
366 # subdirectory from a directory tree whose root is specified with the INPUT tag.
367
368 EXCLUDE =
369
370 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
371 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
372
373 EXCLUDE_SYMLINKS = NO
374
375 # If the value of the INPUT tag contains directories, you can use the
376 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
377 # certain files from those directories.
378
379 EXCLUDE_PATTERNS = */config.hpp */IMAPTag* */IMAPParser* */IMAPUtils* */IMAPConnection* */md5* */smartPtr* */authHelper* */maildirUtils*
380
381 # The EXAMPLE_PATH tag can be used to specify one or more files or
382 # directories that contain example code fragments that are included (see
383 # the \include command).
384
385 EXAMPLE_PATH =
386
387 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
388 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
389 # and *.h) to filter out the source-files in the directories. If left
390 # blank all files are included.
391
392 EXAMPLE_PATTERNS =
393
394 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
395 # searched for input files to be used with the \include or \dontinclude
396 # commands irrespective of the value of the RECURSIVE tag.
397 # Possible values are YES and NO. If left blank NO is used.
398
399 EXAMPLE_RECURSIVE = NO
400
401 # The IMAGE_PATH tag can be used to specify one or more files or
402 # directories that contain image that are included in the documentation (see
403 # the \image command).
404
405 IMAGE_PATH =
406
407 # The INPUT_FILTER tag can be used to specify a program that doxygen should
408 # invoke to filter for each input file. Doxygen will invoke the filter program
409 # by executing (via popen()) the command <filter> <input-file>, where <filter>
410 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
411 # input file. Doxygen will then use the output that the filter program writes
412 # to standard output.
413
414 INPUT_FILTER =
415
416 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
417 # INPUT_FILTER) will be used to filter the input files when producing source
418 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
419
420 FILTER_SOURCE_FILES = NO
421
422 #---------------------------------------------------------------------------
423 # configuration options related to source browsing
424 #---------------------------------------------------------------------------
425
426 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
427 # be generated. Documented entities will be cross-referenced with these sources.
428
429 SOURCE_BROWSER = NO
430 # YES --> sources visibles
431
432 # Setting the INLINE_SOURCES tag to YES will include the body
433 # of functions and classes directly in the documentation.
434
435 INLINE_SOURCES = NO
436
437 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
438 # doxygen to hide any special comment blocks from generated source code
439 # fragments. Normal C and C++ comments will always remain visible.
440
441 STRIP_CODE_COMMENTS = YES
442
443 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
444 # then for each documented function all documented
445 # functions referencing it will be listed.
446
447 REFERENCED_BY_RELATION = YES
448
449 # If the REFERENCES_RELATION tag is set to YES (the default)
450 # then for each documented function all documented entities
451 # called/used by that function will be listed.
452
453 REFERENCES_RELATION = YES
454
455 #---------------------------------------------------------------------------
456 # configuration options related to the alphabetical class index
457 #---------------------------------------------------------------------------
458
459 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
460 # of all compounds will be generated. Enable this if the project
461 # contains a lot of classes, structs, unions or interfaces.
462
463 ALPHABETICAL_INDEX = YES
464
465 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
466 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
467 # in which this list will be split (can be a number in the range [1..20])
468
469 COLS_IN_ALPHA_INDEX = 1
470
471 # In case all classes in a project start with a common prefix, all
472 # classes will be put under the same header in the alphabetical index.
473 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
474 # should be ignored while generating the index headers.
475
476 IGNORE_PREFIX =
477
478 #---------------------------------------------------------------------------
479 # configuration options related to the HTML output
480 #---------------------------------------------------------------------------
481
482 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
483 # generate HTML output.
484
485 GENERATE_HTML = YES
486
487 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
488 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
489 # put in front of it. If left blank `html' will be used as the default path.
490
491 HTML_OUTPUT = html
492
493 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
494 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
495 # doxygen will generate files with .html extension.
496
497 HTML_FILE_EXTENSION = .html
498
499 # The HTML_HEADER tag can be used to specify a personal HTML header for
500 # each generated HTML page. If it is left blank doxygen will generate a
501 # standard header.
502
503 HTML_HEADER =
504
505 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
506 # each generated HTML page. If it is left blank doxygen will generate a
507 # standard footer.
508
509 HTML_FOOTER =
510
511 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
512 # style sheet that is used by each HTML page. It can be used to
513 # fine-tune the look of the HTML output. If the tag is left blank doxygen
514 # will generate a default style sheet
515
516 HTML_STYLESHEET =
517
518 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
519 # files or namespaces will be aligned in HTML using tables. If set to
520 # NO a bullet list will be used.
521
522 HTML_ALIGN_MEMBERS = YES
523
524 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
525 # will be generated that can be used as input for tools like the
526 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
527 # of the generated HTML documentation.
528
529 GENERATE_HTMLHELP = NO
530
531 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
532 # be used to specify the file name of the resulting .chm file. You
533 # can add a path in front of the file if the result should not be
534 # written to the html output dir.
535
536 CHM_FILE =
537
538 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
539 # be used to specify the location (absolute path including file name) of
540 # the HTML help compiler (hhc.exe). If non empty doxygen will try to run
541 # the html help compiler on the generated index.hhp.
542
543 HHC_LOCATION =
544
545 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
546 # controls if a separate .chi index file is generated (YES) or that
547 # it should be included in the master .chm file (NO).
548
549 GENERATE_CHI = NO
550
551 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
552 # controls whether a binary table of contents is generated (YES) or a
553 # normal table of contents (NO) in the .chm file.
554
555 BINARY_TOC = NO
556
557 # The TOC_EXPAND flag can be set to YES to add extra items for group members
558 # to the contents of the Html help documentation and to the tree view.
559
560 TOC_EXPAND = NO
561
562 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
563 # top of each HTML page. The value NO (the default) enables the index and
564 # the value YES disables it.
565
566 DISABLE_INDEX = NO
567
568 # This tag can be used to set the number of enum values (range [1..20])
569 # that doxygen will group on one line in the generated HTML documentation.
570
571 ENUM_VALUES_PER_LINE = 4
572
573 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
574 # generated containing a tree-like index structure (just like the one that
575 # is generated for HTML Help). For this to work a browser that supports
576 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
577 # or Internet explorer 4.0+). Note that for large projects the tree generation
578 # can take a very long time. In such cases it is better to disable this feature.
579 # Windows users are probably better off using the HTML help feature.
580
581 GENERATE_TREEVIEW = YES
582
583 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
584 # used to set the initial width (in pixels) of the frame in which the tree
585 # is shown.
586
587 TREEVIEW_WIDTH = 300
588
589 #---------------------------------------------------------------------------
590 # configuration options related to the LaTeX output
591 #---------------------------------------------------------------------------
592
593 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
594 # generate Latex output.
595
596 GENERATE_LATEX = NO
597
598 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
599 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
600 # put in front of it. If left blank `latex' will be used as the default path.
601
602 LATEX_OUTPUT = latex
603
604 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
605 # invoked. If left blank `latex' will be used as the default command name.
606
607 LATEX_CMD_NAME = latex
608
609 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
610 # generate index for LaTeX. If left blank `makeindex' will be used as the
611 # default command name.
612
613 MAKEINDEX_CMD_NAME = makeindex
614
615 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
616 # LaTeX documents. This may be useful for small projects and may help to
617 # save some trees in general.
618
619 COMPACT_LATEX = NO
620
621 # The PAPER_TYPE tag can be used to set the paper type that is used
622 # by the printer. Possible values are: a4, a4wide, letter, legal and
623 # executive. If left blank a4wide will be used.
624
625 PAPER_TYPE = a4wide
626
627 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
628 # packages that should be included in the LaTeX output.
629
630 EXTRA_PACKAGES =
631
632 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
633 # the generated latex document. The header should contain everything until
634 # the first chapter. If it is left blank doxygen will generate a
635 # standard header. Notice: only use this tag if you know what you are doing!
636
637 LATEX_HEADER =
638
639 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
640 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
641 # contain links (just like the HTML output) instead of page references
642 # This makes the output suitable for online browsing using a pdf viewer.
643
644 PDF_HYPERLINKS = NO
645
646 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
647 # plain latex in the generated Makefile. Set this option to YES to get a
648 # higher quality PDF documentation.
649
650 USE_PDFLATEX = NO
651
652 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
653 # command to the generated LaTeX files. This will instruct LaTeX to keep
654 # running if errors occur, instead of asking the user for help.
655 # This option is also used when generating formulas in HTML.
656
657 LATEX_BATCHMODE = NO
658
659 #---------------------------------------------------------------------------
660 # configuration options related to the RTF output
661 #---------------------------------------------------------------------------
662
663 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
664 # The RTF output is optimised for Word 97 and may not look very pretty with
665 # other RTF readers or editors.
666
667 GENERATE_RTF = NO
668
669 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
670 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
671 # put in front of it. If left blank `rtf' will be used as the default path.
672
673 RTF_OUTPUT = rtf
674
675 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
676 # RTF documents. This may be useful for small projects and may help to
677 # save some trees in general.
678
679 COMPACT_RTF = NO
680
681 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
682 # will contain hyperlink fields. The RTF file will
683 # contain links (just like the HTML output) instead of page references.
684 # This makes the output suitable for online browsing using WORD or other
685 # programs which support those fields.
686 # Note: wordpad (write) and others do not support links.
687
688 RTF_HYPERLINKS = NO
689
690 # Load stylesheet definitions from file. Syntax is similar to doxygen's
691 # config file, i.e. a series of assigments. You only have to provide
692 # replacements, missing definitions are set to their default value.
693
694 RTF_STYLESHEET_FILE =
695
696 # Set optional variables used in the generation of an rtf document.
697 # Syntax is similar to doxygen's config file.
698
699 RTF_EXTENSIONS_FILE =
700
701 #---------------------------------------------------------------------------
702 # configuration options related to the man page output
703 #---------------------------------------------------------------------------
704
705 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
706 # generate man pages
707
708 GENERATE_MAN = NO
709
710 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
711 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
712 # put in front of it. If left blank `man' will be used as the default path.
713
714 MAN_OUTPUT = man
715
716 # The MAN_EXTENSION tag determines the extension that is added to
717 # the generated man pages (default is the subroutine's section .3)
718
719 MAN_EXTENSION = .3
720
721 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
722 # then it will generate one additional man file for each entity
723 # documented in the real man page(s). These additional files
724 # only source the real man page, but without them the man command
725 # would be unable to find the correct page. The default is NO.
726
727 MAN_LINKS = NO
728
729 #---------------------------------------------------------------------------
730 # configuration options related to the XML output
731 #---------------------------------------------------------------------------
732
733 # If the GENERATE_XML tag is set to YES Doxygen will
734 # generate an XML file that captures the structure of
735 # the code including all documentation. Note that this
736 # feature is still experimental and incomplete at the
737 # moment.
738
739 GENERATE_XML = NO
740
741 # The XML_SCHEMA tag can be used to specify an XML schema,
742 # which can be used by a validating XML parser to check the
743 # syntax of the XML files.
744
745 XML_SCHEMA =
746
747 # The XML_DTD tag can be used to specify an XML DTD,
748 # which can be used by a validating XML parser to check the
749 # syntax of the XML files.
750
751 XML_DTD =
752
753 #---------------------------------------------------------------------------
754 # configuration options for the AutoGen Definitions output
755 #---------------------------------------------------------------------------
756
757 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
758 # generate an AutoGen Definitions (see autogen.sf.net) file
759 # that captures the structure of the code including all
760 # documentation. Note that this feature is still experimental
761 # and incomplete at the moment.
762
763 GENERATE_AUTOGEN_DEF = NO
764
765 #---------------------------------------------------------------------------
766 # configuration options related to the Perl module output
767 #---------------------------------------------------------------------------
768
769 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
770 # generate a Perl module file that captures the structure of
771 # the code including all documentation. Note that this
772 # feature is still experimental and incomplete at the
773 # moment.
774
775 #GENERATE_PERLMOD = NO
776
777 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
778 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
779 # to generate PDF and DVI output from the Perl module output.
780
781 #PERLMOD_LATEX = NO
782
783 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
784 # nicely formatted so it can be parsed by a human reader. This is useful
785 # if you want to understand what is going on. On the other hand, if this
786 # tag is set to NO the size of the Perl module output will be much smaller
787 # and Perl will parse it just the same.
788
789 #PERLMOD_PRETTY = YES
790
791 # The names of the make variables in the generated doxyrules.make file
792 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
793 # This is useful so different doxyrules.make files included by the same
794 # Makefile don't overwrite each other's variables.
795
796 #PERLMOD_MAKEVAR_PREFIX =
797
798 #---------------------------------------------------------------------------
799 # Configuration options related to the preprocessor
800 #---------------------------------------------------------------------------
801
802 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
803 # evaluate all C-preprocessor directives found in the sources and include
804 # files.
805
806 ENABLE_PREPROCESSING = YES
807
808 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
809 # names in the source code. If set to NO (the default) only conditional
810 # compilation will be performed. Macro expansion can be done in a controlled
811 # way by setting EXPAND_ONLY_PREDEF to YES.
812
813 MACRO_EXPANSION = YES
814
815 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
816 # then the macro expansion is limited to the macros specified with the
817 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
818
819 EXPAND_ONLY_PREDEF = NO
820
821 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
822 # in the INCLUDE_PATH (see below) will be search if a #include is found.
823
824 SEARCH_INCLUDES = YES
825
826 # The INCLUDE_PATH tag can be used to specify one or more directories that
827 # contain include files that are not input files but should be processed by
828 # the preprocessor.
829
830 INCLUDE_PATH =
831
832 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
833 # patterns (like *.h and *.hpp) to filter out the header-files in the
834 # directories. If left blank, the patterns specified with FILE_PATTERNS will
835 # be used.
836
837 INCLUDE_FILE_PATTERNS =
838
839 # The PREDEFINED tag can be used to specify one or more macro names that
840 # are defined before the preprocessor is started (similar to the -D option of
841 # gcc). The argument of the tag is a list of macros of the form: name
842 # or name=definition (no spaces). If the definition and the = are
843 # omitted =1 is assumed.
844
845 PREDEFINED = VMIME_BUILDING_DOC VMIME_HAVE_SASL_SUPPORT VMIME_HAVE_TLS_SUPPORT VMIME_HAVE_FILESYSTEM_FEATURES VMIME_HAVE_MESSAGING_FEATURES VMIME_HAVE_MESSAGING_PROTO_POP3 VMIME_HAVE_MESSAGING_PROTO_SMTP VMIME_HAVE_MESSAGING_PROTO_IMAP VMIME_HAVE_MESSAGING_PROTO_MAILDIR VMIME_HAVE_MESSAGING_PROTO_SENDMAIL
846
847 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
848 # this tag can be used to specify a list of macro names that should be expanded.
849 # The macro definition that is found in the sources will be used.
850 # Use the PREDEFINED tag if you want to use a different macro definition.
851
852 EXPAND_AS_DEFINED =
853
854 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
855 # doxygen's preprocessor will remove all function-like macros that are alone
856 # on a line, have an all uppercase name, and do not end with a semicolon. Such
857 # function macros are typically used for boiler-plate code, and will confuse the
858 # parser if not removed.
859
860 SKIP_FUNCTION_MACROS = YES
861
862 #---------------------------------------------------------------------------
863 # Configuration::addtions related to external references
864 #---------------------------------------------------------------------------
865
866 # The TAGFILES tag can be used to specify one or more tagfiles.
867
868 TAGFILES =
869
870 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
871 # a tag file that is based on the input files it reads.
872
873 GENERATE_TAGFILE =
874
875 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
876 # in the class index. If set to NO only the inherited external classes
877 # will be listed.
878
879 ALLEXTERNALS = NO
880
881 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
882 # in the modules index. If set to NO, only the current project's groups will
883 # be listed.
884
885 EXTERNAL_GROUPS = YES
886
887 # The PERL_PATH should be the absolute path and name of the perl script
888 # interpreter (i.e. the result of `which perl').
889
890 PERL_PATH = /usr/bin/perl
891
892 #---------------------------------------------------------------------------
893 # Configuration options related to the dot tool
894 #---------------------------------------------------------------------------
895
896 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
897 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
898 # super classes. Setting the tag to NO turns the diagrams off. Note that this
899 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
900 # recommended to install and use dot, since it yield more powerful graphs.
901
902 CLASS_DIAGRAMS = YES
903
904 # If set to YES, the inheritance and collaboration graphs will hide
905 # inheritance and usage relations if the target is undocumented
906 # or is not a class.
907
908 HIDE_UNDOC_RELATIONS = YES
909
910 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
911 # available from the path. This tool is part of Graphviz, a graph visualization
912 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
913 # have no effect if this option is set to NO (the default)
914
915 HAVE_DOT = YES
916
917 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
918 # will generate a graph for each documented class showing the direct and
919 # indirect inheritance relations. Setting this tag to YES will force the
920 # the CLASS_DIAGRAMS tag to NO.
921
922 CLASS_GRAPH = YES
923
924 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
925 # will generate a graph for each documented class showing the direct and
926 # indirect implementation dependencies (inheritance, containment, and
927 # class references variables) of the class with other documented classes.
928
929 COLLABORATION_GRAPH = YES
930
931 # If set to YES, the inheritance and collaboration graphs will show the
932 # relations between templates and their instances.
933
934 TEMPLATE_RELATIONS = YES
935
936 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
937 # tags are set to YES then doxygen will generate a graph for each documented
938 # file showing the direct and indirect include dependencies of the file with
939 # other documented files.
940
941 INCLUDE_GRAPH = YES
942
943 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
944 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
945 # documented header file showing the documented files that directly or
946 # indirectly include this file.
947
948 INCLUDED_BY_GRAPH = YES
949
950 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
951 # will graphical hierarchy of all classes instead of a textual one.
952
953 GRAPHICAL_HIERARCHY = YES
954
955 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
956 # generated by dot. Possible values are png, jpg, or gif
957 # If left blank png will be used.
958
959 DOT_IMAGE_FORMAT = png
960
961 # The tag DOT_PATH can be used to specify the path where the dot tool can be
962 # found. If left blank, it is assumed the dot tool can be found on the path.
963
964 DOT_PATH =
965
966 # The DOTFILE_DIRS tag can be used to specify one or more directories that
967 # contain dot files that are included in the documentation (see the
968 # \dotfile command).
969
970 DOTFILE_DIRS =
971
972 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
973 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
974 # this value, doxygen will try to truncate the graph, so that it fits within
975 # the specified constraint. Beware that most browsers cannot cope with very
976 # large images.
977
978 MAX_DOT_GRAPH_WIDTH = 1024
979
980 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
981 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
982 # this value, doxygen will try to truncate the graph, so that it fits within
983 # the specified constraint. Beware that most browsers cannot cope with very
984 # large images.
985
986 MAX_DOT_GRAPH_HEIGHT = 1024
987
988 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
989 # generate a legend page explaining the meaning of the various boxes and
990 # arrows in the dot generated graphs.
991
992 GENERATE_LEGEND = YES
993
994 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
995 # remove the intermedate dot files that are used to generate
996 # the various graphs.
997
998 DOT_CLEANUP = YES
999
1000 #---------------------------------------------------------------------------
1001 # Configuration::addtions related to the search engine
1002 #---------------------------------------------------------------------------
1003
1004 # The SEARCHENGINE tag specifies whether or not a search engine should be
1005 # used. If set to NO the values of all tags below this one will be ignored.
1006
1007 SEARCHENGINE = NO
1008
1009 # The CGI_NAME tag should be the name of the CGI script that
1010 # starts the search engine (doxysearch) with the correct parameters.
1011 # A script with this name will be generated by doxygen.
1012
1013 #CGI_NAME = search.cgi
1014
1015 # The CGI_URL tag should be the absolute URL to the directory where the
1016 # cgi binaries are located. See the documentation of your http daemon for
1017 # details.
1018
1019 #CGI_URL =
1020
1021 # The DOC_URL tag should be the absolute URL to the directory where the
1022 # documentation is located. If left blank the absolute path to the
1023 # documentation, with file:// prepended to it, will be used.
1024
1025 #DOC_URL =
1026
1027 # The DOC_ABSPATH tag should be the absolute path to the directory where the
1028 # documentation is located. If left blank the directory on the local machine
1029 # will be used.
1030
1031 #DOC_ABSPATH =
1032
1033 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1034 # is installed.
1035
1036 #BIN_ABSPATH = /usr/local/bin/
1037
1038 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
1039 # documentation generated for other projects. This allows doxysearch to search
1040 # the documentation for these projects as well.
1041
1042 #EXT_DOC_PATHS =
1043