[JSDoc] Add annotations

Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
Victor Woeltjen
2015-08-07 11:44:54 -07:00
parent 14f97eae9c
commit c08a460d30
239 changed files with 939 additions and 185 deletions

View File

@ -33,4 +33,4 @@ define({
// Max width and margins allowed for bubbles; defined in /platform/commonUI/general/res/sass/_constants.scss
BUBBLE_MARGIN_LR: 10,
BUBBLE_MAX_WIDTH: 300
});
});

View File

@ -30,6 +30,7 @@ define(
* The `info` gesture displays domain object metadata in a
* bubble on hover.
*
* @memberof platform/commonUI/inspect
* @constructor
* @param $timeout Angular's `$timeout`
* @param {InfoService} infoService a service which shows info bubbles
@ -103,6 +104,7 @@ define(
* Detach any event handlers associated with this gesture.
* @memberof InfoGesture
* @method
* @memberof platform/commonUI/inspect.InfoGesture#
*/
destroy: function () {
// Dismiss any active bubble...
@ -119,3 +121,4 @@ define(
}
);

View File

@ -31,6 +31,7 @@ define(
/**
* Displays informative content ("info bubbles") for the user.
* @memberof platform/commonUI/inspect
* @constructor
*/
function InfoService($compile, $document, $window, $rootScope) {
@ -85,6 +86,7 @@ define(
* pixel coordinates.
* @returns {Function} a function that may be invoked to
* dismiss the info bubble
* @memberof platform/commonUI/inspect.InfoService#
*/
display: display
};
@ -93,3 +95,4 @@ define(
return InfoService;
}
);