1
1
# Doxyfile 1.8.11
2
2
3
3
# This file describes the settings to be used by the documentation system
4
- # doxygen (www.doxygen.org) for a my-hovercraft-is-full-of-eels .
4
+ # doxygen (www.doxygen.org) for a project .
5
5
#
6
6
# All text after a double hash (##) is considered a comment and is placed in
7
7
# front of the TAG it is preceding.
14
14
# Values that contain spaces should be placed between quotes (\" \").
15
15
16
16
#---------------------------------------------------------------------------
17
- # MyHovercraftIsFullOfEels related configuration options
17
+ # Project related configuration options
18
18
#---------------------------------------------------------------------------
19
19
20
20
# This tag specifies the encoding used for all characters in the config file
26
26
27
27
DOXYFILE_ENCODING = UTF-8
28
28
29
- # The MY_HOVERCRAFT_IS_FULL_OF_EELS_NAME tag is a single word (or a sequence of words surrounded by
29
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30
30
# double-quotes, unless you are using Doxywizard) that should identify the
31
- # my-hovercraft-is-full-of-eels for which the documentation is generated. This name is used in the
31
+ # project for which the documentation is generated. This name is used in the
32
32
# title of most generated pages and in a few other places.
33
33
# The default value is: My MyHovercraftIsFullOfEels.
34
34
35
- MY_HOVERCRAFT_IS_FULL_OF_EELS_NAME = "C++20 Cross Platform Template"
35
+ PROJECT_NAME = "C++20 Cross Platform Template"
36
36
37
- # The MY_HOVERCRAFT_IS_FULL_OF_EELS_NUMBER tag can be used to enter a my-hovercraft-is-full-of-eels or revision number. This
37
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38
38
# could be handy for archiving the generated documentation or if some version
39
39
# control system is used.
40
40
41
- MY_HOVERCRAFT_IS_FULL_OF_EELS_NUMBER = $(TAG_NAME)
41
+ PROJECT_NUMBER = $(TAG_NAME)
42
42
43
- # Using the MY_HOVERCRAFT_IS_FULL_OF_EELS_BRIEF tag one can provide an optional one line description
44
- # for a my-hovercraft-is-full-of-eels that appears at the top of each page and should give viewer a
45
- # quick idea about the purpose of the my-hovercraft-is-full-of-eels . Keep the description short.
43
+ # Using the PROJECT_BRIEF tag one can provide an optional one line description
44
+ # for a project that appears at the top of each page and should give viewer a
45
+ # quick idea about the purpose of the project . Keep the description short.
46
46
47
- MY_HOVERCRAFT_IS_FULL_OF_EELS_BRIEF =
47
+ PROJECT_BRIEF =
48
48
49
- # With the MY_HOVERCRAFT_IS_FULL_OF_EELS_LOGO tag one can specify a logo or an icon that is included
49
+ # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50
50
# in the documentation. The maximum height of the logo should not exceed 55
51
51
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52
52
# the logo to the output directory.
53
53
54
- MY_HOVERCRAFT_IS_FULL_OF_EELS_LOGO =
54
+ PROJECT_LOGO =
55
55
56
56
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57
57
# into which the generated documentation will be written. If a relative path is
@@ -236,29 +236,29 @@ ALIASES =
236
236
237
237
TCL_SUBST =
238
238
239
- # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your my-hovercraft-is-full-of-eels consists of C sources
239
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240
240
# only. Doxygen will then generate output that is more tailored for C. For
241
241
# instance, some of the names that are used will be different. The list of all
242
242
# members will be omitted, etc.
243
243
# The default value is: NO.
244
244
245
245
OPTIMIZE_OUTPUT_FOR_C = NO
246
246
247
- # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your my-hovercraft-is-full-of-eels consists of Java or
247
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248
248
# Python sources only. Doxygen will then generate output that is more tailored
249
249
# for that language. For instance, namespaces will be presented as packages,
250
250
# qualified scopes will look different, etc.
251
251
# The default value is: NO.
252
252
253
253
OPTIMIZE_OUTPUT_JAVA = NO
254
254
255
- # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your my-hovercraft-is-full-of-eels consists of Fortran
255
+ # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256
256
# sources. Doxygen will then generate output that is tailored for Fortran.
257
257
# The default value is: NO.
258
258
259
259
OPTIMIZE_FOR_FORTRAN = NO
260
260
261
- # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your my-hovercraft-is-full-of-eels consists of VHDL
261
+ # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262
262
# sources. Doxygen will then generate output that is tailored for VHDL.
263
263
# The default value is: NO.
264
264
@@ -285,7 +285,7 @@ EXTENSION_MAPPING =
285
285
286
286
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287
287
# according to the Markdown format, which allows for more readable
288
- # documentation. See http://daringfireball.net/my-hovercraft-is-full-of-eelss /markdown/ for details.
288
+ # documentation. See http://daringfireball.net/projects /markdown/ for details.
289
289
# The output of markdown processing is further processed by doxygen, so you can
290
290
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291
291
# case of backward compatibilities issues.
@@ -317,7 +317,7 @@ BUILTIN_STL_SUPPORT = YES
317
317
318
318
CPP_CLI_SUPPORT = NO
319
319
320
- # Set the SIP_SUPPORT tag to YES if your my-hovercraft-is-full-of-eels consists of sip (see:
320
+ # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321
321
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322
322
# will parse them like normal C++ but will assume all classes use public instead
323
323
# of private inheritance when no explicit protection keyword is present.
@@ -767,7 +767,7 @@ WARN_LOGFILE =
767
767
768
768
# The INPUT tag is used to specify the files and/or directories that contain
769
769
# documented source files. You may enter file names like myfile.cpp or
770
- # directories like /usr/src/mymy-hovercraft-is-full-of-eels . Separate the files or directories with
770
+ # directories like /usr/src/myproject . Separate the files or directories with
771
771
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
772
772
# Note: If this tag is empty the current directory is searched.
773
773
@@ -917,7 +917,7 @@ FILTER_SOURCE_PATTERNS =
917
917
918
918
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
919
919
# is part of the input, its contents will be placed on the main page
920
- # (index.html). This can be useful if you have a my-hovercraft-is-full-of-eels on for instance GitHub
920
+ # (index.html). This can be useful if you have a project on for instance GitHub
921
921
# and want to reuse the introduction page also for the doxygen output.
922
922
923
923
USE_MDFILE_AS_MAINPAGE =
@@ -1032,7 +1032,7 @@ CLANG_OPTIONS =
1032
1032
#---------------------------------------------------------------------------
1033
1033
1034
1034
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1035
- # compounds will be generated. Enable this if the my-hovercraft-is-full-of-eels contains a lot of
1035
+ # compounds will be generated. Enable this if the project contains a lot of
1036
1036
# classes, structs, unions or interfaces.
1037
1037
# The default value is: YES.
1038
1038
@@ -1045,7 +1045,7 @@ ALPHABETICAL_INDEX = YES
1045
1045
1046
1046
COLS_IN_ALPHA_INDEX = 5
1047
1047
1048
- # In case all classes in a my-hovercraft-is-full-of-eels start with a common prefix, all classes will
1048
+ # In case all classes in a project start with a common prefix, all classes will
1049
1049
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1050
1050
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1051
1051
# while generating the index headers.
@@ -1248,7 +1248,7 @@ DOCSET_PUBLISHER_NAME = Publisher
1248
1248
1249
1249
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1250
1250
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1251
- # index.hhp is a my-hovercraft-is-full-of-eels file that can be read by Microsoft's HTML Help Workshop
1251
+ # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1252
1252
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1253
1253
# Windows.
1254
1254
#
@@ -1287,7 +1287,7 @@ HHC_LOCATION =
1287
1287
GENERATE_CHI = NO
1288
1288
1289
1289
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1290
- # and my-hovercraft-is-full-of-eels file content.
1290
+ # and project file content.
1291
1291
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1292
1292
1293
1293
CHM_INDEX_ENCODING =
@@ -1325,15 +1325,15 @@ QCH_FILE =
1325
1325
1326
1326
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1327
1327
# MyHovercraftIsFullOfEels output. For more information please see Qt Help MyHovercraftIsFullOfEels / Namespace
1328
- # (see: http://qt-my-hovercraft-is-full-of-eels .org/doc/qt-4.8/qthelpmy-hovercraft-is-full-of-eels .html#namespace).
1328
+ # (see: http://qt-project .org/doc/qt-4.8/qthelpproject .html#namespace).
1329
1329
# The default value is: org.doxygen.MyHovercraftIsFullOfEels.
1330
1330
# This tag requires that the tag GENERATE_QHP is set to YES.
1331
1331
1332
1332
QHP_NAMESPACE = org.doxygen.MyHovercraftIsFullOfEels
1333
1333
1334
1334
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1335
1335
# Help MyHovercraftIsFullOfEels output. For more information please see Qt Help MyHovercraftIsFullOfEels / Virtual
1336
- # Folders (see: http://qt-my-hovercraft-is-full-of-eels .org/doc/qt-4.8/qthelpmy-hovercraft-is-full-of-eels .html#virtual-
1336
+ # Folders (see: http://qt-project .org/doc/qt-4.8/qthelpproject .html#virtual-
1337
1337
# folders).
1338
1338
# The default value is: doc.
1339
1339
# This tag requires that the tag GENERATE_QHP is set to YES.
@@ -1342,23 +1342,23 @@ QHP_VIRTUAL_FOLDER = doc
1342
1342
1343
1343
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1344
1344
# filter to add. For more information please see Qt Help MyHovercraftIsFullOfEels / Custom
1345
- # Filters (see: http://qt-my-hovercraft-is-full-of-eels .org/doc/qt-4.8/qthelpmy-hovercraft-is-full-of-eels .html#custom-
1345
+ # Filters (see: http://qt-project .org/doc/qt-4.8/qthelpproject .html#custom-
1346
1346
# filters).
1347
1347
# This tag requires that the tag GENERATE_QHP is set to YES.
1348
1348
1349
1349
QHP_CUST_FILTER_NAME =
1350
1350
1351
1351
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1352
1352
# custom filter to add. For more information please see Qt Help MyHovercraftIsFullOfEels / Custom
1353
- # Filters (see: http://qt-my-hovercraft-is-full-of-eels .org/doc/qt-4.8/qthelpmy-hovercraft-is-full-of-eels .html#custom-
1353
+ # Filters (see: http://qt-project .org/doc/qt-4.8/qthelpproject .html#custom-
1354
1354
# filters).
1355
1355
# This tag requires that the tag GENERATE_QHP is set to YES.
1356
1356
1357
1357
QHP_CUST_FILTER_ATTRS =
1358
1358
1359
1359
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1360
- # my-hovercraft-is-full-of-eels 's filter section matches. Qt Help MyHovercraftIsFullOfEels / Filter Attributes (see:
1361
- # http://qt-my-hovercraft-is-full-of-eels .org/doc/qt-4.8/qthelpmy-hovercraft-is-full-of-eels .html#filter-attributes).
1360
+ # project 's filter section matches. Qt Help MyHovercraftIsFullOfEels / Filter Attributes (see:
1361
+ # http://qt-project .org/doc/qt-4.8/qthelpproject .html#filter-attributes).
1362
1362
# This tag requires that the tag GENERATE_QHP is set to YES.
1363
1363
1364
1364
QHP_SECT_FILTER_ATTRS =
@@ -1410,7 +1410,7 @@ DISABLE_INDEX = NO
1410
1410
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1411
1411
# further fine-tune the look of the index. As an example, the default style
1412
1412
# sheet generated by doxygen has an example that shows how to put an image at
1413
- # the root of the tree instead of the MY_HOVERCRAFT_IS_FULL_OF_EELS_NAME . Since the tree basically has
1413
+ # the root of the tree instead of the PROJECT_NAME . Since the tree basically has
1414
1414
# the same information as the tab index, you could consider setting
1415
1415
# DISABLE_INDEX to YES when enabling this option.
1416
1416
# The default value is: NO.
@@ -1516,7 +1516,7 @@ MATHJAX_CODEFILE =
1516
1516
# should work on any modern browser. Note that when using HTML help
1517
1517
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1518
1518
# there is already a search function so this one should typically be disabled.
1519
- # For large my-hovercraft-is-full-of-eelss the javascript based search engine can be slow, then
1519
+ # For large projects the javascript based search engine can be slow, then
1520
1520
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1521
1521
# search using the keyboard; to jump to the search box use <access key> + S
1522
1522
# (what the <access key> is depends on the OS and browser, but it is typically
@@ -1580,16 +1580,16 @@ SEARCHENGINE_URL =
1580
1580
SEARCHDATA_FILE = searchdata.xml
1581
1581
1582
1582
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1583
- # EXTERNAL_SEARCH_ID tag can be used as an identifier for the my-hovercraft-is-full-of-eels . This is
1583
+ # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project . This is
1584
1584
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1585
- # my-hovercraft-is-full-of-eelss and redirect the results back to the right my-hovercraft-is-full-of-eels .
1585
+ # projects and redirect the results back to the right project .
1586
1586
# This tag requires that the tag SEARCHENGINE is set to YES.
1587
1587
1588
1588
EXTERNAL_SEARCH_ID =
1589
1589
1590
1590
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1591
- # my-hovercraft-is-full-of-eelss other than the one defined by this configuration file, but that are
1592
- # all added to the same external search index. Each my-hovercraft-is-full-of-eels needs to have a
1591
+ # projects other than the one defined by this configuration file, but that are
1592
+ # all added to the same external search index. Each project needs to have a
1593
1593
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1594
1594
# to a relative location where the documentation can be found. The format is:
1595
1595
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
@@ -1633,7 +1633,7 @@ LATEX_CMD_NAME = latex
1633
1633
MAKEINDEX_CMD_NAME = makeindex
1634
1634
1635
1635
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1636
- # documents. This may be useful for small my-hovercraft-is-full-of-eelss and may help to save some
1636
+ # documents. This may be useful for small projects and may help to save some
1637
1637
# trees in general.
1638
1638
# The default value is: NO.
1639
1639
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1669,8 +1669,8 @@ EXTRA_PACKAGES =
1669
1669
#
1670
1670
# Note: Only use a user-defined header if you know what you are doing! The
1671
1671
# following commands have a special meaning inside the header: $title,
1672
- # $datetime, $date, $doxygenversion, $my-hovercraft-is-full-of-eelsname , $my-hovercraft-is-full-of-eelsnumber ,
1673
- # $my-hovercraft-is-full-of-eelsbrief , $my-hovercraft-is-full-of-eelslogo . Doxygen will replace $title with the empty
1672
+ # $datetime, $date, $doxygenversion, $projectname , $projectnumber ,
1673
+ # $projectbrief , $projectlogo . Doxygen will replace $title with the empty
1674
1674
# string, for the replacement values of the other commands the user is referred
1675
1675
# to HTML_HEADER.
1676
1676
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1786,7 +1786,7 @@ GENERATE_RTF = NO
1786
1786
RTF_OUTPUT = rtf
1787
1787
1788
1788
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1789
- # documents. This may be useful for small my-hovercraft-is-full-of-eelss and may help to save some
1789
+ # documents. This may be useful for small projects and may help to save some
1790
1790
# trees in general.
1791
1791
# The default value is: NO.
1792
1792
# This tag requires that the tag GENERATE_RTF is set to YES.
@@ -2091,14 +2091,14 @@ GENERATE_TAGFILE =
2091
2091
ALLEXTERNALS = NO
2092
2092
2093
2093
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2094
- # in the modules index. If set to NO, only the current my-hovercraft-is-full-of-eels 's groups will be
2094
+ # in the modules index. If set to NO, only the current project 's groups will be
2095
2095
# listed.
2096
2096
# The default value is: YES.
2097
2097
2098
2098
EXTERNAL_GROUPS = YES
2099
2099
2100
2100
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2101
- # the related pages index. If set to NO, only the current my-hovercraft-is-full-of-eels 's pages will
2101
+ # the related pages index. If set to NO, only the current project 's pages will
2102
2102
# be listed.
2103
2103
# The default value is: YES.
2104
2104
0 commit comments