[Workers] Update JSDoc

...per review feedback, nasa/openmctweb#309
This commit is contained in:
Victor Woeltjen
2015-11-20 11:10:33 -08:00
parent ef5a26dfcc
commit 38274728f6

View File

@@ -65,8 +65,12 @@ define(
* that has been registered under the `workers` category * that has been registered under the `workers` category
* of extension. * of extension.
* *
* This will return either a Worker or a SharedWorker,
* depending on whether a `shared` flag has been specified
* on the the extension definition for the referenced worker.
*
* @param {string} key symbolic identifier for the worker * @param {string} key symbolic identifier for the worker
* @returns {Worker} the running Worker * @returns {Worker | SharedWorker} the running Worker
*/ */
WorkerService.prototype.run = function (key) { WorkerService.prototype.run = function (key) {
var scriptUrl = this.workerUrls[key], var scriptUrl = this.workerUrls[key],