replace @ignore with @hidden

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}
  */

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

@@ -5,7 +5,7 @@ import * as os from "os";
 
 /**
  * Returns information about the platform this function is being run on.
- * @ignore
+ * @hidden
  * @internal
  */
 export function getPlatformInfo(): string {
@@ -14,7 +14,7 @@ export function getPlatformInfo(): string {
 
 /**
  * Returns information about Node.js this function is being run on.
- * @ignore
+ * @hidden
  * @internal
  */
 export function getFrameworkInfo(): string {

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

@@ -8,7 +8,7 @@ import { WebSocketImpl } from "rhea-promise";
 export { AsyncLock };
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Describes the options that can be provided to create an async lock.
  */
@@ -56,7 +56,7 @@ export interface WebSocketOptions {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * A constant that indicates whether the environment is node.js or browser based.
  */
@@ -117,7 +117,7 @@ export function parseConnectionString<T>(connectionString: string): ParsedOutput
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Gets a new instance of the async lock with desired settings.
  * @param {AsyncLockOptions} [options] The async lock options.
@@ -134,7 +134,7 @@ export const defaultLock: AsyncLock = new AsyncLock({ maxPending: 10000 });
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Describes a Timeout class that can wait for the specified amount of time and then resolve/reject
  * the promise with the given value.
@@ -236,7 +236,7 @@ export function delay<T>(
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Generates a random number between the given interval
  * @param {number} min Min number of the range (inclusive).
@@ -248,7 +248,7 @@ export function randomNumberFromInterval(min: number, max: number): number {
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Type declaration for a Function type where T is the input to the function and V is the output
  * of the function.
@@ -257,7 +257,7 @@ export type Func<T, V> = (a: T) => V;
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Executes an array of promises sequentially. Inspiration of this method is here:
  * https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises!
@@ -282,7 +282,7 @@ export function executePromisesSequentially(
 
 /**
  * @internal
- * @ignore
+ * @hidden
  *
  * Determines whether the given connection string is an iothub connection string.
  * @param {string} connectionString The connection string.
@@ -300,15 +300,15 @@ export function isIotHubConnectionString(connectionString: string): boolean {
 }
 
 /**
- * @ignore
+ * @hidden
  * @internal
  */
 export function isString(s: any): s is string {
   return typeof s === "string";
 }
 
 /**
- * @ignore
+ * @hidden
  * @internal
  */
 export function isNumber(n: any): n is number {

sdk/core/core-amqp/tsdoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../../tsdoc.json"]
+}

sdk/core/core-client/src/base64.ts

@@ -4,7 +4,7 @@
 /**
  * Encodes a string in base64 format.
  * @param value the string to encode
- * @internal @ignore
+ * @internal @hidden
  */
 export function encodeString(value: string): string {
   return Buffer.from(value).toString("base64");
@@ -13,7 +13,7 @@ export function encodeString(value: string): string {
 /**
  * Encodes a byte array in base64 format.
  * @param value the Uint8Aray to encode
- * @internal @ignore
+ * @internal @hidden
  */
 export function encodeByteArray(value: Uint8Array): string {
   // Buffer.from accepts <ArrayBuffer> | <SharedArrayBuffer>-- the TypeScript definition is off here
@@ -25,7 +25,7 @@ export function encodeByteArray(value: Uint8Array): string {
 /**
  * Decodes a base64 string into a byte array.
  * @param value the base64 string to decode
- * @internal @ignore
+ * @internal @hidden
  */
 export function decodeString(value: string): Uint8Array {
   return Buffer.from(value, "base64");

sdk/core/core-client/src/createSpan.ts

@@ -9,7 +9,7 @@ type OperationTracingOptions = OperationOptions["tracingOptions"];
 
 /**
  * Creates a function called createSpan to create spans using the global tracer.
- * @ignore
+ * @hidden
  * @param spanConfig The name of the operation being performed.
  * @param tracingOptions The options for the underlying http request.
  */

sdk/core/core-client/src/interfaceHelpers.ts

@@ -5,7 +5,7 @@ import { MapperTypeNames } from "./serializer";
 import { OperationSpec, OperationParameter } from "./interfaces";
 
 /**
- * @internal @ignore
+ * @internal @hidden
  */
 export function isStreamOperation(operationSpec: OperationSpec): boolean {
   for (const statusCode in operationSpec.responses) {
@@ -24,7 +24,7 @@ export function isStreamOperation(operationSpec: OperationSpec): boolean {
  * Get the path to this parameter's value as a dotted string (a.b.c).
  * @param parameter The parameter to get the path string for.
  * @returns The path to this parameter's value as a dotted string.
- * @internal @ignore
+ * @internal @hidden
  */
 export function getPathStringFromParameter(parameter: OperationParameter): string {
   const { parameterPath, mapper } = parameter;

sdk/core/core-client/src/operationHelpers.ts

@@ -10,7 +10,7 @@ import {
 } from "./interfaces";
 
 /**
- * @internal @ignore
+ * @internal @hidden
  * Retrieves the value to use for a given operation argument
  * @param operationArguments The arguments passed from the generated client
  * @param parameter The parameter description