Improve TSDoc documentation for Azure Cloud helpers (#3474)

* Initial plan

* Improve TSDoc documentation for Azure Cloud helpers with @enum, @param, @returns, and @throws tags

Co-authored-by: v-jiaodi <80496810+v-jiaodi@users.noreply.github.com>

* Fix CI error: Update generated NetworkAnalytics.Management package files

Co-authored-by: v-jiaodi <80496810+v-jiaodi@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: v-jiaodi <80496810+v-jiaodi@users.noreply.github.com>

Author: Copilot

packages/typespec-test/test/NetworkAnalytics.Management/generated/typespec-ts/sdk/test/arm-test/src/static-helpers/cloudSettingHelpers.ts

@@ -1,7 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-/** An enum to describe Azure Cloud. */
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
 export enum AzureClouds {
   /** Azure public cloud, which is the default cloud for Azure SDKs. */
   AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
@@ -14,6 +17,12 @@ export enum AzureClouds {
 /** The supported values for cloud setting as a string literal type */
 export type AzureSupportedClouds = `${AzureClouds}`;
 
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
 export function getArmEndpoint(
   cloudSetting?: AzureSupportedClouds,
 ): string | undefined {

packages/typespec-ts/static/static-helpers/cloudSettingHelpers.ts

@@ -1,4 +1,7 @@
-/** An enum to describe Azure Cloud. */
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
 export enum AzureClouds {
   /** Azure public cloud, which is the default cloud for Azure SDKs. */
   AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
@@ -11,6 +14,12 @@ export enum AzureClouds {
 /** The supported values for cloud setting as a string literal type */
 export type AzureSupportedClouds = `${AzureClouds}`;
 
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
 export function getArmEndpoint(
   cloudSetting?: AzureSupportedClouds
 ): string | undefined {