ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-12 20:28:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[JSDoc] Add annotations

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

2
platform/persistence/queue/src/PersistenceFailureConstants.js
View File

@ -26,4 +26,4 @@ define({
OVERWRITE_KEY: "overwrite",
TIMESTAMP_FORMAT: "YYYY-MM-DD HH:mm:ss\\Z",
UNKNOWN_USER: "unknown user"
});
});

6
platform/persistence/queue/src/PersistenceFailureController.js
View File

@ -29,11 +29,14 @@ define(
/**
* Controller to support the template to be shown in the
* dialog shown for persistence failures.
* @constructor
* @memberof platform/persistence/queue
*/
function PersistenceFailureController() {
return {
/**
* Format a timestamp for display in the dialog.
* @memberof platform/persistence/queue.PersistenceFailureController#
*/
formatTimestamp: function (timestamp) {
return moment.utc(timestamp)
@ -41,6 +44,7 @@ define(
},
/**
* Format a user name for display in the dialog.
* @memberof platform/persistence/queue.PersistenceFailureController#
*/
formatUsername: function (username) {
return username || Constants.UNKNOWN_USER;
@ -50,4 +54,4 @@ define(
return PersistenceFailureController;
}
);
);

4
platform/persistence/queue/src/PersistenceFailureDialog.js
View File

@ -41,6 +41,8 @@ define(
/**
* Populates a `dialogModel` to pass to `dialogService.getUserChoise`
* in order to choose between Overwrite and Cancel.
* @constructor
* @memberof platform/persistence/queue
*/
function PersistenceFailureDialog(failures) {
var revisionErrors = [],
@ -72,4 +74,4 @@ define(
return PersistenceFailureDialog;
}
);
);

4
platform/persistence/queue/src/PersistenceFailureHandler.js
View File

@ -121,6 +121,8 @@ define(
* to overwrite/cancel as appropriate.
* @param {Array} failures persistence failures, as prepared
* by PersistenceQueueHandler
* @constructor
* @memberof platform/persistence/queue
*/
handle: handleFailures
};
@ -128,4 +130,4 @@ define(
return PersistenceFailureHandler;
}
);
);

4
platform/persistence/queue/src/PersistenceQueue.js
View File

@ -50,6 +50,8 @@ define(
* persistence when the queue is flushed
* @param {number} [DELAY] optional; delay in milliseconds between
* attempts to flush the queue
* @constructor
* @memberof platform/persistence/queue
*/
function PersistenceQueue(
$q,
@ -74,4 +76,4 @@ define(
return PersistenceQueue;
}
);
);

5
platform/persistence/queue/src/PersistenceQueueHandler.js
View File

@ -34,6 +34,8 @@ define(
* @param $q Angular's $q, for promises
* @param {PersistenceFailureHandler} handler to invoke in the event
* that a persistence attempt fails.
* @constructor
* @memberof platform/persistence/queue
*/
function PersistenceQueueHandler($q, failureHandler) {
@ -98,6 +100,7 @@ define(
* associated domain objects, in id->object pairs.
* @param {PersistenceQueue} queue the persistence queue,
* to requeue as necessary
* @memberof platform/persistence/queue.PersistenceQueueHandler#
*/
persist: function (persistences, domainObjects, queue) {
var ids = Object.keys(persistences);
@ -108,4 +111,4 @@ define(
return PersistenceQueueHandler;
}
);
);

5
platform/persistence/queue/src/PersistenceQueueImpl.js
View File

@ -41,6 +41,8 @@ define(
* persistence when the queue is flushed
* @param {number} [DELAY] optional; delay in milliseconds between
* attempts to flush the queue
* @constructor
* @memberof platform/persistence/queue
*/
function PersistenceQueueImpl($q, $timeout, handler, DELAY) {
var self,
@ -118,6 +120,7 @@ define(
* @param {DomainObject} domainObject the domain object
* @param {PersistenceCapability} persistence the object's
* undecorated persistence capability
* @memberof platform/persistence/queue.PersistenceQueueImpl#
*/
put: function (domainObject, persistence) {
var id = domainObject.getId();
@ -132,4 +135,4 @@ define(
return PersistenceQueueImpl;
}
);
);

4
platform/persistence/queue/src/QueuingPersistenceCapability.js
View File

@ -34,6 +34,8 @@ define(
* capability
* @param {DomainObject} domainObject the domain object which exposes
* the capability
* @constructor
* @memberof platform/persistence/queue
*/
function QueuingPersistenceCapability(queue, persistence, domainObject) {
var queuingPersistence = Object.create(persistence);
@ -48,4 +50,4 @@ define(
return QueuingPersistenceCapability;
}
);
);

4
platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js
View File

@ -35,6 +35,7 @@ define(
* will be handled in batches (allowing failure notification to
* also be presented in batches.)
*
* @memberof platform/persistence/queue
* @constructor
*/
function QueuingPersistenceCapabilityDecorator(
@ -87,6 +88,7 @@ define(
* @returns {Object.<string,function|Capability>} all
* capabilities known to be valid for this model, as
* key-value pairs
* @memberof platform/persistence/queue.QueuingPersistenceCapabilityDecorator#
*/
getCapabilities: getCapabilities
};
@ -94,4 +96,4 @@ define(
return QueuingPersistenceCapabilityDecorator;
}
);
);