ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-23 06:52:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[API] Add JSDoc for Dialog

Browse Source
This commit is contained in:
Victor Woeltjen 2016-09-06 09:58:08 -07:00
parent 4de069b393
commit 7a5cad20ec
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/ui/Dialog.js
View File

@ -1,9 +1,24 @@
define(['text!./dialog.html', 'zepto'], function (dialogTemplate, $) { define(['text!./dialog.html', 'zepto'], function (dialogTemplate, $) {
/**
* A dialog may be displayed to show blocking content to users.
* @param {module:openmct.View} view the view to show in the dialog
* @param {string [title] the title for this dialog
* @constructor
* @memberof module:openmct
*/
function Dialog(view, title) { function Dialog(view, title) {
this.view = view; this.view = view;
this.title = title; this.title = title;
} }
/**
* Display this dialog.
* @returns {Promise} a promise that will be resolved if the user
* chooses "OK", an rejected if the user chooses "cancel"
* @method show
* @memberof module:openmct.Dialog#
*/
Dialog.prototype.show = function () { Dialog.prototype.show = function () {
var $body = $('body'); var $body = $('body');
var $dialog = $(dialogTemplate); var $dialog = $(dialogTemplate);