From 92839dcc5681961946d093555f9b8b9dfc96d2e5 Mon Sep 17 00:00:00 2001 From: Rick Winter Date: Fri, 14 May 2021 16:42:25 -0700 Subject: [PATCH] A few spot fixes in docs (#2275) --- sdk/core/azure-core/inc/azure/core/base64.hpp | 4 ++-- sdk/core/azure-core/inc/azure/core/context.hpp | 6 ++++-- sdk/core/azure-core/inc/azure/core/modified_conditions.hpp | 2 +- sdk/core/azure-core/inc/azure/core/nullable.hpp | 6 +++--- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/sdk/core/azure-core/inc/azure/core/base64.hpp b/sdk/core/azure-core/inc/azure/core/base64.hpp index c5e35f602..5c143ca41 100644 --- a/sdk/core/azure-core/inc/azure/core/base64.hpp +++ b/sdk/core/azure-core/inc/azure/core/base64.hpp @@ -15,8 +15,8 @@ namespace Azure { namespace Core { /** - *@brief Used to convert one form of data into another, for example encoding binary data into - *base 64 text. + * @brief Used to convert one form of data into another, for example encoding binary data into + * base 64 text. */ class Convert final { private: diff --git a/sdk/core/azure-core/inc/azure/core/context.hpp b/sdk/core/azure-core/inc/azure/core/context.hpp index 0cc1b79da..ca740b61f 100644 --- a/sdk/core/azure-core/inc/azure/core/context.hpp +++ b/sdk/core/azure-core/inc/azure/core/context.hpp @@ -141,6 +141,7 @@ namespace Azure { namespace Core { /** * @brief Create a context without a deadline, but with \p key and \p value associated with it. * + * @tparam T The type of the value to be stored with the key. * @param key A key to associate with this context. * @param value A value to associate with this context. * @@ -165,6 +166,7 @@ namespace Azure { namespace Core { * @brief Try to get a value associated with a \p key parameter within this context or the * branch of contexts this context belongs to. * + * @tparam T The type of the value to be retrieved. * @param key A key associated with a context to find. * @param outputValue A reference to the value corresponding to the \p key to be set, if found * within the context tree. @@ -201,13 +203,13 @@ namespace Azure { namespace Core { } /** - * @brief Check if the context is cancelled. + * @brief Checks if the context is cancelled. * @return `true` if this context is cancelled, `false` otherwise. */ bool IsCancelled() const noexcept { return GetDeadline() < std::chrono::system_clock::now(); } /** - * @brief Throw an exception if the context was cancelled. + * @brief Throws an exception if the context is cancelled. * */ void ThrowIfCancelled() const diff --git a/sdk/core/azure-core/inc/azure/core/modified_conditions.hpp b/sdk/core/azure-core/inc/azure/core/modified_conditions.hpp index c6ed37850..6125beaa7 100644 --- a/sdk/core/azure-core/inc/azure/core/modified_conditions.hpp +++ b/sdk/core/azure-core/inc/azure/core/modified_conditions.hpp @@ -22,7 +22,7 @@ namespace Azure { struct ModifiedConditions { /** - * @brief Destructor. + * @brief Destructs the ModifiedConditions. * */ virtual ~ModifiedConditions() = default; diff --git a/sdk/core/azure-core/inc/azure/core/nullable.hpp b/sdk/core/azure-core/inc/azure/core/nullable.hpp index 048a55958..d3e2f0318 100644 --- a/sdk/core/azure-core/inc/azure/core/nullable.hpp +++ b/sdk/core/azure-core/inc/azure/core/nullable.hpp @@ -74,7 +74,7 @@ public: } /** - * @brief Destroy the contained value, if there is one. + * @brief Destructs the Nullable, destructs the contained value if there is one. * */ ~Nullable() @@ -86,7 +86,7 @@ public: } /** - * @brief Destroy any contained value, if there is one. + * @brief Destructs the contained value, if there is one. * */ void Reset() noexcept /* enforces termination */ @@ -99,7 +99,7 @@ public: } /** - * @brief Exchange the contents. + * @brief Exchanges the contents. * * @param other An instance to exchange the contents with. */