add jsdocs to modal service

src/Umbraco.Web.UI.Client/src/core/services/modal/modal.service.ts

@@ -22,14 +22,36 @@ export class UmbModalService {
 	private _modals: BehaviorSubject<Array<UmbModalHandler>> = new BehaviorSubject(<Array<UmbModalHandler>>[]);
 	public readonly modals: Observable<Array<UmbModalHandler>> = this._modals.asObservable();
 
+	/**
+	 * Opens a Confirm modal
+	 * @public
+	 * @param {UmbModalConfirmData} data
+	 * @return {*}  {UmbModalHandler}
+	 * @memberof UmbModalService
+	 */
 	public confirm(data: UmbModalConfirmData): UmbModalHandler {
 		return this.open('umb-modal-layout-confirm', { data, type: 'dialog' });
 	}
 
+	/**
+	 * Opens a Content Picker sidebar modal
+	 * @public
+	 * @param {UmbModalContentPickerData} [data]
+	 * @return {*}  {UmbModalHandler}
+	 * @memberof UmbModalService
+	 */
 	public contentPicker(data?: UmbModalContentPickerData): UmbModalHandler {
 		return this.open('umb-modal-layout-content-picker', { data, type: 'sidebar', size: 'small' });
 	}
 
+	/**
+	 * Opens a modal or sidebar modal
+	 * @public
+	 * @param {(string | HTMLElement)} element
+	 * @param {UmbModalOptions<unknown>} [options]
+	 * @return {*}  {UmbModalHandler}
+	 * @memberof UmbModalService
+	 */
 	public open(element: string | HTMLElement, options?: UmbModalOptions<unknown>): UmbModalHandler {
 		const modalHandler = new UmbModalHandler(element, options);
 
@@ -39,10 +61,22 @@ export class UmbModalService {
 		return modalHandler;
 	}
 
+	/**
+	 * Closes a modal or sidebar modal
+	 * @private
+	 * @param {string} key
+	 * @memberof UmbModalService
+	 */
 	private _close(key: string) {
 		this._modals.next(this._modals.getValue().filter((modal) => modal.key !== key));
 	}
 
+	/**
+	 * Handles the close-end event
+	 * @private
+	 * @param {UmbModalHandler} modalHandler
+	 * @memberof UmbModalService
+	 */
 	private _handleCloseEnd(modalHandler: UmbModalHandler) {
 		modalHandler.element.removeEventListener('close-end', () => this._handleCloseEnd(modalHandler));
 		this._close(modalHandler.key);