Added js doc comments

Author: muthurathinam-m

spec/middleware/TelemetryHandler.ts

@@ -83,7 +83,7 @@ describe("TelemetryHandler.ts", () => {
 		it("Should set sdk version header with feature flag", async () => {
 			try {
 				const telemetryOptions = new TelemetryHandlerOptions();
-				telemetryOptions.setFeatureUsage(FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
+				telemetryOptions["setFeatureUsage"](FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
 				const context: Context = {
 					request: "url",
 					options: {

spec/middleware/TelemetryHandlerOptions.ts

@@ -54,22 +54,22 @@ describe("TelemetryHandlerOptions.ts", () => {
 	describe("setFeatureUsage", () => {
 		it("Should set a given flags", () => {
 			const telemetryOptions = new TelemetryHandlerOptions();
-			telemetryOptions.setFeatureUsage(FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
-			telemetryOptions.setFeatureUsage(FeatureUsageFlag.RETRY_HANDLER_ENABLED);
+			telemetryOptions["setFeatureUsage"](FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
+			telemetryOptions["setFeatureUsage"](FeatureUsageFlag.RETRY_HANDLER_ENABLED);
 			assert.equal(telemetryOptions["featureUsage"] & FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED, FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
 			assert.equal(telemetryOptions["featureUsage"] & FeatureUsageFlag.RETRY_HANDLER_ENABLED, FeatureUsageFlag.RETRY_HANDLER_ENABLED);
 			assert.equal(telemetryOptions["featureUsage"] & FeatureUsageFlag.REDIRECT_HANDLER_ENABLED, FeatureUsageFlag.NONE);
 		});
 	});
-	/* tslint:enable: no-string-literal no-bitwise*/
 
 	describe("getFeatureUsage", () => {
 		it("Should return the feature usage in hexadecimal string", () => {
 			const telemetryOptions = new TelemetryHandlerOptions();
-			telemetryOptions.setFeatureUsage(FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
-			telemetryOptions.setFeatureUsage(FeatureUsageFlag.RETRY_HANDLER_ENABLED);
+			telemetryOptions["setFeatureUsage"](FeatureUsageFlag.AUTHENTICATION_HANDLER_ENABLED);
+			telemetryOptions["setFeatureUsage"](FeatureUsageFlag.RETRY_HANDLER_ENABLED);
 			const usageFlag = telemetryOptions.getFeatureUsage();
 			assert.equal(usageFlag, "6");
 		});
 	});
+	/* tslint:enable: no-string-literal no-bitwise*/
 });

src/middleware/MiddlewareControl.ts

@@ -40,13 +40,20 @@ export class MiddlewareControl {
 	/**
 	 * @public
 	 * To get the middleware option using the class name of the option
-	 * @param {string} name - The class name of the strongly types option class
+	 * @param {string} name - The class name of the strongly typed option class
 	 * @returns The middleware option
 	 */
 	public getMiddlewareOptions(name: string): MiddlewareOptions {
 		return this.middlewareOptions.get(name);
 	}
 
+	/**
+	 * @public
+	 * To set the middleware options using the class name of the option
+	 * @param {string} name - The class name of the strongly typed option class
+	 * @param {MiddlewareOptions} option - The strongly typed middleware option
+	 * @returns nothing
+	 */
 	public setMiddlewareOptions(name: string, option: MiddlewareOptions): void {
 		this.middlewareOptions.set(name, option);
 	}

src/middleware/TelemetryHandler.ts

@@ -23,12 +23,32 @@ import { TelemetryHandlerOptions } from "./options/TelemetryHandlerOptions";
  * Class for TelemetryHandler
  */
 export class TelemetryHandler implements Middleware {
+	/**
+	 * @private
+	 * @static
+	 * A member holding the name of the client request id header
+	 */
 	private static CLIENT_REQUEST_ID_HEADER = "client-request-id";
 
+	/**
+	 * @private
+	 * @static
+	 * A member holding the name of the sdk version header
+	 */
 	private static SDK_VERSION_HEADER = "SdkVersion";
 
+	/**
+	 * @private
+	 * @static
+	 * A member holding the language prefix for the sdk version header value
+	 */
 	private static PRODUCT_NAME = "graph-js";
 
+	/**
+	 * @private
+	 * @static
+	 * A member holding the key for the feature usage metrics
+	 */
 	private static FEATURE_USAGE_STRING = "featureUsage";
 
 	/**

src/middleware/options/TelemetryHandlerOptions.ts

@@ -14,6 +14,13 @@ import { MiddlewareControl } from "../MiddlewareControl";
 
 import { MiddlewareOptions } from "./IMiddlewareOptions";
 
+/**
+ * @enum
+ * @property {number} NONE - The hexadecimal flag value for nothing enabled
+ * @property {number} REDIRECT_HANDLER_ENABLED - The hexadecimal flag value for redirect handler enabled
+ * @property {number} RETRY_HANDLER_ENABLED - The hexadecimal flag value for retry handler enabled
+ * @property {number} AUTHENTICATION_HANDLER_ENABLED - The hexadecimal flag value for the authentication handler enabled
+ */
 export enum FeatureUsageFlag {
 	NONE = 0x0,
 	REDIRECT_HANDLER_ENABLED = 0x1,
@@ -28,8 +35,20 @@ export enum FeatureUsageFlag {
  */
 
 export class TelemetryHandlerOptions implements MiddlewareOptions {
+	/**
+	 * @private
+	 * A member to hold the OR of feature usage flags
+	 */
 	private featureUsage: FeatureUsageFlag = FeatureUsageFlag.NONE;
 
+	/**
+	 * @public
+	 * @static
+	 * To update the feature usage in the context object
+	 * @param {Context} context - The request context object containing middleware options
+	 * @param {FeatureUsageFlag} flag - The flag value
+	 * @returns nothing
+	 */
 	public static updateFeatureUsageFlag(context: Context, flag: FeatureUsageFlag): void {
 		let options: TelemetryHandlerOptions;
 		if (context.middlewareControl instanceof MiddlewareControl) {
@@ -44,12 +63,23 @@ export class TelemetryHandlerOptions implements MiddlewareOptions {
 		options.setFeatureUsage(flag);
 	}
 
-	public setFeatureUsage(flag: FeatureUsageFlag): void {
+	/**
+	 * @private
+	 * To set the feature usage flag
+	 * @param {FeatureUsageFlag} flag - The flag value
+	 * @returns nothing
+	 */
+	private setFeatureUsage(flag: FeatureUsageFlag): void {
 		/* tslint:disable: no-bitwise */
 		this.featureUsage = this.featureUsage | flag;
 		/* tslint:enable: no-bitwise */
 	}
 
+	/**
+	 * @public
+	 * To get the feature usage
+	 * @returns A feature usage flag as hexadecimal string
+	 */
 	public getFeatureUsage(): string {
 		return this.featureUsage.toString(16);
 	}