Skip to content

Commit

Permalink
Fix spelling mistakes across the library (#935)
Browse files Browse the repository at this point in the history
  • Loading branch information
ioannis-e authored and BillyONeal committed Oct 27, 2018
1 parent e5c6d84 commit ab5ced9
Show file tree
Hide file tree
Showing 22 changed files with 98 additions and 98 deletions.
4 changes: 2 additions & 2 deletions Release/include/cpprest/astreambuf.h
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ namespace streams
/// Gets a pointer to the next already allocated contiguous block of data.
/// </summary>
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
/// <remarks>
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
Expand Down Expand Up @@ -1020,7 +1020,7 @@ namespace streams
/// Gets a pointer to the next already allocated contiguous block of data.
/// </summary>
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
/// <remarks>
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
Expand Down
8 changes: 4 additions & 4 deletions Release/include/cpprest/asyncrt_utils.h
Original file line number Diff line number Diff line change
Expand Up @@ -424,31 +424,31 @@ namespace details
}

/// <summary>
/// Cross platform utility function for performing case insensitive string equality comparision.
/// Cross platform utility function for performing case insensitive string equality comparison.
/// </summary>
/// <param name="left">First string to compare.</param>
/// <param name="right">Second strong to compare.</param>
/// <returns>true if the strings are equivalent, false otherwise</returns>
_ASYNCRTIMP bool __cdecl str_iequal(const std::string &left, const std::string &right) CPPREST_NOEXCEPT;

/// <summary>
/// Cross platform utility function for performing case insensitive string equality comparision.
/// Cross platform utility function for performing case insensitive string equality comparison.
/// </summary>
/// <param name="left">First string to compare.</param>
/// <param name="right">Second strong to compare.</param>
/// <returns>true if the strings are equivalent, false otherwise</returns>
_ASYNCRTIMP bool __cdecl str_iequal(const std::wstring &left, const std::wstring &right) CPPREST_NOEXCEPT;

/// <summary>
/// Cross platform utility function for performing case insensitive string less-than comparision.
/// Cross platform utility function for performing case insensitive string less-than comparison.
/// </summary>
/// <param name="left">First string to compare.</param>
/// <param name="right">Second strong to compare.</param>
/// <returns>true if a lowercase view of left is lexicographically less than a lowercase view of right; otherwise, false.</returns>
_ASYNCRTIMP bool __cdecl str_iless(const std::string &left, const std::string &right) CPPREST_NOEXCEPT;

/// <summary>
/// Cross platform utility function for performing case insensitive string less-than comparision.
/// Cross platform utility function for performing case insensitive string less-than comparison.
/// </summary>
/// <param name="left">First string to compare.</param>
/// <param name="right">Second strong to compare.</param>
Expand Down
4 changes: 2 additions & 2 deletions Release/include/cpprest/base_uri.h
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ namespace web {
/// <summary>
/// A flexible, protocol independent URI implementation.
///
/// URI instances are immutable. Querying the various fields on an emtpy URI will return empty strings. Querying
/// URI instances are immutable. Querying the various fields on an empty URI will return empty strings. Querying
/// various diagnostic members on an empty URI will return false.
/// </summary>
/// <remarks>
Expand Down Expand Up @@ -305,7 +305,7 @@ namespace web {
/// A loopback URI is one which refers to a hostname or ip address with meaning only on the local machine.
/// </summary>
/// <remarks>
/// Examples include "locahost", or ip addresses in the loopback range (127.0.0.0/24).
/// Examples include "localhost", or ip addresses in the loopback range (127.0.0.0/24).
/// </remarks>
/// <returns><c>true</c> if this URI references the local host, <c>false</c> otherwise.</returns>
bool is_host_loopback() const
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/containerstream.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ namespace Concurrency { namespace streams {
/// Gets a pointer to the next already allocated contiguous block of data.
/// </summary>
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
/// <remarks>
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
Expand Down
8 changes: 4 additions & 4 deletions Release/include/cpprest/filestream.h
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ namespace details {
/// <summary>
/// Submits a block already allocated by the stream buffer.
/// </summary>
/// <param name="ptr">Count of characters to be commited.</param>
/// <param name="ptr">Count of characters to be committed.</param>
void _commit(size_t)
{
}
Expand All @@ -320,7 +320,7 @@ namespace details {
/// Gets a pointer to the next already allocated contiguous block of data.
/// </summary>
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
/// <remarks>
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
Expand Down Expand Up @@ -1033,7 +1033,7 @@ namespace details {
}

/// <summary>
/// Open a new ouput stream representing the given file.
/// Open a new output stream representing the given file.
/// If the file does not exist, it will be create unless the folder or directory
/// where it is to be found also does not exist.
/// </summary>
Expand Down Expand Up @@ -1079,7 +1079,7 @@ namespace details {
}

/// <summary>
/// Open a new ouput stream representing the given file.
/// Open a new output stream representing the given file.
/// If the file does not exist, it will be create unless the folder or directory
/// where it is to be found also does not exist.
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/http_client.h
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ class http_client_config

/// <summary>
/// Request that the server respond with a compressed body using Content-Encoding; to use Transfer-Encoding, do not
/// set this, and specify a vector of <see cref="web::http::details::comporession::decompress_factory" /> pointers
/// set this, and specify a vector of <see cref="web::http::details::compression::decompress_factory" /> pointers
/// to the set_decompress_factories method of the <see cref="web::http::http_request" /> object for the request.
/// If true and the server does not support compression, this will have no effect.
/// The response body is internally decompressed before the consumer receives the data.
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/http_msg.h
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ class http_msg_base
/// By default this is an invalid stream. The user could set the instream on
/// a request by calling set_request_stream(...). This would also be set when
/// set_body() is called - a stream from the body is constructed and set.
/// Even in the presense of msg body this stream could be invalid. An example
/// Even in the presence of msg body this stream could be invalid. An example
/// would be when the user sets an ostream for the response. With that API the
/// user does not provide the ability to read the msg body.
/// Thus m_instream is valid when there is a msg body and it can actually be read
Expand Down
14 changes: 7 additions & 7 deletions Release/include/cpprest/json.h
Original file line number Diff line number Diff line change
Expand Up @@ -524,14 +524,14 @@ namespace json
/// Compares two JSON values for equality.
/// </summary>
/// <param name="other">The JSON value to compare with.</param>
/// <returns>True iff the values are equal.</returns>
/// <returns>True if the values are equal.</returns>
_ASYNCRTIMP bool operator==(const value& other) const;

/// <summary>
/// Compares two JSON values for inequality.
/// </summary>
/// <param name="other">The JSON value to compare with.</param>
/// <returns>True iff the values are unequal.</returns>
/// <returns>True if the values are unequal.</returns>
bool operator!=(const value& other) const
{
return !((*this) == other);
Expand Down Expand Up @@ -1226,7 +1226,7 @@ namespace json
/// <summary>
/// Checks if there are any elements in the JSON object.
/// </summary>
/// <returns>True iff empty.</returns>
/// <returns>True if empty.</returns>
bool empty() const
{
return m_elements.empty();
Expand Down Expand Up @@ -1374,7 +1374,7 @@ namespace json
/// <summary>
/// Converts the JSON number to unsigned int32.
/// </summary>
/// <returns>An usigned int32 representation of the number</returns>
/// <returns>An unsigned int32 representation of the number</returns>
uint32_t to_uint32() const
{
if (m_type == double_type)
Expand Down Expand Up @@ -1420,7 +1420,7 @@ namespace json
/// Compares two JSON numbers for equality.
/// </summary>
/// <param name="other">The JSON number to compare with.</param>
/// <returns>True iff the numbers are equal.</returns>
/// <returns>True if the numbers are equal.</returns>
bool operator==(const number &other) const
{
if (m_type != other.m_type)
Expand Down Expand Up @@ -1689,7 +1689,7 @@ namespace json

utility::string_t m_string;

// There are significant performance gains that can be made by knowning whether
// There are significant performance gains that can be made by knowing whether
// or not a character that requires escaping is present.
bool m_has_escape_char;
static bool has_escape_chars(const _String &str);
Expand Down Expand Up @@ -1797,7 +1797,7 @@ namespace json
for(auto iter = m_object.begin(); iter != m_object.end(); ++iter)
{
reserveSize += iter->first.length() + 2; // 2 for quotes
size_t valueSize = iter->second.size() * 20; // Multipler by each object/array element
size_t valueSize = iter->second.size() * 20; // Multiply by each object/array element
if(valueSize == 0)
{
if(iter->second.type() == json::value::String)
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/producerconsumerstream.h
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ namespace Concurrency { namespace streams {
/// Gets a pointer to the next already allocated contiguous block of data.
/// </summary>
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
/// <remarks>
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/rawptrstream.h
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ namespace Concurrency { namespace streams {
/// Gets a pointer to the next already allocated contiguous block of data.
/// </summary>
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
/// <remarks>
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/streams.h
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ namespace Concurrency { namespace streams
};

/// <summary>
/// Class used to handle asychronous parsing for basic_istream::extract. To support new
/// Class used to handle asynchronous parsing for basic_istream::extract. To support new
/// types create a new template specialization and implement the parse function.
/// </summary>
template<typename CharType, typename T>
Expand Down
2 changes: 1 addition & 1 deletion Release/include/cpprest/ws_client.h
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ class websocket_client_config
}

/// <summary>
/// Gets the server host name to usefor TLS Server Name Indication (SNI).
/// Gets the server host name to use for TLS Server Name Indication (SNI).
/// </summary>
/// <returns>Host name as a string.</returns>
const utf8string & server_name() const
Expand Down
2 changes: 1 addition & 1 deletion Release/include/pplx/pplxcancellation_token.h
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ namespace details

//
// If a cancellation has occurred, the registration list is guaranteed to be empty if we've observed it under the auspices of the
// lock. In this case, we must synchronize with the cancelling thread to guarantee that the cancellation is finished by the time
// lock. In this case, we must synchronize with the canceling thread to guarantee that the cancellation is finished by the time
// we return from this method.
//
if (!_M_registrations.empty())
Expand Down
2 changes: 1 addition & 1 deletion Release/include/pplx/pplxlinux.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ namespace platform
_PPLXIMP void _pplx_cdecl YieldExecution();

/// <summary>
/// Caputeres the callstack
/// Captures the callstack
/// </summary>
__declspec(noinline) inline static size_t CaptureCallstack(void **, size_t, size_t)
{
Expand Down
Loading

0 comments on commit ab5ced9

Please sign in to comment.