1
- # Doxyfile 1.5.8
1
+ # Doxyfile 1.6.2
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
@@ -54,11 +54,11 @@ CREATE_SUBDIRS = YES
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, Farsi, Finnish, French, German, Greek ,
58
- # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59
- # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish ,
60
- # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene ,
61
- # 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 .
62
62
63
63
OUTPUT_LANGUAGE = English
64
64
@@ -124,7 +124,7 @@ FULL_PATH_NAMES = YES
124
124
# If left blank the directory from which doxygen is run is used as the
125
125
# path to strip.
126
126
127
- STRIP_FROM_PATH = .
127
+ STRIP_FROM_PATH =
128
128
129
129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
130
# the path mentioned in the documentation of a class, which tells
@@ -169,13 +169,13 @@ MULTILINE_CPP_IS_BRIEF = NO
169
169
# member inherits the documentation from any documented member that it
170
170
# re-implements.
171
171
172
- INHERIT_DOCS = NO
172
+ INHERIT_DOCS = YES
173
173
174
174
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175
175
# a new page for each member. If set to NO, the documentation of a member will
176
176
# be part of the file/class/namespace that contains it.
177
177
178
- SEPARATE_MEMBER_PAGES = NO
178
+ SEPARATE_MEMBER_PAGES = YES
179
179
180
180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
181
# Doxygen uses this value to replace tabs by spaces in code fragments.
@@ -224,7 +224,8 @@ OPTIMIZE_OUTPUT_VHDL = NO
224
224
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225
225
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226
226
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227
- # use: inc=Fortran f=C
227
+ # use: inc=Fortran f=C. Note that for custom extensions you also need to set
228
+ # FILE_PATTERNS otherwise the files are not read by doxygen.
228
229
229
230
EXTENSION_MAPPING =
230
231
@@ -396,6 +397,12 @@ HIDE_SCOPE_NAMES = NO
396
397
397
398
SHOW_INCLUDE_FILES = YES
398
399
400
+ # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401
+ # will list include files with double quotes in the documentation
402
+ # rather than with sharp brackets.
403
+
404
+ FORCE_LOCAL_INCLUDES = NO
405
+
399
406
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
400
407
# is inserted in the documentation for inline members.
401
408
@@ -415,6 +422,16 @@ SORT_MEMBER_DOCS = YES
415
422
416
423
SORT_BRIEF_DOCS = NO
417
424
425
+ # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426
+ # will sort the (brief and detailed) documentation of class members so that
427
+ # constructors and destructors are listed first. If set to NO (the default)
428
+ # the constructors will appear in the respective orders defined by
429
+ # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430
+ # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431
+ # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
432
+
433
+ SORT_MEMBERS_CTORS_1ST = NO
434
+
418
435
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419
436
# hierarchy of group names into alphabetical order. If set to NO (the default)
420
437
# the group names will appear in their defined order.
@@ -591,11 +608,13 @@ INPUT_ENCODING = UTF-8
591
608
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
592
609
593
610
FILE_PATTERNS = *.c \
611
+ *.cc \
594
612
*.cxx \
595
613
*.cpp \
596
614
*.c++ \
597
615
*.h \
598
616
*.hh \
617
+ *.hxx \
599
618
*.hpp \
600
619
*.idl
601
620
@@ -644,7 +663,7 @@ EXAMPLE_PATH =
644
663
# and *.h) to filter out the source-files in the directories. If left
645
664
# blank all files are included.
646
665
647
- EXAMPLE_PATTERNS =
666
+ EXAMPLE_PATTERNS = *
648
667
649
668
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
650
669
# searched for input files to be used with the \include or \dontinclude
@@ -710,7 +729,7 @@ STRIP_CODE_COMMENTS = YES
710
729
# then for each documented function all documented
711
730
# functions referencing it will be listed.
712
731
713
- REFERENCED_BY_RELATION = NO
732
+ REFERENCED_BY_RELATION = YES
714
733
715
734
# If the REFERENCES_RELATION tag is set to YES
716
735
# then for each documented function all documented entities
@@ -737,7 +756,7 @@ USE_HTAGS = NO
737
756
# will generate a verbatim copy of the header file for each class for
738
757
# which an include is specified. Set to NO to disable this.
739
758
740
- VERBATIM_HEADERS = YES
759
+ VERBATIM_HEADERS = NO
741
760
742
761
#---------------------------------------------------------------------------
743
762
# configuration options related to the alphabetical class index
@@ -804,6 +823,12 @@ HTML_FOOTER = Doxygen/footer.html
804
823
805
824
HTML_STYLESHEET =
806
825
826
+ # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
827
+ # page will contain the date and time when the page was generated. Setting
828
+ # this to NO can help when comparing the output of multiple runs.
829
+
830
+ HTML_TIMESTAMP = NO
831
+
807
832
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
808
833
# files or namespaces will be aligned in HTML using tables. If set to
809
834
# NO a bullet list will be used.
@@ -937,6 +962,23 @@ QHP_SECT_FILTER_ATTRS =
937
962
938
963
QHG_LOCATION =
939
964
965
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
966
+ # will be generated, which together with the HTML files, form an Eclipse help
967
+ # plugin. To install this plugin and make it available under the help contents
968
+ # menu in Eclipse, the contents of the directory containing the HTML and XML
969
+ # files needs to be copied into the plugins directory of eclipse. The name of
970
+ # the directory within the plugins directory should be the same as
971
+ # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
972
+ # the help appears.
973
+
974
+ GENERATE_ECLIPSEHELP = NO
975
+
976
+ # A unique identifier for the eclipse help plugin. When installing the plugin
977
+ # the directory name containing the HTML and XML files should also have
978
+ # this name.
979
+
980
+ ECLIPSE_DOC_ID = org.doxygen.Project
981
+
940
982
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
941
983
# top of each HTML page. The value NO (the default) enables the index and
942
984
# the value YES disables it.
@@ -950,20 +992,18 @@ ENUM_VALUES_PER_LINE = 4
950
992
951
993
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
952
994
# structure should be generated to display hierarchical information.
953
- # If the tag value is set to FRAME , a side panel will be generated
995
+ # If the tag value is set to YES , a side panel will be generated
954
996
# containing a tree-like index structure (just like the one that
955
997
# is generated for HTML Help). For this to work a browser that supports
956
- # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
957
- # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
958
- # probably better off using the HTML help feature. Other possible values
959
- # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
960
- # and Class Hierarchy pages using a tree view instead of an ordered list;
961
- # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
962
- # disables this behavior completely. For backwards compatibility with previous
963
- # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
964
- # respectively.
965
-
966
- GENERATE_TREEVIEW = NONE
998
+ # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
999
+ # Windows users are probably better off using the HTML help feature.
1000
+
1001
+ GENERATE_TREEVIEW = NO
1002
+
1003
+ # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1004
+ # and Class Hierarchy pages using a tree view instead of an ordered list.
1005
+
1006
+ USE_INLINE_TREES = NO
967
1007
968
1008
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
969
1009
# used to set the initial width (in pixels) of the frame in which the tree
@@ -979,6 +1019,26 @@ TREEVIEW_WIDTH = 250
979
1019
980
1020
FORMULA_FONTSIZE = 10
981
1021
1022
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1023
+ # for the HTML output. The underlying search engine uses javascript
1024
+ # and DHTML and should work on any modern browser. Note that when using
1025
+ # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1026
+ # (GENERATE_DOCSET) there is already a search function so this one should
1027
+ # typically be disabled. For large projects the javascript based search engine
1028
+ # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1029
+
1030
+ SEARCHENGINE = YES
1031
+
1032
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1033
+ # implemented using a PHP enabled web server instead of at the web client
1034
+ # using Javascript. Doxygen will generate the search PHP script and index
1035
+ # file to put on the web server. The advantage of the server
1036
+ # based approach is that it scales better to large projects and allows
1037
+ # full text search. The disadvances is that it is more difficult to setup
1038
+ # and does not have live searching capabilities.
1039
+
1040
+ SERVER_BASED_SEARCH = YES
1041
+
982
1042
#---------------------------------------------------------------------------
983
1043
# configuration options related to the LaTeX output
984
1044
#---------------------------------------------------------------------------
@@ -995,7 +1055,10 @@ GENERATE_LATEX = NO
995
1055
LATEX_OUTPUT = latex
996
1056
997
1057
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
998
- # invoked. If left blank `latex' will be used as the default command name.
1058
+ # invoked. If left blank `latex' will be used as the default command name.
1059
+ # Note that when enabling USE_PDFLATEX this option is only used for
1060
+ # generating bitmaps for formulas in the HTML output, but not in the
1061
+ # Makefile that is written to the output directory.
999
1062
1000
1063
LATEX_CMD_NAME = latex
1001
1064
@@ -1055,6 +1118,13 @@ LATEX_BATCHMODE = NO
1055
1118
1056
1119
LATEX_HIDE_INDICES = NO
1057
1120
1121
+ # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1122
+ # source code with syntax highlighting in the LaTeX output.
1123
+ # Note that which sources are shown also depends on other settings
1124
+ # such as SOURCE_BROWSER.
1125
+
1126
+ LATEX_SOURCE_CODE = NO
1127
+
1058
1128
#---------------------------------------------------------------------------
1059
1129
# configuration options related to the RTF output
1060
1130
#---------------------------------------------------------------------------
@@ -1206,14 +1276,14 @@ PERLMOD_PRETTY = YES
1206
1276
PERLMOD_MAKEVAR_PREFIX =
1207
1277
1208
1278
#---------------------------------------------------------------------------
1209
- # Configuration options related to the preprocessor
1279
+ # Configuration options related to the preprocessor
1210
1280
#---------------------------------------------------------------------------
1211
1281
1212
1282
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1213
1283
# evaluate all C-preprocessor directives found in the sources and include
1214
1284
# files.
1215
1285
1216
- ENABLE_PREPROCESSING = NO
1286
+ ENABLE_PREPROCESSING = YES
1217
1287
1218
1288
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1219
1289
# names in the source code. If set to NO (the default) only conditional
@@ -1272,7 +1342,7 @@ EXPAND_AS_DEFINED =
1272
1342
SKIP_FUNCTION_MACROS = YES
1273
1343
1274
1344
#---------------------------------------------------------------------------
1275
- # Configuration::additions related to external references
1345
+ # Configuration::additions related to external references
1276
1346
#---------------------------------------------------------------------------
1277
1347
1278
1348
# The TAGFILES option can be used to specify one or more tagfiles.
@@ -1315,7 +1385,7 @@ EXTERNAL_GROUPS = YES
1315
1385
PERL_PATH = /usr/bin/perl
1316
1386
1317
1387
#---------------------------------------------------------------------------
1318
- # Configuration options related to the dot tool
1388
+ # Configuration options related to the dot tool
1319
1389
#---------------------------------------------------------------------------
1320
1390
1321
1391
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
@@ -1507,12 +1577,3 @@ GENERATE_LEGEND = YES
1507
1577
# the various graphs.
1508
1578
1509
1579
DOT_CLEANUP = YES
1510
-
1511
- #---------------------------------------------------------------------------
1512
- # Options related to the search engine
1513
- #---------------------------------------------------------------------------
1514
-
1515
- # The SEARCHENGINE tag specifies whether or not a search engine should be
1516
- # used. If set to NO the values of all tags below this one will be ignored.
1517
-
1518
- SEARCHENGINE = YES
0 commit comments