Skip to content

Commit ab5ced9

Browse files
ioannis-eBillyONeal
authored andcommitted
Fix spelling mistakes across the library (#935)
1 parent e5c6d84 commit ab5ced9

22 files changed

+98
-98
lines changed

Release/include/cpprest/astreambuf.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ namespace streams
343343
/// Gets a pointer to the next already allocated contiguous block of data.
344344
/// </summary>
345345
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
346-
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
346+
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
347347
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
348348
/// <remarks>
349349
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
@@ -1020,7 +1020,7 @@ namespace streams
10201020
/// Gets a pointer to the next already allocated contiguous block of data.
10211021
/// </summary>
10221022
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
1023-
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
1023+
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
10241024
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
10251025
/// <remarks>
10261026
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that

Release/include/cpprest/asyncrt_utils.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -424,31 +424,31 @@ namespace details
424424
}
425425

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

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

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

450450
/// <summary>
451-
/// Cross platform utility function for performing case insensitive string less-than comparision.
451+
/// Cross platform utility function for performing case insensitive string less-than comparison.
452452
/// </summary>
453453
/// <param name="left">First string to compare.</param>
454454
/// <param name="right">Second strong to compare.</param>

Release/include/cpprest/base_uri.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ namespace web {
9494
/// <summary>
9595
/// A flexible, protocol independent URI implementation.
9696
///
97-
/// URI instances are immutable. Querying the various fields on an emtpy URI will return empty strings. Querying
97+
/// URI instances are immutable. Querying the various fields on an empty URI will return empty strings. Querying
9898
/// various diagnostic members on an empty URI will return false.
9999
/// </summary>
100100
/// <remarks>
@@ -305,7 +305,7 @@ namespace web {
305305
/// A loopback URI is one which refers to a hostname or ip address with meaning only on the local machine.
306306
/// </summary>
307307
/// <remarks>
308-
/// Examples include "locahost", or ip addresses in the loopback range (127.0.0.0/24).
308+
/// Examples include "localhost", or ip addresses in the loopback range (127.0.0.0/24).
309309
/// </remarks>
310310
/// <returns><c>true</c> if this URI references the local host, <c>false</c> otherwise.</returns>
311311
bool is_host_loopback() const

Release/include/cpprest/containerstream.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ namespace Concurrency { namespace streams {
170170
/// Gets a pointer to the next already allocated contiguous block of data.
171171
/// </summary>
172172
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
173-
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
173+
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
174174
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
175175
/// <remarks>
176176
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that

Release/include/cpprest/filestream.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ namespace details {
311311
/// <summary>
312312
/// Submits a block already allocated by the stream buffer.
313313
/// </summary>
314-
/// <param name="ptr">Count of characters to be commited.</param>
314+
/// <param name="ptr">Count of characters to be committed.</param>
315315
void _commit(size_t)
316316
{
317317
}
@@ -320,7 +320,7 @@ namespace details {
320320
/// Gets a pointer to the next already allocated contiguous block of data.
321321
/// </summary>
322322
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
323-
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
323+
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
324324
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
325325
/// <remarks>
326326
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that
@@ -1033,7 +1033,7 @@ namespace details {
10331033
}
10341034

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

10811081
/// <summary>
1082-
/// Open a new ouput stream representing the given file.
1082+
/// Open a new output stream representing the given file.
10831083
/// If the file does not exist, it will be create unless the folder or directory
10841084
/// where it is to be found also does not exist.
10851085
/// </summary>

Release/include/cpprest/http_client.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ class http_client_config
257257

258258
/// <summary>
259259
/// Request that the server respond with a compressed body using Content-Encoding; to use Transfer-Encoding, do not
260-
/// set this, and specify a vector of <see cref="web::http::details::comporession::decompress_factory" /> pointers
260+
/// set this, and specify a vector of <see cref="web::http::details::compression::decompress_factory" /> pointers
261261
/// to the set_decompress_factories method of the <see cref="web::http::http_request" /> object for the request.
262262
/// If true and the server does not support compression, this will have no effect.
263263
/// The response body is internally decompressed before the consumer receives the data.

Release/include/cpprest/http_msg.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ class http_msg_base
432432
/// By default this is an invalid stream. The user could set the instream on
433433
/// a request by calling set_request_stream(...). This would also be set when
434434
/// set_body() is called - a stream from the body is constructed and set.
435-
/// Even in the presense of msg body this stream could be invalid. An example
435+
/// Even in the presence of msg body this stream could be invalid. An example
436436
/// would be when the user sets an ostream for the response. With that API the
437437
/// user does not provide the ability to read the msg body.
438438
/// Thus m_instream is valid when there is a msg body and it can actually be read

Release/include/cpprest/json.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -524,14 +524,14 @@ namespace json
524524
/// Compares two JSON values for equality.
525525
/// </summary>
526526
/// <param name="other">The JSON value to compare with.</param>
527-
/// <returns>True iff the values are equal.</returns>
527+
/// <returns>True if the values are equal.</returns>
528528
_ASYNCRTIMP bool operator==(const value& other) const;
529529

530530
/// <summary>
531531
/// Compares two JSON values for inequality.
532532
/// </summary>
533533
/// <param name="other">The JSON value to compare with.</param>
534-
/// <returns>True iff the values are unequal.</returns>
534+
/// <returns>True if the values are unequal.</returns>
535535
bool operator!=(const value& other) const
536536
{
537537
return !((*this) == other);
@@ -1226,7 +1226,7 @@ namespace json
12261226
/// <summary>
12271227
/// Checks if there are any elements in the JSON object.
12281228
/// </summary>
1229-
/// <returns>True iff empty.</returns>
1229+
/// <returns>True if empty.</returns>
12301230
bool empty() const
12311231
{
12321232
return m_elements.empty();
@@ -1374,7 +1374,7 @@ namespace json
13741374
/// <summary>
13751375
/// Converts the JSON number to unsigned int32.
13761376
/// </summary>
1377-
/// <returns>An usigned int32 representation of the number</returns>
1377+
/// <returns>An unsigned int32 representation of the number</returns>
13781378
uint32_t to_uint32() const
13791379
{
13801380
if (m_type == double_type)
@@ -1420,7 +1420,7 @@ namespace json
14201420
/// Compares two JSON numbers for equality.
14211421
/// </summary>
14221422
/// <param name="other">The JSON number to compare with.</param>
1423-
/// <returns>True iff the numbers are equal.</returns>
1423+
/// <returns>True if the numbers are equal.</returns>
14241424
bool operator==(const number &other) const
14251425
{
14261426
if (m_type != other.m_type)
@@ -1689,7 +1689,7 @@ namespace json
16891689

16901690
utility::string_t m_string;
16911691

1692-
// There are significant performance gains that can be made by knowning whether
1692+
// There are significant performance gains that can be made by knowing whether
16931693
// or not a character that requires escaping is present.
16941694
bool m_has_escape_char;
16951695
static bool has_escape_chars(const _String &str);
@@ -1797,7 +1797,7 @@ namespace json
17971797
for(auto iter = m_object.begin(); iter != m_object.end(); ++iter)
17981798
{
17991799
reserveSize += iter->first.length() + 2; // 2 for quotes
1800-
size_t valueSize = iter->second.size() * 20; // Multipler by each object/array element
1800+
size_t valueSize = iter->second.size() * 20; // Multiply by each object/array element
18011801
if(valueSize == 0)
18021802
{
18031803
if(iter->second.type() == json::value::String)

Release/include/cpprest/producerconsumerstream.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ namespace Concurrency { namespace streams {
178178
/// Gets a pointer to the next already allocated contiguous block of data.
179179
/// </summary>
180180
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
181-
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
181+
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
182182
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
183183
/// <remarks>
184184
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that

Release/include/cpprest/rawptrstream.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ namespace Concurrency { namespace streams {
205205
/// Gets a pointer to the next already allocated contiguous block of data.
206206
/// </summary>
207207
/// <param name="ptr">A reference to a pointer variable that will hold the address of the block on success.</param>
208-
/// <param name="count">The number of contiguous characters available at the address in 'ptr.'</param>
208+
/// <param name="count">The number of contiguous characters available at the address in 'ptr'.</param>
209209
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise.</returns>
210210
/// <remarks>
211211
/// A return of false does not necessarily indicate that a subsequent read operation would fail, only that

Release/include/cpprest/streams.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ namespace Concurrency { namespace streams
496496
};
497497

498498
/// <summary>
499-
/// Class used to handle asychronous parsing for basic_istream::extract. To support new
499+
/// Class used to handle asynchronous parsing for basic_istream::extract. To support new
500500
/// types create a new template specialization and implement the parse function.
501501
/// </summary>
502502
template<typename CharType, typename T>

Release/include/cpprest/ws_client.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ class websocket_client_config
142142
}
143143

144144
/// <summary>
145-
/// Gets the server host name to usefor TLS Server Name Indication (SNI).
145+
/// Gets the server host name to use for TLS Server Name Indication (SNI).
146146
/// </summary>
147147
/// <returns>Host name as a string.</returns>
148148
const utf8string & server_name() const

Release/include/pplx/pplxcancellation_token.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ namespace details
506506

507507
//
508508
// If a cancellation has occurred, the registration list is guaranteed to be empty if we've observed it under the auspices of the
509-
// lock. In this case, we must synchronize with the cancelling thread to guarantee that the cancellation is finished by the time
509+
// lock. In this case, we must synchronize with the canceling thread to guarantee that the cancellation is finished by the time
510510
// we return from this method.
511511
//
512512
if (!_M_registrations.empty())

Release/include/pplx/pplxlinux.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ namespace platform
5959
_PPLXIMP void _pplx_cdecl YieldExecution();
6060

6161
/// <summary>
62-
/// Caputeres the callstack
62+
/// Captures the callstack
6363
/// </summary>
6464
__declspec(noinline) inline static size_t CaptureCallstack(void **, size_t, size_t)
6565
{

0 commit comments

Comments
 (0)