From 825607952fdbcd915eb02912431155e61a170770 Mon Sep 17 00:00:00 2001 From: David Lechner Date: Fri, 8 Apr 2022 11:22:46 -0500 Subject: [PATCH] newFileWizard: doc comments --- src/explorer/newFileWizard/actions.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/explorer/newFileWizard/actions.ts b/src/explorer/newFileWizard/actions.ts index 7837137d..2ce71e67 100644 --- a/src/explorer/newFileWizard/actions.ts +++ b/src/explorer/newFileWizard/actions.ts @@ -24,10 +24,19 @@ export enum Hub { Essential = 'essentialhub', } +/** + * Requests to show the new file wizard dialog. + */ export const newFileWizardShow = createAction(() => ({ type: 'explorer.newFileWizard.action.show', })); +/** + * Indicates that the use accepted the new file wizard dialog. + * @param fileName The user-provided file name. + * @param fileExtension The user-provided file extension. + * @param hubType The user-provided hub type. + */ export const newFileWizardDidAccept = createAction( (fileName: string, fileExtension: SupportedFileExtension, hubType: Hub) => ({ type: 'explorer.newFileWizard.action.didAccept', @@ -37,6 +46,9 @@ export const newFileWizardDidAccept = createAction( }), ); +/** + * Indicates that the use accepted the new file wizard dialog. + */ export const newFileWizardDidCancel = createAction(() => ({ type: 'explorer.newFileWizard.action.didCancel', }));