Skip to content

Commit 5d240b2

Browse files
committed
Amend some unintentional clobbering over the source with the name change
1 parent 637dc0b commit 5d240b2

File tree

3 files changed

+46
-46
lines changed

3 files changed

+46
-46
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ CTestTestfile.cmake
4949
_deps
5050

5151
### CMake Patch ###
52-
# External my-hovercraft-is-full-of-eelss
52+
# External projects
5353
*-prefix/
5454

5555
### Linux ###

CMakeLists.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ set(MY_HOVERCRAFT_IS_FULL_OF_EELS_ESCAPED_VERSION_STRING "\"${MY_HOVERCRAFT_IS_F
7171
# used for my-hovercraft-is-full-of-eels and its tests. This is to avoid setting global compiler
7272
# options which would be inherited by dependencies as well, which is bad
7373
# because my-hovercraft-is-full-of-eels uses strict compiler warning options which not all other
74-
# my-hovercraft-is-full-of-eelss can build successfully with.
74+
# projects can build successfully with.
7575
# Any target linked with this one will inherit the compiler options used for
7676
# my-hovercraft-is-full-of-eels.
7777
add_library(my-hovercraft-is-full-of-eels-compiler-options INTERFACE)
@@ -137,7 +137,7 @@ include(CPM)
137137

138138
# library
139139
add_subdirectory(my-hovercraft-is-full-of-eels)
140-
# unit tests --only enable if requested AND we're not building as a sub-my-hovercraft-is-full-of-eels
140+
# unit tests --only enable if requested AND we're not building as a sub-project
141141
if(ENABLE_TESTS AND NOT MY_HOVERCRAFT_IS_FULL_OF_EELS_SUBPROJECT)
142142
message(STATUS "[my-hovercraft-is-full-of-eels] Unit Tests Enabled")
143143
add_subdirectory(tests)

Doxyfile

+43-43
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Doxyfile 1.8.11
22

33
# 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.
55
#
66
# All text after a double hash (##) is considered a comment and is placed in
77
# front of the TAG it is preceding.
@@ -14,7 +14,7 @@
1414
# Values that contain spaces should be placed between quotes (\" \").
1515

1616
#---------------------------------------------------------------------------
17-
# MyHovercraftIsFullOfEels related configuration options
17+
# Project related configuration options
1818
#---------------------------------------------------------------------------
1919

2020
# This tag specifies the encoding used for all characters in the config file
@@ -26,32 +26,32 @@
2626

2727
DOXYFILE_ENCODING = UTF-8
2828

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
3030
# 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
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My MyHovercraftIsFullOfEels.
3434

35-
MY_HOVERCRAFT_IS_FULL_OF_EELS_NAME = "C++20 Cross Platform Template"
35+
PROJECT_NAME = "C++20 Cross Platform Template"
3636

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
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
MY_HOVERCRAFT_IS_FULL_OF_EELS_NUMBER = $(TAG_NAME)
41+
PROJECT_NUMBER = $(TAG_NAME)
4242

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.
4646

47-
MY_HOVERCRAFT_IS_FULL_OF_EELS_BRIEF =
47+
PROJECT_BRIEF =
4848

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
5050
# in the documentation. The maximum height of the logo should not exceed 55
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
MY_HOVERCRAFT_IS_FULL_OF_EELS_LOGO =
54+
PROJECT_LOGO =
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is
@@ -236,29 +236,29 @@ ALIASES =
236236

237237
TCL_SUBST =
238238

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
240240
# only. Doxygen will then generate output that is more tailored for C. For
241241
# instance, some of the names that are used will be different. The list of all
242242
# members will be omitted, etc.
243243
# The default value is: NO.
244244

245245
OPTIMIZE_OUTPUT_FOR_C = NO
246246

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
248248
# Python sources only. Doxygen will then generate output that is more tailored
249249
# for that language. For instance, namespaces will be presented as packages,
250250
# qualified scopes will look different, etc.
251251
# The default value is: NO.
252252

253253
OPTIMIZE_OUTPUT_JAVA = NO
254254

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
256256
# sources. Doxygen will then generate output that is tailored for Fortran.
257257
# The default value is: NO.
258258

259259
OPTIMIZE_FOR_FORTRAN = NO
260260

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
262262
# sources. Doxygen will then generate output that is tailored for VHDL.
263263
# The default value is: NO.
264264

@@ -285,7 +285,7 @@ EXTENSION_MAPPING =
285285

286286
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287287
# 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.
289289
# The output of markdown processing is further processed by doxygen, so you can
290290
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291291
# case of backward compatibilities issues.
@@ -317,7 +317,7 @@ BUILTIN_STL_SUPPORT = YES
317317

318318
CPP_CLI_SUPPORT = NO
319319

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:
321321
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322322
# will parse them like normal C++ but will assume all classes use public instead
323323
# of private inheritance when no explicit protection keyword is present.
@@ -767,7 +767,7 @@ WARN_LOGFILE =
767767

768768
# The INPUT tag is used to specify the files and/or directories that contain
769769
# 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
771771
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
772772
# Note: If this tag is empty the current directory is searched.
773773

@@ -917,7 +917,7 @@ FILTER_SOURCE_PATTERNS =
917917

918918
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
919919
# 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
921921
# and want to reuse the introduction page also for the doxygen output.
922922

923923
USE_MDFILE_AS_MAINPAGE =
@@ -1032,7 +1032,7 @@ CLANG_OPTIONS =
10321032
#---------------------------------------------------------------------------
10331033

10341034
# 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
10361036
# classes, structs, unions or interfaces.
10371037
# The default value is: YES.
10381038

@@ -1045,7 +1045,7 @@ ALPHABETICAL_INDEX = YES
10451045

10461046
COLS_IN_ALPHA_INDEX = 5
10471047

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
10491049
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
10501050
# can be used to specify a prefix (or a list of prefixes) that should be ignored
10511051
# while generating the index headers.
@@ -1248,7 +1248,7 @@ DOCSET_PUBLISHER_NAME = Publisher
12481248

12491249
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
12501250
# 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
12521252
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
12531253
# Windows.
12541254
#
@@ -1287,7 +1287,7 @@ HHC_LOCATION =
12871287
GENERATE_CHI = NO
12881288

12891289
# 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.
12911291
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
12921292

12931293
CHM_INDEX_ENCODING =
@@ -1325,15 +1325,15 @@ QCH_FILE =
13251325

13261326
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
13271327
# 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).
13291329
# The default value is: org.doxygen.MyHovercraftIsFullOfEels.
13301330
# This tag requires that the tag GENERATE_QHP is set to YES.
13311331

13321332
QHP_NAMESPACE = org.doxygen.MyHovercraftIsFullOfEels
13331333

13341334
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
13351335
# 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-
13371337
# folders).
13381338
# The default value is: doc.
13391339
# This tag requires that the tag GENERATE_QHP is set to YES.
@@ -1342,23 +1342,23 @@ QHP_VIRTUAL_FOLDER = doc
13421342

13431343
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
13441344
# 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-
13461346
# filters).
13471347
# This tag requires that the tag GENERATE_QHP is set to YES.
13481348

13491349
QHP_CUST_FILTER_NAME =
13501350

13511351
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
13521352
# 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-
13541354
# filters).
13551355
# This tag requires that the tag GENERATE_QHP is set to YES.
13561356

13571357
QHP_CUST_FILTER_ATTRS =
13581358

13591359
# 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).
13621362
# This tag requires that the tag GENERATE_QHP is set to YES.
13631363

13641364
QHP_SECT_FILTER_ATTRS =
@@ -1410,7 +1410,7 @@ DISABLE_INDEX = NO
14101410
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
14111411
# further fine-tune the look of the index. As an example, the default style
14121412
# 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
14141414
# the same information as the tab index, you could consider setting
14151415
# DISABLE_INDEX to YES when enabling this option.
14161416
# The default value is: NO.
@@ -1516,7 +1516,7 @@ MATHJAX_CODEFILE =
15161516
# should work on any modern browser. Note that when using HTML help
15171517
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
15181518
# 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
15201520
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
15211521
# search using the keyboard; to jump to the search box use <access key> + S
15221522
# (what the <access key> is depends on the OS and browser, but it is typically
@@ -1580,16 +1580,16 @@ SEARCHENGINE_URL =
15801580
SEARCHDATA_FILE = searchdata.xml
15811581

15821582
# 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
15841584
# 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.
15861586
# This tag requires that the tag SEARCHENGINE is set to YES.
15871587

15881588
EXTERNAL_SEARCH_ID =
15891589

15901590
# 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
15931593
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
15941594
# to a relative location where the documentation can be found. The format is:
15951595
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
@@ -1633,7 +1633,7 @@ LATEX_CMD_NAME = latex
16331633
MAKEINDEX_CMD_NAME = makeindex
16341634

16351635
# 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
16371637
# trees in general.
16381638
# The default value is: NO.
16391639
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1669,8 +1669,8 @@ EXTRA_PACKAGES =
16691669
#
16701670
# Note: Only use a user-defined header if you know what you are doing! The
16711671
# 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
16741674
# string, for the replacement values of the other commands the user is referred
16751675
# to HTML_HEADER.
16761676
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1786,7 +1786,7 @@ GENERATE_RTF = NO
17861786
RTF_OUTPUT = rtf
17871787

17881788
# 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
17901790
# trees in general.
17911791
# The default value is: NO.
17921792
# This tag requires that the tag GENERATE_RTF is set to YES.
@@ -2091,14 +2091,14 @@ GENERATE_TAGFILE =
20912091
ALLEXTERNALS = NO
20922092

20932093
# 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
20952095
# listed.
20962096
# The default value is: YES.
20972097

20982098
EXTERNAL_GROUPS = YES
20992099

21002100
# 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
21022102
# be listed.
21032103
# The default value is: YES.
21042104

0 commit comments

Comments
 (0)