Skip to content

Commit 42d9cc0

Browse files
committed
Reference doc updates.
1 parent 219daed commit 42d9cc0

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

Release/include/cpprest/json.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,15 +386,15 @@ namespace json
386386
/// Parses a string and construct a JSON value.
387387
/// </summary>
388388
/// <param name="value">The C++ value to create a JSON value from, a C++ STL double-byte string</param>
389-
_ASYNCRTIMP static value parse(const utility::string_t&);
389+
_ASYNCRTIMP static value parse(const utility::string_t &value);
390390

391391
/// <summary>
392392
/// Attempts to parse a string and construct a JSON value.
393393
/// </summary>
394394
/// <param name="value">The C++ value to create a JSON value from, a C++ STL double-byte string</param>
395395
/// <param name="errorCode">If parsing fails, the error code is greater than 0</param>
396396
/// <returns>The parsed object. Returns web::json::value::null if failed</returns>
397-
_ASYNCRTIMP static value parse(const utility::string_t&, std::error_code&);
397+
_ASYNCRTIMP static value parse(const utility::string_t &value, std::error_code &errorCode);
398398

399399
/// <summary>
400400
/// Serializes the current JSON value to a C++ string.
@@ -422,7 +422,7 @@ namespace json
422422
/// <param name="input">The stream to read the JSON value from</param>
423423
/// <param name="errorCode">If parsing fails, the error code is greater than 0</param>
424424
/// <returns>The parsed object. Returns web::json::value::null if failed</returns>
425-
_ASYNCRTIMP static value parse(utility::istream_t &input, std::error_code& error);
425+
_ASYNCRTIMP static value parse(utility::istream_t &input, std::error_code &errorCode);
426426

427427
/// <summary>
428428
/// Writes the current JSON value to a stream with the native platform character width.

Release/include/cpprest/ws_client.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ namespace websockets
5858
namespace client
5959
{
6060

61+
/// Websocket close status values.
6162
enum class websocket_close_status
6263
{
6364
normal = 1000,
@@ -186,7 +187,7 @@ class websocket_client_config
186187
/// Adds a subprotocol to the request headers.
187188
/// </summary>
188189
/// <param name="name">The name of the subprotocol.</param>
189-
/// <remark>If additional subprotocols have already been specified, the new one will just be added.</remarks>
190+
/// <remarks>If additional subprotocols have already been specified, the new one will just be added.</remarks>
190191
_ASYNCRTIMP void add_subprotocol(const ::utility::string_t &name);
191192

192193
/// <summary>
@@ -430,7 +431,7 @@ class websocket_client
430431
/// <summary>
431432
/// Creates a new websocket_client.
432433
/// </summary>
433-
/// <param name="client_config">The client configuration object containing the possible configuration options to initialize the <c>websocket_client</c>. </param>
434+
/// <param name="config">The client configuration object containing the possible configuration options to initialize the <c>websocket_client</c>. </param>
434435
websocket_client(websocket_client_config config) :
435436
m_client(std::make_shared<details::websocket_client_task_impl>(std::move(config)))
436437
{}
@@ -599,7 +600,7 @@ class websocket_callback_client
599600
/// close_status: The pre-defined status codes used by the endpoint when sending a Close frame.
600601
/// reason: The reason string used by the endpoint when sending a Close frame.
601602
/// error: The error code if the websocket is closed with abnormal error.
602-
///</param>
603+
/// </param>
603604
void set_close_handler(const std::function<void(websocket_close_status close_status, const utility::string_t& reason, const std::error_code& error)>& handler)
604605
{
605606
m_client->set_close_handler(handler);

0 commit comments

Comments
 (0)