fix finish for shared-core

shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/IDiagnosticLogger.ts

@@ -28,7 +28,7 @@ export interface IDiagnosticLogger {
 
     /**
      * This will write a debug message to the console if possible
-     * @param message - {string} - The debug message
+     * @param message - The debug message
      */
     debugToConsole? (message: string): void
 

shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/IFeatureOptIn.ts

@@ -9,7 +9,7 @@ export interface IFeatureOptInDetails {
     /**
      * Identifies configuration override values when given feature is enabled
      * NOTE: should use flat string for fields, for example, if you want to set value for extensionConfig.Ananlytics.disableAjaxTrackig in configurations,
-     * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: {["extensionConfig.Analytics.disableAjaxTrackig"]:1}
+     * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: \{["extensionConfig.Analytics.disableAjaxTrackig"]:1\}
      * Default: undefined
      */
     onCfg?: {[field: string]: any};

shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ISenderPostManager.ts

@@ -68,9 +68,9 @@ export interface _ISendPostMgrConfig {
     disableCredentials?: boolean;
 
     /**
-     * Identifies if XMLHttpRequest or XDomainRequest (for IE < 9) should be used
+     * Identifies if `XMLHttpRequest` or `XDomainRequest` (for IE version before 9) should be used
      * Default: false
-     * @since version after 3.1.0
+     * @since 3.1.1
      */
     disableXhr?: boolean;
 

shared/AppInsightsCore/src/JavaScriptSDK/AppInsightsCore.ts

@@ -81,8 +81,8 @@ const defaultConfig: IConfigDefaults<IConfiguration> = objDeepFreeze({
 
 /**
  * Helper to create the default performance manager
- * @param core
- * @param notificationMgr
+ * @param core - The AppInsightsCore instance
+ * @param notificationMgr - The notification manager
  */
 function _createPerfManager (core: IAppInsightsCore, notificationMgr: INotificationManager) {
     return new PerfManager(notificationMgr);
@@ -1563,7 +1563,7 @@ export class AppInsightsCore<CfgType extends IConfiguration = IConfiguration> im
     /**
      * Watches and tracks changes for accesses to the current config, and if the accessed config changes the
      * handler will be recalled.
-     * @param handler
+     * @param handler - The watcher handler to call when the config changes
      * @returns A watcher handler instance that can be used to remove itself when being unloaded
      */
     public onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook {

shared/AppInsightsCore/src/JavaScriptSDK/DiagnosticLogger.ts

@@ -258,7 +258,7 @@ export class DiagnosticLogger implements IDiagnosticLogger {
     /**
      * 0: OFF (default)
      * 1: CRITICAL
-     * 2: >= WARNING
+     * 2: \>= WARNING
      */
     public consoleLoggingLevel(): number {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging

shared/AppInsightsCore/src/JavaScriptSDK/EventHelpers.ts

@@ -254,9 +254,9 @@ export function eventOn<T>(target: T, eventName: string, handlerRef: any, evtNam
 /**
  * Removes an event handler for the specified event
  * @param Object - to remove the event from
- * @param eventName - {string} - The name of the event, with optional namespaces or just the namespaces,
+ * @param eventName - The name of the event, with optional namespaces or just the namespaces,
  * such as "click", "click.mynamespace" or ".mynamespace"
- * @param handlerRef - {any} - The callback function that needs to be removed from the given event, when using a
+ * @param handlerRef - The callback function that needs to be removed from the given event, when using a
  * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
  * otherwise this will only remove events with this specific handler.
  * @param evtNamespace - [Optional] Additional namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace,
@@ -319,7 +319,7 @@ export function detachEvent(obj: any, eventNameWithoutOn: string, handlerRef: an
  * @param eventName  - The name of the event
  * @param callback  - The callback function that needs to be executed for the given event
  * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
- * @returns {boolean} - true if the handler was successfully added
+ * @returns - true if the handler was successfully added
  */
 export function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[] | null): boolean {
     let result = false;

shared/AppInsightsCore/src/JavaScriptSDK/HelperFuncs.ts

@@ -165,8 +165,8 @@ function _createProxyFunction<S>(source: S | (() => S), funcName: (keyof S)) {
  *
  * Special ES3 Notes:
  * Updates (setting) of direct property values on the target or indirectly on the source object WILL NOT WORK PROPERLY, updates to the
- * properties of "referenced" object will work (target.context.newValue = 10 => will be reflected in the source.context as it's the
- * same object). ES3 Failures: assigning target.myProp = 3 -> Won't change source.myProp = 3, likewise the reverse would also fail.
+ * properties of "referenced" object will work (target.context.newValue = 10 =\> will be reflected in the source.context as it's the
+ * same object). ES3 Failures: assigning target.myProp = 3 -\> Won't change source.myProp = 3, likewise the reverse would also fail.
  * @param target - The target object to be assigned with the source properties and functions
  * @param source - The source object which will be assigned / called by setting / calling the targets proxies
  * @param chkSet - An optional callback to determine whether a specific property/function should be proxied