[JSDoc] Add annotations
Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
@@ -32,6 +32,7 @@ define(
|
||||
* The dialog service is responsible for handling window-modal
|
||||
* communication with the user, such as displaying forms for user
|
||||
* input.
|
||||
* @memberof platform/commonUI/dialog
|
||||
* @constructor
|
||||
*/
|
||||
function DialogService(overlayService, $q, $log) {
|
||||
@@ -142,6 +143,7 @@ define(
|
||||
* user has supplied; this may be rejected if
|
||||
* user input cannot be obtained (for instance,
|
||||
* because the user cancelled the dialog)
|
||||
* @memberof platform/commonUI/dialog.DialogService#
|
||||
*/
|
||||
getUserInput: getUserInput,
|
||||
/**
|
||||
@@ -149,6 +151,7 @@ define(
|
||||
* which will be shown as buttons.
|
||||
*
|
||||
* @param dialogModel a description of the dialog to show
|
||||
* @memberof platform/commonUI/dialog.DialogService#
|
||||
*/
|
||||
getUserChoice: getUserChoice
|
||||
};
|
||||
@@ -156,4 +159,4 @@ define(
|
||||
|
||||
return DialogService;
|
||||
}
|
||||
);
|
||||
);
|
||||
|
||||
@@ -43,6 +43,7 @@ define(
|
||||
* particularly where a multiple-overlay effect is not specifically
|
||||
* desired).
|
||||
*
|
||||
* @memberof platform/commonUI/dialog
|
||||
* @constructor
|
||||
*/
|
||||
function OverlayService($document, $compile, $rootScope) {
|
||||
@@ -89,6 +90,7 @@ define(
|
||||
* @param {object} overlayModel the model to pass to the
|
||||
* included overlay template (this will be passed
|
||||
* in via ng-model)
|
||||
* @memberof platform/commonUI/dialog.OverlayService#
|
||||
*/
|
||||
createOverlay: createOverlay
|
||||
};
|
||||
@@ -96,4 +98,4 @@ define(
|
||||
|
||||
return OverlayService;
|
||||
}
|
||||
);
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user