replace @ignore with @hidden (Azure#12963)

`@ignore` is a JSDoc construct which we no longer use. This PR replaces it with `TypeDoc`'s `@hidden` which [exhibits the same behavior](https://github.com/TypeStrong/typedoc/releases/tag/v0.12.0).

Author: deyaaeldeen

sdk/appconfiguration/app-configuration/src/internal/helpers.ts

@@ -161,8 +161,8 @@ export function makeConfigurationSettingEmpty(
 }
 
 /**
- * @internal
  * @hidden
+ * @internal
  */
 export function transformKeyValue(kvp: KeyValue): ConfigurationSetting {
   const obj: ConfigurationSetting & KeyValue = {
@@ -175,8 +175,8 @@ export function transformKeyValue(kvp: KeyValue): ConfigurationSetting {
 }
 
 /**
- * @internal
  * @hidden
+ * @internal
  */
 export function transformKeyValueResponseWithStatusCode<
   T extends KeyValue & HttpResponseField<any>
@@ -190,8 +190,8 @@ export function transformKeyValueResponseWithStatusCode<
 }
 
 /**
- * @internal
  * @hidden
+ * @internal
  */
 export function transformKeyValueResponse<
   T extends KeyValue & { eTag?: string } & HttpResponseField<any>

sdk/appconfiguration/app-configuration/tsdoc.json

@@ -3,4 +3,4 @@
     "extends": [
         "../../../tsdoc.json"
     ]
-}
+}

sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts

@@ -167,7 +167,7 @@ export const ConnectionConfig = {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  */
 export function isSharedAccessSignature(connectionString: string): boolean {
   return connectionString.match(/;{0,1}SharedAccessSignature=SharedAccessSignature /) != null;

sdk/core/core-amqp/src/errors.ts

@@ -9,7 +9,7 @@ import { isNode, isNumber, isString } from "../src/util/utils";
  * Maps the conditions to the numeric AMQP Response status codes.
  * @enum {ConditionStatusMapper}
  * @internal
- * @ignore
+ * @hidden
  */
 export enum ConditionStatusMapper {
   "com.microsoft:timeout" = AmqpResponseStatusCode.RequestTimeout,
@@ -457,7 +457,7 @@ export interface NetworkSystemError {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  */
 const systemErrorFieldsToCopy: (keyof Omit<NetworkSystemError, "name" | "message">)[] = [
   "address",
@@ -608,7 +608,7 @@ export function isSystemError(err: any): err is NetworkSystemError {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  * Since browser doesn't differentiate between the various kinds of service communication errors,
  * this utility is used to look at the error target to identify such category of errors.
  * For more information refer to - https://html.spec.whatwg.org/multipage/comms.html#feedback-from-the-protocol
@@ -629,7 +629,7 @@ function isBrowserWebsocketError(err: any): boolean {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  */
 const rheaPromiseErrors = [
   // OperationTimeoutError occurs when the service fails to respond within a given timeframe.
@@ -729,7 +729,7 @@ export function translate(err: AmqpError | Error): MessagingError | Error {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * @param {*} error
  * @returns {error is AmqpError}

sdk/core/core-amqp/src/log.ts

@@ -12,7 +12,7 @@ export const logger = createClientLogger("core-amqp");
 /**
  * Logs the error's stack trace to "verbose" if a stack trace is available.
  * @param error Error containing a stack trace.
- * @ignore
+ * @hidden
  */
 export function logErrorStackTrace(error: any): void {
   if (error && error.stack) {

sdk/core/core-amqp/src/requestResponseLink.ts

@@ -40,7 +40,7 @@ export interface SendRequestOptions {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  */
 export interface DeferredPromiseWithCallback {
   resolve: (value?: any) => void;
@@ -230,7 +230,7 @@ export class RequestResponseLink implements ReqResLink {
 }
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Type used in getCodeDescriptionAndError to get the normalized info from the responses emitted by EventHubs and ServiceBus.
  */
@@ -242,7 +242,7 @@ type NormalizedInfo = {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Handle different variations of property names in responses emitted by EventHubs and ServiceBus.
  *
@@ -271,7 +271,7 @@ export const getCodeDescriptionAndError = (props: any): NormalizedInfo => {
  * 5. User's code after the sendRequest continues.
  *
  * @internal
- * @ignore
+ * @hidden
  */
 export function onMessageReceived(
   context: Pick<EventContext, "message">,

sdk/core/core-amqp/src/retry.ts

@@ -11,7 +11,7 @@ import { checkNetworkConnection } from "./util/checkNetworkConnection";
 
 /**
  * Determines whether the object is a Delivery object.
- * @ignore
+ * @hidden
  */
 function isDelivery(obj: any): boolean {
   let result: boolean = false;
@@ -119,7 +119,7 @@ export interface RetryConfig<T> {
 
 /**
  * Validates the retry config.
- * @ignore
+ * @hidden
  */
 function validateRetryConfig<T>(config: RetryConfig<T>): void {
   if (!config.operation) {

sdk/core/core-amqp/src/util/checkNetworkConnection.browser.ts

@@ -3,7 +3,7 @@
 
 /**
  * Checks whether a network connection is detected.
- * @ignore
+ * @hidden
  * @internal
  */
 export function checkNetworkConnection(): Promise<boolean> {

sdk/core/core-amqp/src/util/checkNetworkConnection.ts

@@ -6,7 +6,7 @@ import { logger } from "../log";
 
 /**
  * Checks whether a network connection is detected.
- * @ignore
+ * @hidden
  * @internal
  */
 export function checkNetworkConnection(host: string): Promise<boolean> {

sdk/core/core-amqp/src/util/runtimeInfo.browser.ts

@@ -3,21 +3,21 @@
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * @interface Window
  */
 interface Window {}
 
 /**
  * @internal
- * @ignore
+ * @hidden
  */
 declare let self: Window & typeof globalThis & { navigator: Navigator };
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * @interface Navigator
  */
@@ -30,7 +30,7 @@ interface Navigator {
 
 /**
  * Returns information about the platform this function is being run on.
- * @ignore
+ * @hidden
  * @internal
  */
 export function getPlatformInfo(): string {
@@ -39,7 +39,7 @@ export function getPlatformInfo(): string {
 
 /**
  * Returns information about Node.js this function is being run on.
- * @ignore
+ * @hidden
  * @internal
  */
 export function getFrameworkInfo(): string {
@@ -48,7 +48,7 @@ export function getFrameworkInfo(): string {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * @returns {string}
  */