← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/fetchmail/oneiric

« back to all changes in this revision

Viewing changes to Doxyfile

  • Committer: Bazaar Package Importer
  • Author(s): Artur Rona
  • Date: 2010-07-25 03:17:28 UTC
  • mfrom: (0.1.11 sid)
  • Revision ID: james.westby@ubuntu.com-20100725031728-mm78sfgx9d656h9r
Tags: 6.3.17-4ubuntu1
https://launchpad.net/bugs/609634
* Merge from Debian unstable, remaining changes: (LP: #609634)
  - debian/init, debian/fetchmail.postinst: don't stop fetchmail in
    runlevels [06], the default 'killall' handler should be sufficient
    because fetchmail writes are properly completed before telling the
    server it's ok to delete.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Doxyfile
1
 
# Doxyfile 1.5.3
 
1
# Doxyfile 1.6.3
2
2
 
3
3
# This file describes the settings to be used by the documentation system
4
4
# doxygen (www.doxygen.org) for a project
14
14
# Project related configuration options
15
15
#---------------------------------------------------------------------------
16
16
 
17
 
# This tag specifies the encoding used for all characters in the config file that 
18
 
# follow. The default is UTF-8 which is also the encoding used for all text before 
19
 
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
20
 
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
21
 
# possible encodings.
 
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
22
 
23
23
DOXYFILE_ENCODING      = UTF-8
24
24
 
54
54
# information to generate all constant output in the proper language. 
55
55
# The default language is English, other supported languages are: 
56
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
57
 
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
58
 
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
59
 
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
60
 
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
 
57
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
 
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
 
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
 
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 
 
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
61
62
 
62
63
OUTPUT_LANGUAGE        = English
63
64
 
154
155
 
155
156
MULTILINE_CPP_IS_BRIEF = NO
156
157
 
157
 
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
158
 
# will output the detailed description near the top, like JavaDoc.
159
 
# If set to NO, the detailed description appears after the member 
160
 
# documentation.
161
 
 
162
 
DETAILS_AT_TOP         = NO
163
 
 
164
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
165
159
# member inherits the documentation from any documented member that it 
166
160
# re-implements.
195
189
OPTIMIZE_OUTPUT_FOR_C  = YES
196
190
 
197
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
198
 
# sources only. Doxygen will then generate output that is more tailored for Java. 
199
 
# For instance, namespaces will be presented as packages, qualified scopes 
200
 
# will look different, etc.
 
192
# sources only. Doxygen will then generate output that is more tailored for 
 
193
# Java. For instance, namespaces will be presented as packages, qualified 
 
194
# scopes will look different, etc.
201
195
 
202
196
OPTIMIZE_OUTPUT_JAVA   = NO
203
197
 
204
 
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
205
 
# include (a tag file for) the STL sources as input, then you should 
 
198
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
 
199
# sources only. Doxygen will then generate output that is more tailored for 
 
200
# Fortran.
 
201
 
 
202
OPTIMIZE_FOR_FORTRAN   = NO
 
203
 
 
204
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
 
205
# sources. Doxygen will then generate output that is tailored for 
 
206
# VHDL.
 
207
 
 
208
OPTIMIZE_OUTPUT_VHDL   = NO
 
209
 
 
210
# Doxygen selects the parser to use depending on the extension of the files it parses. 
 
211
# With this tag you can assign which parser to use for a given extension. 
 
212
# Doxygen has a built-in mapping, but you can override or extend it using this tag. 
 
213
# The format is ext=language, where ext is a file extension, and language is one of 
 
214
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 
 
215
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 
 
216
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 
 
217
# use: inc=Fortran f=C. Note that for custom extensions you also need to set
 
218
# FILE_PATTERNS otherwise the files are not read by doxygen.
 
219
 
 
220
EXTENSION_MAPPING      = 
 
221
 
 
222
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
 
223
# to include (a tag file for) the STL sources as input, then you should 
206
224
# set this tag to YES in order to let doxygen match functions declarations and 
207
225
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
208
226
# func(std::string) {}). This also make the inheritance and collaboration 
210
228
 
211
229
BUILTIN_STL_SUPPORT    = NO
212
230
 
213
 
# If you use Microsoft's C++/CLI language, you should set this option to YES to
 
231
# If you use Microsoft's C++/CLI language, you should set this option to YES to 
214
232
# enable parsing support.
215
233
 
216
234
CPP_CLI_SUPPORT        = NO
217
235
 
 
236
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
 
237
# Doxygen will parse them like normal C++ but will assume all classes use public 
 
238
# instead of private inheritance when no explicit protection keyword is present.
 
239
 
 
240
SIP_SUPPORT            = NO
 
241
 
 
242
# For Microsoft's IDL there are propget and propput attributes to indicate getter 
 
243
# and setter methods for a property. Setting this option to YES (the default) 
 
244
# will make doxygen to replace the get and set methods by a property in the 
 
245
# documentation. This will only work if the methods are indeed getting or 
 
246
# setting a simple type. If this is not the case, or you want to show the 
 
247
# methods anyway, you should set this option to NO.
 
248
 
 
249
IDL_PROPERTY_SUPPORT   = YES
 
250
 
218
251
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
219
252
# tag is set to YES, then doxygen will reuse the documentation of the first 
220
253
# member in the group (if any) for the other members of the group. By default 
230
263
 
231
264
SUBGROUPING            = YES
232
265
 
 
266
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
 
267
# is documented as struct, union, or enum with the name of the typedef. So 
 
268
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
 
269
# with name TypeT. When disabled the typedef will appear as a member of a file, 
 
270
# namespace, or class. And the struct will be named TypeS. This can typically 
 
271
# be useful for C code in case the coding convention dictates that all compound 
 
272
# types are typedef'ed and only the typedef is referenced, never the tag name.
 
273
 
 
274
TYPEDEF_HIDES_STRUCT   = NO
 
275
 
 
276
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
 
277
# determine which symbols to keep in memory and which to flush to disk. 
 
278
# When the cache is full, less often used symbols will be written to disk. 
 
279
# For small to medium size projects (<1000 input files) the default value is 
 
280
# probably good enough. For larger projects a too small cache size can cause 
 
281
# doxygen to be busy swapping symbols to and from disk most of the time 
 
282
# causing a significant performance penality. 
 
283
# If the system has enough physical memory increasing the cache will improve the 
 
284
# performance by keeping more symbols in memory. Note that the value works on 
 
285
# a logarithmic scale so increasing the size by one will rougly double the 
 
286
# memory usage. The cache size is given by this formula: 
 
287
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
 
288
# corresponding to a cache size of 2^16 = 65536 symbols
 
289
 
 
290
SYMBOL_CACHE_SIZE      = 0
 
291
 
233
292
#---------------------------------------------------------------------------
234
293
# Build related configuration options
235
294
#---------------------------------------------------------------------------
249
308
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
250
309
# will be included in the documentation.
251
310
 
252
 
EXTRACT_STATIC         = NO
 
311
EXTRACT_STATIC         = YES
253
312
 
254
313
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
255
314
# defined locally in source files will be included in the documentation. 
264
323
 
265
324
EXTRACT_LOCAL_METHODS  = NO
266
325
 
267
 
# If this flag is set to YES, the members of anonymous namespaces will be extracted 
268
 
# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 
269
 
# where file will be replaced with the base name of the file that contains the anonymous 
270
 
# namespace. By default anonymous namespace are hidden.
 
326
# If this flag is set to YES, the members of anonymous namespaces will be 
 
327
# extracted and appear in the documentation as a namespace called 
 
328
# 'anonymous_namespace{file}', where file will be replaced with the base 
 
329
# name of the file that contains the anonymous namespace. By default 
 
330
# anonymous namespace are hidden.
271
331
 
272
332
EXTRACT_ANON_NSPACES   = NO
273
333
 
327
387
 
328
388
SHOW_INCLUDE_FILES     = YES
329
389
 
 
390
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 
 
391
# will list include files with double quotes in the documentation 
 
392
# rather than with sharp brackets.
 
393
 
 
394
FORCE_LOCAL_INCLUDES   = NO
 
395
 
330
396
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
331
397
# is inserted in the documentation for inline members.
332
398
 
346
412
 
347
413
SORT_BRIEF_DOCS        = NO
348
414
 
 
415
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
 
416
# will sort the (brief and detailed) documentation of class members so that
 
417
# constructors and destructors are listed first. If set to NO (the default)
 
418
# the constructors will appear in the respective orders defined by
 
419
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
 
420
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
 
421
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
 
422
 
 
423
SORT_MEMBERS_CTORS_1ST = NO
 
424
 
 
425
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
 
426
# hierarchy of group names into alphabetical order. If set to NO (the default) 
 
427
# the group names will appear in their defined order.
 
428
 
 
429
SORT_GROUP_NAMES       = NO
 
430
 
349
431
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
350
432
# sorted by fully-qualified names, including namespaces. If set to 
351
433
# NO (the default), the class list will be sorted only by class name, 
352
434
# not including the namespace part. 
353
 
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
 
435
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
354
436
# Note: This option applies only to the class list, not to the 
355
437
# alphabetical list.
356
438
 
407
489
 
408
490
SHOW_DIRECTORIES       = YES
409
491
 
 
492
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
 
493
# This will remove the Files entry from the Quick Index and from the 
 
494
# Folder Tree View (if specified). The default is YES.
 
495
 
 
496
SHOW_FILES             = YES
 
497
 
 
498
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
 
499
# Namespaces page.  This will remove the Namespaces entry from the Quick Index 
 
500
# and from the Folder Tree View (if specified). The default is YES.
 
501
 
 
502
SHOW_NAMESPACES        = YES
 
503
 
410
504
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
411
 
# doxygen should invoke to get the current version for each file (typically from the 
412
 
# version control system). Doxygen will invoke the program by executing (via 
 
505
# doxygen should invoke to get the current version for each file (typically from 
 
506
# the version control system). Doxygen will invoke the program by executing (via 
413
507
# popen()) the command <command> <input-file>, where <command> is the value of 
414
508
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
415
509
# provided by doxygen. Whatever the program writes to standard output 
417
511
 
418
512
FILE_VERSION_FILTER    = 
419
513
 
 
514
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
 
515
# doxygen. The layout file controls the global structure of the generated output files 
 
516
# in an output format independent way. The create the layout file that represents 
 
517
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
 
518
# file name after the option, if omitted DoxygenLayout.xml will be used as the name 
 
519
# of the layout file.
 
520
 
 
521
LAYOUT_FILE            = 
 
522
 
420
523
#---------------------------------------------------------------------------
421
524
# configuration options related to warning and progress messages
422
525
#---------------------------------------------------------------------------
424
527
# The QUIET tag can be used to turn on/off the messages that are generated 
425
528
# by doxygen. Possible values are YES and NO. If left blank NO is used.
426
529
 
427
 
QUIET                  = NO
 
530
QUIET                  = YES
428
531
 
429
532
# The WARNINGS tag can be used to turn on/off the warning messages that are 
430
533
# generated by doxygen. Possible values are YES and NO. If left blank 
460
563
# $version, which will be replaced by the version of the file (if it could 
461
564
# be obtained via FILE_VERSION_FILTER)
462
565
 
463
 
WARN_FORMAT            = "$file:$line: $text  "
 
566
WARN_FORMAT            = "$file:$line: $text"
464
567
 
465
568
# The WARN_LOGFILE tag can be used to specify a file to which warning 
466
569
# and error messages should be written. If left blank the output is written 
477
580
# directories like "/usr/src/myproject". Separate the files or directories 
478
581
# with spaces.
479
582
 
480
 
INPUT                  = 
 
583
INPUT                  = .
481
584
 
482
 
# This tag can be used to specify the character encoding of the source files that 
483
 
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
484
 
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
485
 
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
 
585
# This tag can be used to specify the character encoding of the source files 
 
586
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
 
587
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
 
588
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
 
589
# the list of possible encodings.
486
590
 
487
591
INPUT_ENCODING         = UTF-8
488
592
 
491
595
# and *.h) to filter out the source-files in the directories. If left 
492
596
# blank the following patterns are tested: 
493
597
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
494
 
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
 
598
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
495
599
 
496
 
FILE_PATTERNS          = *.c *.h *.l *.y
 
600
FILE_PATTERNS          = *.c \
 
601
                         *.h \
 
602
                         *.l \
 
603
                         *.y
497
604
 
498
605
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
499
606
# should be searched for input files as well. Possible values are YES and NO. 
522
629
EXCLUDE_PATTERNS       = 
523
630
 
524
631
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
525
 
# (namespaces, classes, functions, etc.) that should be excluded from the output. 
526
 
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
527
 
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
 
632
# (namespaces, classes, functions, etc.) that should be excluded from the 
 
633
# output. The symbol name can be a fully qualified name, a word, or if the 
 
634
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
 
635
# AClass::ANamespace, ANamespace::*Test
528
636
 
529
637
EXCLUDE_SYMBOLS        = 
530
638
 
586
694
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
587
695
# be generated. Documented entities will be cross-referenced with these sources. 
588
696
# Note: To get rid of all source code in the generated output, make sure also 
589
 
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 
590
 
# then you must also enable this option. If you don't then doxygen will produce 
591
 
# a warning and turn it on anyway
 
697
# VERBATIM_HEADERS is set to NO.
592
698
 
593
 
SOURCE_BROWSER         = NO
 
699
SOURCE_BROWSER         = YES
594
700
 
595
701
# Setting the INLINE_SOURCES tag to YES will include the body 
596
702
# of functions and classes directly in the documentation.
601
707
# doxygen to hide any special comment blocks from generated source code 
602
708
# fragments. Normal C and C++ comments will always remain visible.
603
709
 
604
 
STRIP_CODE_COMMENTS    = YES
 
710
STRIP_CODE_COMMENTS    = NO
605
711
 
606
 
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
 
712
# If the REFERENCED_BY_RELATION tag is set to YES 
607
713
# then for each documented function all documented 
608
714
# functions referencing it will be listed.
609
715
 
610
716
REFERENCED_BY_RELATION = YES
611
717
 
612
 
# If the REFERENCES_RELATION tag is set to YES (the default) 
 
718
# If the REFERENCES_RELATION tag is set to YES 
613
719
# then for each documented function all documented entities 
614
720
# called/used by that function will be listed.
615
721
 
616
722
REFERENCES_RELATION    = YES
617
723
 
618
 
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
619
 
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
620
 
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
621
 
# link to the source code.  Otherwise they will link to the documentstion.
 
724
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
 
725
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
 
726
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
 
727
# link to the source code.  Otherwise they will link to the documentation.
622
728
 
623
729
REFERENCES_LINK_SOURCE = YES
624
730
 
644
750
# of all compounds will be generated. Enable this if the project 
645
751
# contains a lot of classes, structs, unions or interfaces.
646
752
 
647
 
ALPHABETICAL_INDEX     = NO
 
753
ALPHABETICAL_INDEX     = YES
648
754
 
649
755
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
650
756
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
701
807
 
702
808
HTML_STYLESHEET        = 
703
809
 
 
810
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 
 
811
# page will contain the date and time when the page was generated. Setting 
 
812
# this to NO can help when comparing the output of multiple runs.
 
813
 
 
814
HTML_TIMESTAMP         = YES
 
815
 
704
816
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
705
817
# files or namespaces will be aligned in HTML using tables. If set to 
706
818
# NO a bullet list will be used.
707
819
 
708
820
HTML_ALIGN_MEMBERS     = YES
709
821
 
710
 
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
711
 
# will be generated that can be used as input for tools like the 
712
 
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
713
 
# of the generated HTML documentation.
714
 
 
715
 
GENERATE_HTMLHELP      = NO
716
 
 
717
822
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
718
823
# documentation will contain sections that can be hidden and shown after the 
719
824
# page has loaded. For this to work a browser that supports 
722
827
 
723
828
HTML_DYNAMIC_SECTIONS  = NO
724
829
 
 
830
# If the GENERATE_DOCSET tag is set to YES, additional index files 
 
831
# will be generated that can be used as input for Apple's Xcode 3 
 
832
# integrated development environment, introduced with OSX 10.5 (Leopard). 
 
833
# To create a documentation set, doxygen will generate a Makefile in the 
 
834
# HTML output directory. Running make will produce the docset in that 
 
835
# directory and running "make install" will install the docset in 
 
836
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
 
837
# it at startup. 
 
838
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
 
839
 
 
840
GENERATE_DOCSET        = NO
 
841
 
 
842
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
 
843
# feed. A documentation feed provides an umbrella under which multiple 
 
844
# documentation sets from a single provider (such as a company or product suite) 
 
845
# can be grouped.
 
846
 
 
847
DOCSET_FEEDNAME        = "Doxygen generated docs"
 
848
 
 
849
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
 
850
# should uniquely identify the documentation set bundle. This should be a 
 
851
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
 
852
# will append .docset to the name.
 
853
 
 
854
DOCSET_BUNDLE_ID       = org.doxygen.Project
 
855
 
 
856
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
 
857
# will be generated that can be used as input for tools like the 
 
858
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
 
859
# of the generated HTML documentation.
 
860
 
 
861
GENERATE_HTMLHELP      = NO
 
862
 
725
863
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
726
864
# be used to specify the file name of the resulting .chm file. You 
727
865
# can add a path in front of the file if the result should not be 
742
880
 
743
881
GENERATE_CHI           = NO
744
882
 
 
883
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
 
884
# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
 
885
# content.
 
886
 
 
887
CHM_INDEX_ENCODING     = 
 
888
 
745
889
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
746
890
# controls whether a binary table of contents is generated (YES) or a 
747
891
# normal table of contents (NO) in the .chm file.
753
897
 
754
898
TOC_EXPAND             = NO
755
899
 
 
900
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
 
901
# are set, an additional index file will be generated that can be used as input for 
 
902
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
 
903
# HTML documentation.
 
904
 
 
905
GENERATE_QHP           = NO
 
906
 
 
907
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
 
908
# be used to specify the file name of the resulting .qch file. 
 
909
# The path specified is relative to the HTML output folder.
 
910
 
 
911
QCH_FILE               = 
 
912
 
 
913
# The QHP_NAMESPACE tag specifies the namespace to use when generating 
 
914
# Qt Help Project output. For more information please see 
 
915
# http://doc.trolltech.com/qthelpproject.html#namespace
 
916
 
 
917
QHP_NAMESPACE          = org.doxygen.Project
 
918
 
 
919
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
 
920
# Qt Help Project output. For more information please see 
 
921
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
 
922
 
 
923
QHP_VIRTUAL_FOLDER     = doc
 
924
 
 
925
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
 
926
# For more information please see 
 
927
# http://doc.trolltech.com/qthelpproject.html#custom-filters
 
928
 
 
929
QHP_CUST_FILTER_NAME   = 
 
930
 
 
931
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
 
932
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
 
933
 
 
934
QHP_CUST_FILTER_ATTRS  = 
 
935
 
 
936
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
 
937
# filter section matches. 
 
938
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
 
939
 
 
940
QHP_SECT_FILTER_ATTRS  = 
 
941
 
 
942
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
 
943
# be used to specify the location of Qt's qhelpgenerator. 
 
944
# If non-empty doxygen will try to run qhelpgenerator on the generated 
 
945
# .qhp file.
 
946
 
 
947
QHG_LOCATION           = 
 
948
 
 
949
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
 
950
# will be generated, which together with the HTML files, form an Eclipse help  
 
951
# plugin. To install this plugin and make it available under the help contents 
 
952
# menu in Eclipse, the contents of the directory containing the HTML and XML 
 
953
# files needs to be copied into the plugins directory of eclipse. The name of 
 
954
# the directory within the plugins directory should be the same as 
 
955
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
 
956
# the help appears.
 
957
 
 
958
GENERATE_ECLIPSEHELP   = NO
 
959
 
 
960
# A unique identifier for the eclipse help plugin. When installing the plugin 
 
961
# the directory name containing the HTML and XML files should also have 
 
962
# this name.
 
963
 
 
964
ECLIPSE_DOC_ID         = org.doxygen.Project
 
965
 
756
966
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
757
967
# top of each HTML page. The value NO (the default) enables the index and 
758
968
# the value YES disables it.
764
974
 
765
975
ENUM_VALUES_PER_LINE   = 4
766
976
 
767
 
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
768
 
# generated containing a tree-like index structure (just like the one that 
 
977
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
 
978
# structure should be generated to display hierarchical information. 
 
979
# If the tag value is set to YES, a side panel will be generated 
 
980
# containing a tree-like index structure (just like the one that 
769
981
# is generated for HTML Help). For this to work a browser that supports 
770
 
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
771
 
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
772
 
# probably better off using the HTML help feature.
773
 
 
774
 
GENERATE_TREEVIEW      = NO
 
982
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
 
983
# Windows users are probably better off using the HTML help feature.
 
984
 
 
985
GENERATE_TREEVIEW      = YES
 
986
 
 
987
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
 
988
# and Class Hierarchy pages using a tree view instead of an ordered list.
 
989
 
 
990
USE_INLINE_TREES       = NO
775
991
 
776
992
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
777
993
# used to set the initial width (in pixels) of the frame in which the tree 
779
995
 
780
996
TREEVIEW_WIDTH         = 250
781
997
 
 
998
# Use this tag to change the font size of Latex formulas included 
 
999
# as images in the HTML documentation. The default is 10. Note that 
 
1000
# when you change the font size after a successful doxygen run you need 
 
1001
# to manually remove any form_*.png images from the HTML output directory 
 
1002
# to force them to be regenerated.
 
1003
 
 
1004
FORMULA_FONTSIZE       = 10
 
1005
 
 
1006
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
 
1007
# for the HTML output. The underlying search engine uses javascript 
 
1008
# and DHTML and should work on any modern browser. Note that when using
 
1009
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
 
1010
# (GENERATE_DOCSET) there is already a search function so this one should 
 
1011
# typically be disabled. For large projects the javascript based search engine 
 
1012
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
 
1013
 
 
1014
SEARCHENGINE           = NO
 
1015
 
 
1016
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 
1017
# implemented using a PHP enabled web server instead of at the web client
 
1018
# using Javascript. Doxygen will generate the search PHP script and index 
 
1019
# file to put on the web server. The advantage of the server
 
1020
# based approach is that it scales better to large projects and allows
 
1021
# full text search. The disadvances is that it is more difficult to setup 
 
1022
# and does not have live searching capabilities.
 
1023
 
 
1024
SERVER_BASED_SEARCH    = NO
 
1025
 
782
1026
#---------------------------------------------------------------------------
783
1027
# configuration options related to the LaTeX output
784
1028
#---------------------------------------------------------------------------
795
1039
LATEX_OUTPUT           = latex
796
1040
 
797
1041
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
798
 
# invoked. If left blank `latex' will be used as the default command name.
 
1042
# invoked. If left blank `latex' will be used as the default command name. 
 
1043
# Note that when enabling USE_PDFLATEX this option is only used for 
 
1044
# generating bitmaps for formulas in the HTML output, but not in the 
 
1045
# Makefile that is written to the output directory.
799
1046
 
800
1047
LATEX_CMD_NAME         = latex
801
1048
 
855
1102
 
856
1103
LATEX_HIDE_INDICES     = NO
857
1104
 
 
1105
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
 
1106
# source code with syntax highlighting in the LaTeX output.
 
1107
# Note that which sources are shown also depends on other settings
 
1108
# such as SOURCE_BROWSER.
 
1109
 
 
1110
LATEX_SOURCE_CODE      = NO
 
1111
 
858
1112
#---------------------------------------------------------------------------
859
1113
# configuration options related to the RTF output
860
1114
#---------------------------------------------------------------------------
1006
1260
PERLMOD_MAKEVAR_PREFIX = 
1007
1261
 
1008
1262
#---------------------------------------------------------------------------
1009
 
# Configuration options related to the preprocessor   
 
1263
# Configuration options related to the preprocessor
1010
1264
#---------------------------------------------------------------------------
1011
1265
 
1012
1266
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1037
1291
# contain include files that are not input files but should be processed by 
1038
1292
# the preprocessor.
1039
1293
 
1040
 
INCLUDE_PATH           = 
 
1294
INCLUDE_PATH           = /usr/include \
 
1295
                         build \
 
1296
                         trio
1041
1297
 
1042
1298
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1043
1299
# patterns (like *.h and *.hpp) to filter out the header-files in the 
1072
1328
SKIP_FUNCTION_MACROS   = YES
1073
1329
 
1074
1330
#---------------------------------------------------------------------------
1075
 
# Configuration::additions related to external references   
 
1331
# Configuration::additions related to external references
1076
1332
#---------------------------------------------------------------------------
1077
1333
 
1078
1334
# The TAGFILES option can be used to specify one or more tagfiles. 
1084
1340
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
1085
1341
# where "loc1" and "loc2" can be relative or absolute paths or 
1086
1342
# URLs. If a location is present for each tag, the installdox tool 
1087
 
# does not have to be run to correct the links.
1088
 
# Note that each tag file must have a unique name
1089
 
# (where the name does NOT include the path)
 
1343
# does not have to be run to correct the links. 
 
1344
# Note that each tag file must have a unique name 
 
1345
# (where the name does NOT include the path) 
1090
1346
# If a tag file is not located in the directory in which doxygen 
1091
1347
# is run, you must also specify the path to the tagfile here.
1092
1348
 
1115
1371
PERL_PATH              = /usr/bin/perl
1116
1372
 
1117
1373
#---------------------------------------------------------------------------
1118
 
# Configuration options related to the dot tool   
 
1374
# Configuration options related to the dot tool
1119
1375
#---------------------------------------------------------------------------
1120
1376
 
1121
1377
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1125
1381
# fallback. It is recommended to install and use dot, since it yields more 
1126
1382
# powerful graphs.
1127
1383
 
1128
 
CLASS_DIAGRAMS         = YES
 
1384
CLASS_DIAGRAMS         = NO
1129
1385
 
1130
1386
# You can define message sequence charts within doxygen comments using the \msc 
1131
 
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
1132
 
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
1133
 
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
1134
 
# be found in the default search path.
 
1387
# command. Doxygen will then run the mscgen tool (see 
 
1388
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
 
1389
# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
 
1390
# the mscgen tool resides. If left empty the tool is assumed to be found in the 
 
1391
# default search path.
1135
1392
 
1136
1393
MSCGEN_PATH            = 
1137
1394
 
1148
1405
 
1149
1406
HAVE_DOT               = YES
1150
1407
 
 
1408
# By default doxygen will write a font called FreeSans.ttf to the output 
 
1409
# directory and reference it in all dot files that doxygen generates. This 
 
1410
# font does not include all possible unicode characters however, so when you need 
 
1411
# these (or just want a differently looking font) you can specify the font name 
 
1412
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
 
1413
# which can be done by putting it in a standard location or by setting the 
 
1414
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
 
1415
# containing the font.
 
1416
 
 
1417
DOT_FONTNAME           = FreeSans
 
1418
 
 
1419
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
 
1420
# The default size is 10pt.
 
1421
 
 
1422
DOT_FONTSIZE           = 10
 
1423
 
 
1424
# By default doxygen will tell dot to use the output directory to look for the 
 
1425
# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
 
1426
# different font using DOT_FONTNAME you can set the path where dot 
 
1427
# can find it using this tag.
 
1428
 
 
1429
DOT_FONTPATH           = 
 
1430
 
1151
1431
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1152
1432
# will generate a graph for each documented class showing the direct and 
1153
1433
# indirect inheritance relations. Setting this tag to YES will force the 
1192
1472
 
1193
1473
INCLUDED_BY_GRAPH      = YES
1194
1474
 
1195
 
# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
1196
 
# generate a call dependency graph for every global function or class method. 
1197
 
# Note that enabling this option will significantly increase the time of a run. 
1198
 
# So in most cases it will be better to enable call graphs for selected 
1199
 
# functions only using the \callgraph command.
 
1475
# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
 
1476
# doxygen will generate a call dependency graph for every global function 
 
1477
# or class method. Note that enabling this option will significantly increase 
 
1478
# the time of a run. So in most cases it will be better to enable call graphs 
 
1479
# for selected functions only using the \callgraph command.
1200
1480
 
1201
1481
CALL_GRAPH             = NO
1202
1482
 
1203
 
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
1204
 
# generate a caller dependency graph for every global function or class method. 
1205
 
# Note that enabling this option will significantly increase the time of a run. 
1206
 
# So in most cases it will be better to enable caller graphs for selected 
1207
 
# functions only using the \callergraph command.
 
1483
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
 
1484
# doxygen will generate a caller dependency graph for every global function 
 
1485
# or class method. Note that enabling this option will significantly increase 
 
1486
# the time of a run. So in most cases it will be better to enable caller 
 
1487
# graphs for selected functions only using the \callergraph command.
1208
1488
 
1209
1489
CALLER_GRAPH           = NO
1210
1490
 
1215
1495
 
1216
1496
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1217
1497
# then doxygen will show the dependencies a directory has on other directories 
1218
 
# in a graphical way. The dependency relations are determined by the #include
 
1498
# in a graphical way. The dependency relations are determined by the #include 
1219
1499
# relations between the files in the directories.
1220
1500
 
1221
1501
DIRECTORY_GRAPH        = YES
1222
1502
 
1223
1503
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1224
 
# generated by dot. Possible values are png, jpg, or gif
 
1504
# generated by dot. Possible values are png, jpg, or gif 
1225
1505
# If left blank png will be used.
1226
1506
 
1227
1507
DOT_IMAGE_FORMAT       = png
1237
1517
 
1238
1518
DOTFILE_DIRS           = 
1239
1519
 
1240
 
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
 
1520
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1241
1521
# nodes that will be shown in the graph. If the number of nodes in a graph 
1242
1522
# becomes larger than this value, doxygen will truncate the graph, which is 
1243
 
# visualized by representing a node as a red box. Note that doxygen if the number 
1244
 
# of direct children of the root node in a graph is already larger than 
1245
 
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 
 
1523
# visualized by representing a node as a red box. Note that doxygen if the 
 
1524
# number of direct children of the root node in a graph is already larger than 
 
1525
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1246
1526
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1247
1527
 
1248
1528
DOT_GRAPH_MAX_NODES    = 50
1258
1538
MAX_DOT_GRAPH_DEPTH    = 0
1259
1539
 
1260
1540
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1261
 
# background. This is disabled by default, which results in a white background. 
1262
 
# Warning: Depending on the platform used, enabling this option may lead to 
1263
 
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1264
 
# read).
 
1541
# background. This is disabled by default, because dot on Windows does not 
 
1542
# seem to support this out of the box. Warning: Depending on the platform used, 
 
1543
# enabling this option may lead to badly anti-aliased labels on the edges of 
 
1544
# a graph (i.e. they become hard to read).
1265
1545
 
1266
1546
DOT_TRANSPARENT        = NO
1267
1547
 
1283
1563
# the various graphs.
1284
1564
 
1285
1565
DOT_CLEANUP            = YES
1286
 
 
1287
 
#---------------------------------------------------------------------------
1288
 
# Configuration::additions related to the search engine   
1289
 
#---------------------------------------------------------------------------
1290
 
 
1291
 
# The SEARCHENGINE tag specifies whether or not a search engine should be 
1292
 
# used. If set to NO the values of all tags below this one will be ignored.
1293
 
 
1294
 
SEARCHENGINE           = NO