identicalize the comments type (#4063)

Azure · Oct 26, 2022 · 673bacb · 673bacb
1 parent 4de2423
commit 673bacb
Show file tree

Hide file tree

Showing 12 changed files with 144 additions and 51 deletions.
diff --git a/sdk/core/azure-core-tracing-opentelemetry/src/private/package_version.hpp b/sdk/core/azure-core-tracing-opentelemetry/src/private/package_version.hpp
@@ -21,20 +21,27 @@
 namespace Azure { namespace Core { namespace OpenTelemetry { namespace _detail {
   /**
    * @brief Provides version information.
-   *
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_CORE_OPENTELEMETRY_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_CORE_OPENTELEMETRY_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_CORE_OPENTELEMETRY_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_CORE_OPENTELEMETRY_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/core/azure-core/src/private/package_version.hpp b/sdk/core/azure-core/src/private/package_version.hpp
@@ -21,20 +21,27 @@
 namespace Azure { namespace Core { namespace _detail {
   /**
    * @brief Provides version information.
-   *
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_CORE_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_CORE_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_CORE_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease = sizeof(AZURE_CORE_VERSION_PRERELEASE) != sizeof("");
 
     /**

diff --git a/sdk/identity/azure-identity/src/private/package_version.hpp b/sdk/identity/azure-identity/src/private/package_version.hpp
@@ -21,20 +21,30 @@
 namespace Azure { namespace Identity { namespace _detail {
   /**
    * @brief Provides version information.
-   *
    */
   class PackageVersion final {
   public:
+    /**
+     * @brief Major numeric identifier.
+     */
     /// Major numeric identifier.
     static constexpr int32_t Major = AZURE_IDENTITY_VERSION_MAJOR;
 
+    /**
+     * @brief Minor numeric identifier.
+     */
     /// Minor numeric identifier.
     static constexpr int32_t Minor = AZURE_IDENTITY_VERSION_MINOR;
 
+    /**
+     * @brief Patch numeric identifier.
+     */
     /// Patch numeric identifier.
     static constexpr int32_t Patch = AZURE_IDENTITY_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease = sizeof(AZURE_IDENTITY_VERSION_PRERELEASE) != sizeof("");
 
     /**

diff --git a/sdk/keyvault/azure-security-keyvault-certificates/src/private/package_version.hpp b/sdk/keyvault/azure-security-keyvault-certificates/src/private/package_version.hpp
@@ -23,20 +23,27 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Certificat
   namespace _detail {
     /**
      * @brief Provides version information.
-     *
      */
     class PackageVersion final {
     public:
-      /// Major numeric identifier.
+      /**
+       * @brief Major numeric identifier.
+       */
       static constexpr int32_t Major = AZURE_SECURITY_KEYVAULT_CERTIFICATES_VERSION_MAJOR;
 
-      /// Minor numeric identifier.
+      /**
+       * @brief Minor numeric identifier.
+       */
       static constexpr int32_t Minor = AZURE_SECURITY_KEYVAULT_CERTIFICATES_VERSION_MINOR;
 
-      /// Patch numeric identifier.
+      /**
+       * @brief Patch numeric identifier.
+       */
       static constexpr int32_t Patch = AZURE_SECURITY_KEYVAULT_CERTIFICATES_VERSION_PATCH;
 
-      /// Indicates whether the SDK is in a pre-release state.
+      /**
+       * @brief Indicates whether the SDK is in a pre-release state.
+       */
       static constexpr bool IsPreRelease
           = sizeof(AZURE_SECURITY_KEYVAULT_CERTIFICATES_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/keyvault/azure-security-keyvault-keys/src/private/package_version.hpp b/sdk/keyvault/azure-security-keyvault-keys/src/private/package_version.hpp
@@ -22,20 +22,27 @@
 namespace Azure { namespace Security { namespace KeyVault { namespace Keys { namespace _detail {
   /**
    * @brief Provides version information.
-   *
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_SECURITY_KEYVAULT_KEYS_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_SECURITY_KEYVAULT_KEYS_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_SECURITY_KEYVAULT_KEYS_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_SECURITY_KEYVAULT_KEYS_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/keyvault/azure-security-keyvault-secrets/src/private/package_version.hpp b/sdk/keyvault/azure-security-keyvault-secrets/src/private/package_version.hpp
@@ -22,20 +22,27 @@
 namespace Azure { namespace Security { namespace KeyVault { namespace Secrets { namespace _detail {
   /**
    * @brief Provides version information.
-   *
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_SECURITY_KEYVAULT_SECRETS_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_SECURITY_KEYVAULT_SECRETS_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_SECURITY_KEYVAULT_SECRETS_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_SECURITY_KEYVAULT_SECRETS_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/storage/azure-storage-blobs/src/private/package_version.hpp b/sdk/storage/azure-storage-blobs/src/private/package_version.hpp
@@ -22,16 +22,24 @@ namespace Azure { namespace Storage { namespace Blobs { namespace _detail {
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_STORAGE_BLOBS_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_STORAGE_BLOBS_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_STORAGE_BLOBS_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_STORAGE_BLOBS_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/storage/azure-storage-common/src/private/package_version.hpp b/sdk/storage/azure-storage-common/src/private/package_version.hpp
@@ -24,16 +24,24 @@ namespace Azure { namespace Storage { namespace Common { namespace _detail {
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int Major = AZURE_STORAGE_COMMON_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int Minor = AZURE_STORAGE_COMMON_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int Patch = AZURE_STORAGE_COMMON_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_STORAGE_COMMON_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/storage/azure-storage-files-datalake/src/private/package_version.hpp b/sdk/storage/azure-storage-files-datalake/src/private/package_version.hpp
@@ -23,16 +23,24 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake { nam
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_STORAGE_FILES_DATALAKE_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_STORAGE_FILES_DATALAKE_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_STORAGE_FILES_DATALAKE_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_STORAGE_FILES_DATALAKE_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/storage/azure-storage-files-shares/src/private/package_version.hpp b/sdk/storage/azure-storage-files-shares/src/private/package_version.hpp
@@ -22,16 +22,24 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares { names
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_STORAGE_FILES_SHARES_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_STORAGE_FILES_SHARES_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_STORAGE_FILES_SHARES_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_STORAGE_FILES_SHARES_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/storage/azure-storage-queues/src/private/package_version.hpp b/sdk/storage/azure-storage-queues/src/private/package_version.hpp
@@ -22,16 +22,24 @@ namespace Azure { namespace Storage { namespace Queues { namespace _detail {
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int32_t Major = AZURE_STORAGE_QUEUES_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int32_t Minor = AZURE_STORAGE_QUEUES_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int32_t Patch = AZURE_STORAGE_QUEUES_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease
         = sizeof(AZURE_STORAGE_QUEUES_VERSION_PRERELEASE) != sizeof("");
 

diff --git a/sdk/template/azure-template/src/private/package_version.hpp b/sdk/template/azure-template/src/private/package_version.hpp
@@ -22,16 +22,24 @@ namespace Azure { namespace Template { namespace _detail {
    */
   class PackageVersion final {
   public:
-    /// Major numeric identifier.
+    /**
+     * @brief Major numeric identifier.
+     */
     static constexpr int Major = AZURE_TEMPLATE_VERSION_MAJOR;
 
-    /// Minor numeric identifier.
+    /**
+     * @brief Minor numeric identifier.
+     */
     static constexpr int Minor = AZURE_TEMPLATE_VERSION_MINOR;
 
-    /// Patch numeric identifier.
+    /**
+     * @brief Patch numeric identifier.
+     */
     static constexpr int Patch = AZURE_TEMPLATE_VERSION_PATCH;
 
-    /// Indicates whether the SDK is in a pre-release state.
+    /**
+     * @brief Indicates whether the SDK is in a pre-release state.
+     */
     static constexpr bool IsPreRelease = sizeof(AZURE_TEMPLATE_VERSION_PRERELEASE) != sizeof("");
 
     /**