From 7dfed8b06e38010d21abad5658c33986c654c5d5 Mon Sep 17 00:00:00 2001 From: Malte Restorff Date: Wed, 1 Jul 2020 11:56:34 +0200 Subject: [PATCH] convert comments on Dialog.onDIalogEvent() to TSDoc --- libraries/botbuilder-dialogs/src/dialog.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/libraries/botbuilder-dialogs/src/dialog.ts b/libraries/botbuilder-dialogs/src/dialog.ts index 64979043b1..da90e45c1a 100644 --- a/libraries/botbuilder-dialogs/src/dialog.ts +++ b/libraries/botbuilder-dialogs/src/dialog.ts @@ -480,13 +480,13 @@ export abstract class Dialog extends Configurable { // No-op by default } - /// - /// Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. - /// - /// The dialog context for the current turn of conversation. - /// The event being raised. - /// The cancellation token. - /// True if the event is handled by the current dialog and bubbling should stop. + /** + * Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. + * + * @param dc - The dialog context for the current turn of conversation. + * @param e - The event being raised. + * @returns True if the event is handled by the current dialog and bubbling should stop. + */ public async onDialogEvent(dc: DialogContext, e: DialogEvent): Promise { // Before bubble let handled = await this.onPreBubbleEvent(dc, e);