From 480699d346a1c09662a8022652231da4e2a5356b Mon Sep 17 00:00:00 2001 From: Tony Wieser Date: Fri, 7 Jun 2019 11:43:37 +0100 Subject: [PATCH] Changed docs to address PR comments. --- src/middleware/MiddlewareControl.ts | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/middleware/MiddlewareControl.ts b/src/middleware/MiddlewareControl.ts index 83787d36a..857d9dc3e 100644 --- a/src/middleware/MiddlewareControl.ts +++ b/src/middleware/MiddlewareControl.ts @@ -41,9 +41,13 @@ 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 typed option class + * To get the middleware option using the class of the option + * @param {Function} fn - The class of the strongly typed option class * @returns The middleware option + * @example + * // if you wanted to return the middleware option associated with this class (MiddlewareControl) + * // call this function like this: + * getMiddlewareOptions(MiddlewareControl) */ // tslint:disable-next-line:ban-types public getMiddlewareOptions(fn: Function): MiddlewareOptions { @@ -52,8 +56,8 @@ export class MiddlewareControl { /** * @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 + * To set the middleware options using the class of the option + * @param {Function} fn - The class of the strongly typed option class * @param {MiddlewareOptions} option - The strongly typed middleware option * @returns nothing */