A few spot fixes in docs (#2275)

This commit is contained in:
Rick Winter 2021-05-14 16:42:25 -07:00 committed by GitHub
parent 0b64ab3845
commit 92839dcc56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 8 deletions

View File

@ -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:

View File

@ -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

View File

@ -22,7 +22,7 @@ namespace Azure {
struct ModifiedConditions
{
/**
* @brief Destructor.
* @brief Destructs the ModifiedConditions.
*
*/
virtual ~ModifiedConditions() = default;

View File

@ -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.
*/