Document final/virtual destructor changes (#2256)

sdk/core/azure-core/CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Removed `Context::GetApplicationContext()` in favor of a new static data member `Context::ApplicationContext`.
 - Renamed `Request::IsDownloadViaStream()` to `ShouldBufferResponse()`.
 - Removed the `Azure::Core::Http::Request` ctor overload that takes both a `bodyStream` and a `bufferedDownload` boolean since it is not useful.

sdk/core/azure-core/inc/azure/core/internal/client_options.hpp

@@ -24,6 +24,10 @@ namespace Azure { namespace Core { namespace _internal {
    */
   struct ClientOptions
   {
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~ClientOptions() = default;
 
     /**

sdk/core/azure-core/inc/azure/core/modified_conditions.hpp

@@ -20,6 +20,10 @@ namespace Azure {
  */
 struct ModifiedConditions
 {
+  /**
+   * @brief Destructor.
+   *
+   */
   virtual ~ModifiedConditions() = default;
 
   /**

sdk/core/azure-core/inc/azure/core/paged_response.hpp

@@ -40,6 +40,10 @@ namespace Azure { namespace Core {
     PagedResponse& operator=(PagedResponse&&) = default;
 
   public:
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~PagedResponse() = default;
 
     /**

sdk/identity/azure-identity/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 1.0.0-beta.6 (Unreleased)
 
+### Breaking Changes
+
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 
 ## 1.0.0-beta.5 (2021-04-07)
 

sdk/keyvault/azure-security-keyvault-common/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Removed `KeyVaultException`.
 - Removed `ClientOptions`.
 

sdk/keyvault/azure-security-keyvault-keys/CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Renamed `GetPropertiesOfKeysSinglePage()` to `GetPropertiesOfKeys()`.
 - Renamed `GetPropertiesOfKeyVersionsSinglePage()` to `GetPropertiesOfKeyVersions()`.
 - Renamed `GetDeletedKeysSinglePage()` to `GetDeletedKeys()`.

sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client.hpp

@@ -61,6 +61,10 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
     std::shared_ptr<Azure::Security::KeyVault::_internal::KeyVaultPipeline> m_pipeline;
 
   public:
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~KeyClient() = default;
 
     /**

sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_create_options.hpp

@@ -29,6 +29,10 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
    */
   struct CreateKeyOptions
   {
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~CreateKeyOptions() = default;
 
     /**

sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_vault_key.hpp

@@ -25,6 +25,10 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
    */
   struct KeyVaultKey
   {
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~KeyVaultKey() = default;
 
     /**

sdk/storage/azure-storage-blobs/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Renamed `HasMorePages()` in paged response to `HasPage()`.
 - Default chunk size for concurrent upload was changed to nullable.
 - `BlobLeaseClient::Change()` updates internal lease id.

sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_client.hpp

@@ -33,6 +33,10 @@ namespace Azure { namespace Storage { namespace Blobs {
    */
   class BlobClient {
   public:
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~BlobClient() = default;
 
     /**

sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_options.hpp

@@ -31,6 +31,10 @@ namespace Azure { namespace Storage { namespace Blobs {
    */
   struct TagAccessConditions
   {
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~TagAccessConditions() = default;
 
     /**

sdk/storage/azure-storage-common/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Removed `Azure::PagedResponse<T>`.
 
 ### Bug Fixes

sdk/storage/azure-storage-common/inc/azure/storage/common/access_conditions.hpp

@@ -17,6 +17,10 @@ namespace Azure { namespace Storage {
    */
   struct LeaseAccessConditions
   {
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~LeaseAccessConditions() = default;
 
     /**

sdk/storage/azure-storage-files-datalake/CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Renamed `HasMorePages()` in paged response to `HasPage()`.
 - Default chunk size for concurrent upload was changed to nullable.
 - `DataLakeLeaseClient::Change()` updates internal lease id.

sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_path_client.hpp

@@ -23,6 +23,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
 
   class DataLakePathClient {
   public:
+    /**
+     * @brief Destructor.
+     *
+     */
     virtual ~DataLakePathClient() = default;
 
     /**

sdk/storage/azure-storage-files-shares/CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Breaking Changes
 
+- Added `final` specifier to classes and structures that are are not expected to be inheritable at the moment.
 - Renamed `HasMorePages()` in paged response to `HasPage()`.
 - `ShareLeaseClient::Change()` updates internal lease id.
 - `ShareItem::ShareMetadata` was renamed to `ShareItem::Metadata`.