[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

@ -32,6 +32,7 @@ define(
* * Storing arbitrary JavaScript objects (not just strings.)
* * Allowing inspection of dragged objects during `dragover` events,
* etc. (which cannot be done in Chrome for security reasons)
* @memberof platform/representation
* @constructor
* @param $log Angular's $log service
*/
@ -43,6 +44,7 @@ define(
* Set drag data associated with a given type.
* @param {string} key the type's identiifer
* @param {*} value the data being dragged
* @memberof platform/representation.DndService#
*/
setData: function (key, value) {
$log.debug("Setting drag data for " + key);
@ -51,6 +53,7 @@ define(
/**
* Get drag data associated with a given type.
* @returns {*} the data being dragged
* @memberof platform/representation.DndService#
*/
getData: function (key) {
return data[key];
@ -58,6 +61,7 @@ define(
/**
* Remove data associated with active drags.
* @param {string} key the type to remove
* @memberof platform/representation.DndService#
*/
removeData: function (key) {
$log.debug("Clearing drag data for " + key);
@ -68,4 +72,4 @@ define(
return DndService;
}
);
);