github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

2559 doc warnings (#2573)

Browse Source 
* fix doc warnings

* format
This commit is contained in:
George Arama 2021-07-07 15:23:22 -07:00 committed by GitHub
parent fe54edf017
commit e8efcd21fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sdk/core/azure-core/inc/azure/core/internal/json/json.hpp
View File

@ -5997,7 +5997,7 @@ namespace Azure { namespace Core { namespace Json { namespace _internal { namesp
@param[in, out] result A reference to the string variable where the read
string is to be stored.
@return `true` if the \x00-byte indicating the end of the string was
encountered before the EOF; false` indicates an unexpected EOF.
encountered before the EOF; `false` indicates an unexpected EOF.
*/
bool get_bson_cstr(string_t& result)
{

8
sdk/core/azure-core/inc/azure/core/url.hpp
View File

@ -116,7 +116,7 @@ namespace Azure { namespace Core {
/**
* @brief Sets URL host.
*
* @param host URL host.
* @param encodedHost URL host, already encoded.
*/
void SetHost(const std::string& encodedHost) { m_host = encodedHost; }
@ -130,7 +130,7 @@ namespace Azure { namespace Core {
/**
* @brief Sets URL path.
*
* @param path URL path.
* @param encodedPath URL path, already encoded.
*/
void SetPath(const std::string& encodedPath) { m_encodedPath = encodedPath; }
@ -139,7 +139,7 @@ namespace Azure { namespace Core {
*
* @note Keys and values in \p queryParameters are expected to be URL-encoded.
*
* @param queryParameters
* @param queryParameters query parameters for request.
*/
void SetQueryParameters(std::map<std::string, std::string> queryParameters)
{
@ -152,7 +152,7 @@ namespace Azure { namespace Core {
/**
* @brief Appends an element of URL path.
*
* @param path URL path element to append.
* @param encodedPath URL path element to append, already encoded.
*/
void AppendPath(const std::string& encodedPath)
{

6
sdk/core/azure-core/src/http/curl/curl_connection_private.hpp
View File

@ -118,9 +118,11 @@ namespace Azure { namespace Core { namespace Http {
public:
/**
* @Brief Construct CURL HTTP connection.
* @brief Construct CURL HTTP connection.
*
* @param host HTTP connection host name.
* @param handle CURL handle.
*
* @param connectionPropertiesKey CURL connection properties key
*/
CurlConnection(CURL* handle, std::string connectionPropertiesKey)
: m_handle(handle), m_connectionKey(std::move(connectionPropertiesKey))