[main] eliminate warning raised by tsdoc

AISKU/src/AISku.ts

@@ -628,7 +628,6 @@ export class AppInsightsSku implements IApplicationInsights {
      * Log a user action or other occurrence.
      * @param event
      * @param [customProperties]
-     * @memberof Initialization
      */
     public trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -637,7 +636,6 @@ export class AppInsightsSku implements IApplicationInsights {
     /**
      * Logs that a page, or similar container was displayed to the user.
      * @param pageView
-     * @memberof Initialization
      */
     public trackPageView(pageView?: IPageViewTelemetry) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -646,7 +644,6 @@ export class AppInsightsSku implements IApplicationInsights {
     /**
      * Log a bag of performance information via the customProperties field.
      * @param pageViewPerformance
-     * @memberof Initialization
      */
     public trackPageViewPerformance(pageViewPerformance: IPageViewPerformanceTelemetry): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -656,7 +653,6 @@ export class AppInsightsSku implements IApplicationInsights {
      * Log an exception that you have caught.
      * @param exception
      * @param } customProperties   Additional data used to filter pages and metrics in the portal. Defaults to empty.
-     * @memberof Initialization
      */
     public trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -666,7 +662,6 @@ export class AppInsightsSku implements IApplicationInsights {
      * Manually send uncaught exception telemetry. This method is automatically triggered
      * on a window.onerror event.
      * @param exception
-     * @memberof Initialization
      */
     public _onerror(exception: IAutoExceptionTelemetry): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -676,7 +671,6 @@ export class AppInsightsSku implements IApplicationInsights {
      * Log a diagnostic scenario such entering or leaving a function.
      * @param trace
      * @param [customProperties]
-     * @memberof Initialization
      */
     public trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -694,7 +688,6 @@ export class AppInsightsSku implements IApplicationInsights {
      * the `sampleCount` field of {@link IMetricTelemetry}.
      * @param metric - input object argument. Only `name` and `average` are mandatory.
      * @param [customProperties]
-     * @memberof Initialization
      */
     public trackMetric(metric: IMetricTelemetry, customProperties?: ICustomProperties): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -766,7 +759,6 @@ export class AppInsightsSku implements IApplicationInsights {
     /**
      * Log a dependency call (e.g. ajax)
      * @param dependency
-     * @memberof Initialization
      */
     public trackDependencyData(dependency: IDependencyTelemetry): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -796,7 +788,6 @@ export class AppInsightsSku implements IApplicationInsights {
      * Manually trigger an immediate send of all telemetry still in the buffer using beacon Sender.
      * Fall back to xhr sender if beacon is not supported.
      * @param [async=true]
-     * @memberof Initialization
      */
     public onunloadFlush(async: boolean = true) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -805,7 +796,6 @@ export class AppInsightsSku implements IApplicationInsights {
     /**
      * Initialize this instance of ApplicationInsights
      * @returns {IApplicationInsights}
-     * @memberof Initialization
      * @param legacyMode - MUST always be false, it is no longer supported from v3.x onwards
      */
     public loadAppInsights(legacyMode: boolean = false, logger?: IDiagnosticLogger, notificationManager?: INotificationManager): IApplicationInsights {
@@ -817,15 +807,13 @@ export class AppInsightsSku implements IApplicationInsights {
      * Overwrite the lazy loaded fields of global window snippet to contain the
      * actual initialized API methods
      * @param snippet
-     * @memberof Initialization
      */
     public updateSnippetDefinitions(snippet: Snippet) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 
     /**
      * Call any functions that were queued before the main script was loaded
-     * @memberof Initialization
      */
     public emptyQueue() {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -863,7 +851,7 @@ export class AppInsightsSku implements IApplicationInsights {
      * @param unloadComplete - An optional callback that will be called once the unload has completed
      * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the
      * unload. Defaults to 5 seconds.
-     * @return Nothing or if occurring asynchronously a [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
+     * @returns Nothing or if occurring asynchronously a [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
      * which will be resolved once the unload is complete, the [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
      * will only be returned when no callback is provided and isAsync is true
      */

AISKU/src/IApplicationInsights.ts

@@ -51,7 +51,7 @@ export interface IApplicationInsights extends IAppInsights, IDependenciesPlugin,
      * @param unloadComplete - An optional callback that will be called once the unload has completed
      * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the
      * unload. Defaults to 5 seconds.
-     * @return Nothing or if occurring asynchronously a [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
+     * @returns Nothing or if occurring asynchronously a [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
      * which will be resolved once the unload is complete, the [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
      * will only be returned when no callback is provided and isAsync is true
      */

AISKU/tsdoc.json

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

AISKULight/src/index.ts

@@ -37,7 +37,6 @@ export class ApplicationInsights {
     /**
      * Creates an instance of ApplicationInsights.
      * @param config
-     * @memberof ApplicationInsights
      */
     constructor(config: IConfiguration & IConfig) {
         let core = new AppInsightsCore();
@@ -148,7 +147,6 @@ export class ApplicationInsights {
     /**
      * Initialize this instance of ApplicationInsights
      *
-     * @memberof ApplicationInsights
      */
     public initialize(): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -158,7 +156,6 @@ export class ApplicationInsights {
      * Send a manually constructed custom event
      *
      * @param item
-     * @memberof ApplicationInsights
      */
     public track(item: ITelemetryItem) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -167,7 +164,6 @@ export class ApplicationInsights {
     /**
      * Immediately send all batched telemetry
      * @param [async=true]
-     * @memberof ApplicationInsights
      */
     public flush(async: boolean = true) {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -192,7 +188,7 @@ export class ApplicationInsights {
      * @param unloadComplete - An optional callback that will be called once the unload has completed
      * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the
      * unload. Defaults to 5 seconds.
-     * @return Nothing or if occurring asynchronously a [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
+     * @returns Nothing or if occurring asynchronously a [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
      * which will be resolved once the unload is complete, the [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
      * will only be returned when no callback is provided and isAsync is true
      */

AISKULight/tsdoc.json

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

channels/1ds-post-js/tsdoc.json

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

channels/applicationinsights-channel-js/tsdoc.json

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

channels/offline-channel-js/src/Helpers/Utils.ts

@@ -11,7 +11,7 @@ import { IPostTransmissionTelemetryItem } from "../Interfaces/IInMemoryBatch";
 /**
 * Checks if the value is a valid EventPersistence.
 * @param {enum} value - The value that needs to be checked.
-* @return {boolean} True if the value is in EventPersistence, false otherwise.
+* @returns {boolean} True if the value is in EventPersistence, false otherwise.
 */
 export function isValidPersistenceLevel(value: EventPersistence | number): boolean {
     return (isNumber(value) && value >= eLoggingSeverity.DISABLED && value <= EventPersistence.Critical);
@@ -64,7 +64,7 @@ const _base64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+
  *
  * @param data the Uint8Array or string to encode.
  *
- * @return the base64-encoded output string.
+ * @returns the base64-encoded output string.
  */
 export function base64Encode(data: string | Uint8Array) {
     let line = "";
@@ -105,7 +105,7 @@ export function base64Encode(data: string | Uint8Array) {
 /**
  * Base64-decodes an encoded string and transforms it back to a Uint8Array.
  * @param input the encoded string to decode
- * @return  Uint8Array
+ * @returns  Uint8Array
  */
 export function base64Decode(input: string) {
     var output = "";

channels/offline-channel-js/src/Interfaces/IOfflineProvider.ts

@@ -266,7 +266,7 @@ export interface IOfflineProvider {
      * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
      * can optionally use this to access the current core instance or define / pass additional information
      * to later plugins (vs appending items to the telemetry item)
-     * @return Either the added element (for synchronous operation) or a Promise for an asynchronous processing
+     * @returns Either the added element (for synchronous operation) or a Promise for an asynchronous processing
      */
     addEvent(key: string, evt: IStorageTelemetryItem, itemCtx: IProcessTelemetryContext): IStorageTelemetryItem | IPromise<IStorageTelemetryItem> | null;
 
@@ -285,13 +285,13 @@ export interface IOfflineProvider {
     /**
      * Removes the value associated with the provided key
      * @param evts - The events to be removed
-     * @return Either the removed item array (for synchronous operation) or a Promise for an asynchronous processing
+     * @returns Either the removed item array (for synchronous operation) or a Promise for an asynchronous processing
      */
     removeEvents(evts: IStorageTelemetryItem[]): IStorageTelemetryItem[] | IPromise<IStorageTelemetryItem[]> | null;
 
     /**
      * Removes all entries from the storage provider, if there are any.
-     * @return Either the removed item array (for synchronous operation) or a Promise for an asynchronous processing
+     * @returns Either the removed item array (for synchronous operation) or a Promise for an asynchronous processing
      */
     clear(): IStorageTelemetryItem[] | IPromise<IStorageTelemetryItem[]> | null;
 

channels/offline-channel-js/tsdoc.json

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

channels/tee-channel-js/tsdoc.json

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

extensions/applicationinsights-analytics-js/src/JavaScriptSDK/AnalyticsPlugin.ts

@@ -204,7 +204,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
              * @description Log a diagnostic message
              * @param trace
              * @param ICustomProperties.
-             * @memberof ApplicationInsights
              */
             _self.trackTrace = (trace: ITraceTelemetry, customProperties?: ICustomProperties): void => {
                 try {
@@ -233,7 +232,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
              * @param metric - input object argument. Only name and average are mandatory.
              * @param } customProperties additional data used to filter metrics in the
              * portal. Defaults to empty.
-             * @memberof ApplicationInsights
              */
             _self.trackMetric = (metric: IMetricTelemetry, customProperties?: ICustomProperties): void => {
                 try {
@@ -454,7 +452,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
              * @param } customProperties   Additional data used to filter pages and metrics in the portal. Defaults to empty.
              *
              * Any property of type double will be considered a measurement, and will be treated by Application Insights as a metric.
-             * @memberof ApplicationInsights
              */
             _self.trackException = (exception: IExceptionTelemetry, customProperties?: ICustomProperties): void => {
                 if (exception && !exception.exception && (exception as any).error) {
@@ -475,7 +472,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
             /**
              * @description Custom error handler for Application Insights Analytics
              * @param exception
-             * @memberof ApplicationInsights
              */
             _self._onerror = (exception: IAutoExceptionTelemetry): void => {
                 let error = exception && exception.error;
@@ -961,7 +957,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
      * @description Log a diagnostic message
      * @param trace
      * @param ICustomProperties.
-     * @memberof ApplicationInsights
      */
     public trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -976,7 +971,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
      * @param metric - input object argument. Only name and average are mandatory.
      * @param } customProperties additional data used to filter metrics in the
      * portal. Defaults to empty.
-     * @memberof ApplicationInsights
      */
     public trackMetric(metric: IMetricTelemetry, customProperties?: ICustomProperties): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -1059,7 +1053,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
      * @param } customProperties   Additional data used to filter pages and metrics in the portal. Defaults to empty.
      *
      * Any property of type double will be considered a measurement, and will be treated by Application Insights as a metric.
-     * @memberof ApplicationInsights
      */
     public trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
@@ -1068,7 +1061,6 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
     /**
      * @description Custom error handler for Application Insights Analytics
      * @param exception
-     * @memberof ApplicationInsights
      */
     public _onerror(exception: IAutoExceptionTelemetry): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging

extensions/applicationinsights-analytics-js/tsdoc.json

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

extensions/applicationinsights-angularplugin-js/tsdoc.json

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

extensions/applicationinsights-cfgsync-js/tsdoc.json

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

extensions/applicationinsights-clickanalytics-js/tsdoc.json

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

extensions/applicationinsights-debugplugin-js/tsdoc.json

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

extensions/applicationinsights-dependencies-js/tsdoc.json

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

extensions/applicationinsights-osplugin-js/src/DataModels.ts

@@ -15,14 +15,12 @@ export interface IOSPluginConfiguration {
      * Maximum time to wait for the OS plugin to return the OS information
      * Default: 200
      * @type {number}
-     * @memberof IOSPluginConfiguration
      */
     maxTimeout?: number;
     /**
      * Whether to merge the OS name and version into one field
      * Default: undefined
      * @type {boolean}
-     * @memberof IOSPluginConfiguration
      */
     mergeOsNameVersion?: boolean;
 }

extensions/applicationinsights-osplugin-js/tsdoc.json

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

extensions/applicationinsights-perfmarkmeasure-js/tsdoc.json

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

extensions/applicationinsights-properties-js/tsdoc.json

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

shared/1ds-core-js/src/ValueSanitizer.ts

@@ -73,7 +73,7 @@ export class ValueSanitizer implements IValueSanitizer {
 
     /**
      * Returns whether this ValueSanitizer is empty
-     * @return `true` if it contains no chained sanitizers or field sanitizers, otherwise `false`
+     * @returns `true` if it contains no chained sanitizers or field sanitizers, otherwise `false`
      */
     public isEmpty?: () => boolean;