coffee/etl
1
0
Fork 0
mirror of https://github.com/ETLCPP/etl.git synced 2026-04-30 19:09:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

etl: apply code spell check across entire code base (#818)

Browse Source 
Utilized a spell checking tool to identify and correct spelling
throughout all files in the code base.

Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
This commit is contained in:
Pisit Sawangvonganan 2024-02-23 02:06:23 +07:00 committed by GitHub
parent 84031659fa
commit c92d970d09
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmake/GetGitRevisionDescription.cmake
View File

@ -59,7 +59,7 @@ get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
# function returns an empty string via _git_dir_var.
#
# Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and
# neither foo nor bar contain a file/directory .git. This wil return
# neither foo nor bar contain a file/directory .git. This will return
# C:/bla/.git
#
function(_git_find_closest_git_dir _start_dir _git_dir_var)

2
examples/FunctionInterruptSimulation-Delegates/FunctionInterruptSimulation.cpp
View File

@ -119,7 +119,7 @@ Uart uart1(0, USART1_IRQ_HANDLER);
Uart uart2(1, USART2_IRQ_HANDLER);
// Declare a global callback for the timer.
// Uses the most efficient callback type for a class, as everthing is known at compile time.
// Uses the most efficient callback type for a class, as everything is known at compile time.
etl::delegate<void(size_t)> timer_member_callback = etl::delegate<void(size_t)>::create<Timer, timer, &Timer::InterruptHandler>();
// Declare the callbacks for the free functions.

2
examples/FunctionInterruptSimulation/FunctionInterruptSimulation.cpp
View File

@ -119,7 +119,7 @@ Uart uart1(0, USART1_IRQ_HANDLER);
Uart uart2(1, USART2_IRQ_HANDLER);
// Declare a global callback for the timer.
// Uses the most efficient callback type for a class, as everthing is known at compile time.
// Uses the most efficient callback type for a class, as everything is known at compile time.
etl::function_imp<Timer, size_t, timer, &Timer::InterruptHandler> timer_member_callback;
// Declare the callbacks for the free functions.

2
include/etl/algorithm.h
View File

@ -2177,7 +2177,7 @@ namespace etl
//***************************************************************************
/// copy_if
/// A safer form of copy_if where it terminates when the first end iterator is reached.
/// There is currently no STL equivelent.
/// There is currently no STL equivalent.
///\ingroup algorithm
//***************************************************************************
template <typename TInputIterator,

2
include/etl/basic_string.h
View File

@ -1262,7 +1262,7 @@ namespace etl
/// Erases a sequence.
///\param position Position to start from.
///\param length Number of characters.
///\return A refernce to this string.
///\return A reference to this string.
//*********************************************************************
etl::ibasic_string<T>& erase(size_type position, size_type length_ = npos)
{

4
include/etl/bit_stream.h
View File

@ -861,7 +861,7 @@ namespace etl
}
//***************************************************************************
/// Sets the function to call afer every write.
/// Sets the function to call after every write.
//***************************************************************************
void set_callback(callback_type callback_)
{
@ -869,7 +869,7 @@ namespace etl
}
//***************************************************************************
/// Gets the function to call afer every write.
/// Gets the function to call after every write.
//***************************************************************************
callback_type get_callback() const
{

4
include/etl/byte_stream.h
View File

@ -410,7 +410,7 @@ namespace etl
}
//***************************************************************************
/// Sets the function to call afer every write.
/// Sets the function to call after every write.
//***************************************************************************
void set_callback(callback_type callback_)
{
@ -418,7 +418,7 @@ namespace etl
}
//***************************************************************************
/// Gets the function to call afer every write.
/// Gets the function to call after every write.
//***************************************************************************
callback_type get_callback() const
{

2
include/etl/fsm.h
View File

@ -158,7 +158,7 @@ namespace etl
};
//***************************************************************************
/// Exception for forbidden state chages.
/// Exception for forbidden state changes.
//***************************************************************************
class fsm_state_composite_state_change_forbidden : public etl::fsm_exception
{

2
include/etl/generators/fsm_generator.h
View File

@ -177,7 +177,7 @@ namespace etl
};
//***************************************************************************
/// Exception for forbidden state chages.
/// Exception for forbidden state changes.
//***************************************************************************
class fsm_state_composite_state_change_forbidden : public etl::fsm_exception
{

2
include/etl/generators/type_traits_generator.h
View File

@ -74,7 +74,7 @@ cog.outl("//********************************************************************
///\defgroup type_traits type_traits
/// A set of type traits definitions.
/// Derived from either the standard or alternate definitions, dependant on whether or not ETL_NO_STL is defined.
/// Derived from either the standard or alternate definitions, dependent on whether or not ETL_NO_STL is defined.
/// \ingroup utilities
#if ETL_USING_STL && ETL_USING_CPP11

4
include/etl/private/ivectorpointer.h
View File

@ -986,7 +986,7 @@ namespace etl
/// Less than or equal operator.
///\param lhs Reference to the first vector.
///\param rhs Reference to the second vector.
///\return <b>true</b> if the first vector is lexigraphically less than or equal to the second, otherwise <b>false</b>
///\return <b>true</b> if the first vector is lexicographically less than or equal to the second, otherwise <b>false</b>
///\ingroup vector
//***************************************************************************
template <typename T>
@ -999,7 +999,7 @@ namespace etl
/// Greater than or equal operator.
///\param lhs Reference to the first vector.
///\param rhs Reference to the second vector.
///\return <b>true</b> if the first vector is lexigraphically greater than or equal to the second, otherwise <b>false</b>
///\return <b>true</b> if the first vector is lexicographically greater than or equal to the second, otherwise <b>false</b>
///\ingroup vector
//***************************************************************************
template <typename T>

22
include/etl/private/variant_variadic.h
View File

@ -997,7 +997,7 @@ namespace etl
#if ETL_USING_CPP17 && !defined(ETL_VARIANT_FORCE_CPP11)
//***************************************************************************
/// Call the relevent visitor by attempting each one.
/// Call the relevant visitor by attempting each one.
//***************************************************************************
template <typename TVisitor, size_t... I>
void do_visitor(TVisitor& visitor, etl::index_sequence<I...>)
@ -1006,7 +1006,7 @@ namespace etl
}
//***************************************************************************
/// Call the relevent visitor by attempting each one.
/// Call the relevant visitor by attempting each one.
//***************************************************************************
template <typename TVisitor, size_t... I>
void do_visitor(TVisitor& visitor, etl::index_sequence<I...>) const
@ -1015,7 +1015,7 @@ namespace etl
}
#else
//***************************************************************************
/// /// Call the relevent visitor.
/// /// Call the relevant visitor.
//***************************************************************************
template <typename TVisitor>
void do_visitor(TVisitor& visitor)
@ -1065,7 +1065,7 @@ namespace etl
}
//***************************************************************************
/// /// Call the relevent visitor.
/// /// Call the relevant visitor.
//***************************************************************************
template <typename TVisitor>
void do_visitor(TVisitor& visitor) const
@ -1125,7 +1125,7 @@ namespace etl
{
// Workaround for MSVC (2023/05/13)
// It doesn't compile 'visitor.visit(etl::get<Index>(*this))' correctly for C++17 & C++20.
// Changed all of the instances for consistancy.
// Changed all of the instances for consistency.
auto& v = etl::get<Index>(*this);
visitor.visit(v);
return true;
@ -1146,7 +1146,7 @@ namespace etl
{
// Workaround for MSVC (2023/05/13)
// It doesn't compile 'visitor.visit(etl::get<Index>(*this))' correctly for C++17 & C++20.
// Changed all of the instances for consistancy.
// Changed all of the instances for consistency.
auto& v = etl::get<Index>(*this);
visitor.visit(v);
return true;
@ -1159,7 +1159,7 @@ namespace etl
#if ETL_USING_CPP17 && !defined(ETL_VARIANT_FORCE_CPP11)
//***************************************************************************
/// Call the relevent visitor by attempting each one.
/// Call the relevant visitor by attempting each one.
//***************************************************************************
template <typename TVisitor, size_t... I>
void do_operator(TVisitor& visitor, etl::index_sequence<I...>)
@ -1168,7 +1168,7 @@ namespace etl
}
//***************************************************************************
/// Call the relevent visitor by attempting each one.
/// Call the relevant visitor by attempting each one.
//***************************************************************************
template <typename TVisitor, size_t... I>
void do_operator(TVisitor& visitor, etl::index_sequence<I...>) const
@ -1177,7 +1177,7 @@ namespace etl
}
#else
//***************************************************************************
/// Call the relevent visitor.
/// Call the relevant visitor.
//***************************************************************************
template <typename TVisitor>
void do_operator(TVisitor& visitor)
@ -1241,7 +1241,7 @@ namespace etl
}
//***************************************************************************
/// Call the relevent visitor.
/// Call the relevant visitor.
//***************************************************************************
template <typename TVisitor>
void do_operator(TVisitor& visitor) const
@ -1693,7 +1693,7 @@ namespace etl
//***************************************************************************
/// Helper to instantiate the function pointers needed for the "jump table".
/// Embedds the 'TVarRest' (remaining variants) into its type to come around
/// Embeds the 'TVarRest' (remaining variants) into its type to come around
/// the "double expansion" otherwise needed in "do_visit".
//***************************************************************************
template <typename TRet, typename TCallable, typename TCurVariant, typename... TVarRest>

2
include/etl/span.h
View File

@ -720,7 +720,7 @@ namespace etl
//*************************************************************************
/// Equality function.
/// Performs a comparision of the range values.
/// Performs a comparison of the range values.
/// Returns <b>true</b> if one of the following are <b>true</b>
/// 1. Both spans are empty.
/// 2. They both point to the same range of data.

2
include/etl/to_arithmetic.h
View File

@ -397,7 +397,7 @@ namespace etl
TValue old_value = integral_value;
integral_value *= radix;
// No multipication overflow?
// No multiplication overflow?
is_not_overflow = ((integral_value / radix) == old_value);
if (is_not_overflow)

2
include/etl/type_traits.h
View File

@ -62,7 +62,7 @@ SOFTWARE.
///\defgroup type_traits type_traits
/// A set of type traits definitions.
/// Derived from either the standard or alternate definitions, dependant on whether or not ETL_NO_STL is defined.
/// Derived from either the standard or alternate definitions, dependent on whether or not ETL_NO_STL is defined.
/// \ingroup utilities
#if ETL_USING_STL && ETL_USING_CPP11

2
include/etl/unordered_map.h
View File

@ -1508,7 +1508,7 @@ namespace etl
}
//*********************************************************************
/// Delete a data noe at the specified location.
/// Delete a data node at the specified location.
//*********************************************************************
local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket)
{

2
include/etl/unordered_multimap.h
View File

@ -1362,7 +1362,7 @@ namespace etl
}
//*********************************************************************
/// Delete a data noe at the specified location.
/// Delete a data node at the specified location.
//*********************************************************************
local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket)
{

2
include/etl/unordered_multiset.h
View File

@ -1340,7 +1340,7 @@ namespace etl
}
//*********************************************************************
/// Delete a data noe at the specified location.
/// Delete a data node at the specified location.
//*********************************************************************
local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket)
{

2
include/etl/unordered_set.h
View File

@ -1366,7 +1366,7 @@ namespace etl
}
//*********************************************************************
/// Delete a data noe at the specified location.
/// Delete a data node at the specified location.
//*********************************************************************
local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket)
{

18
support/Release notes.txt
View File

@ -156,7 +156,7 @@ Comments and noexcept updates to placement new
etl::variant (variadic) refactor and updates for C++ standards compatibility
etl::overload available in C++17 only
map/flat_map speed optimisations
Various C++03 compatibilty updates for maps
Various C++03 compatibility updates for maps
Refactored Bash compilation scripts to allow selection of C++ standard and optimisation level
Renamed Bash compilation scripts. Changed 'sanity checks' to 'syntax checks
Some internal constant case changes from all upper to capital case
@ -222,7 +222,7 @@ Removed unused ETL_USE_MEM_BUILTINS option
===============================================================================
20.35.7
Updated etl::delgate to handle const functors correctly
Updated etl::delegate to handle const functors correctly
===============================================================================
20.35.6
@ -270,7 +270,7 @@ Removed duplicate include in etl::array_view
#621 No need to initialize the C-compiler, small speed improvement
#626 Empty etl::optional ctor storage initialization performance
Removed constexpr for etl::bit_cast due to unreliability of compiler support
Added has_value() as an alias for is_value() for etl::result (consistancy with STL conventions)
Added has_value() as an alias for is_value() for etl::result (consistency with STL conventions)
Added ETL_ERROR_WITH_VALUE macro for exceptions that require a value
Changed scaling template parameter for etl::scaled_rounding to uint32_t
Remove redundant etl::pair functions
@ -467,7 +467,7 @@ Fixed send_message function signatures.
20.24.0
#503 Algorithm transform uses expensive post increment operator - Fixed for all occurrences of iterator increment.
#504 ETL_CONSTANT vs const in binary.h - Fixed.
Many algorithms will leverage built-ins, if available. Dependant on compiler version.
Many algorithms will leverage built-ins, if available. Dependent on compiler version.
Added detection or selection of built-ins.
Much of etl::string and etl::string_view can be constexpr.
Added ETL initializer_list implementations that are compatible with major compilers.
@ -835,7 +835,7 @@ Added example application for shared messages.
Added a lockable queue with locks implemented as pure virtuals.
Refactored the other queues.
Fixed missing virtual destructor for C++11 observer.
Added etl::successor class for consistant 'chain of responsibilty' pattern generation.
Added etl::successor class for consistent 'chain of responsibilty' pattern generation.
Added missing constructors to unique_ptr.
Added nullptr check to unique_ptr destructor.
Fixed VS2019 warning for etl::deque iterators.
@ -1803,7 +1803,7 @@ Added constexpr constructors to string_view and array_view.
===============================================================================
14.8.2
Added missing #include "stl/interator.h" in frame_check_sequence.h
Added missing #include "stl/iterator.h" in frame_check_sequence.h
===============================================================================
14.8.1
@ -2036,7 +2036,7 @@ Added SPSC & MPPC queues
===============================================================================
11.3.0
Improved compatibility with 64 bit pltforms.
Improved compatibility with 64 bit platforms.
===============================================================================
11.2.0
@ -2073,7 +2073,7 @@ Improved etl::endianness. Added static functions.
===============================================================================
10.19.2
Fixed strict aliasing warnings for endianess.
Fixed strict aliasing warnings for endianness.
===============================================================================
10.19.1
@ -2082,7 +2082,7 @@ Fixed strict aliasing warnings for aligned storage.
===============================================================================
10.19.0
Added 'create' and 'destroy' functions to pools.
Modified class heirarchy.
Modified class hierarchy.
etl::generic_pool is derived from on etl::ipool.
etl::pool is derived from etl::generic_pool.

2
test/test_multimap.cpp
View File

@ -106,7 +106,7 @@ namespace
//*************************************************************************
struct SetupFixture
{
// Multimaps of predefined data from which to constuct multimaps used in
// Multimaps of predefined data from which to construct multimaps used in
// each test
std::multimap<std::string, int> initial_data;
std::multimap<std::string, int> excess_data;

2
test/test_multiset.cpp
View File

@ -121,7 +121,7 @@ namespace
//*************************************************************************
struct SetupFixture
{
// Multisets of predefined data from which to constuct multisets used in
// Multisets of predefined data from which to construct multisets used in
// each test
std::multiset<int> initial_data;
std::multiset<int> excess_data;