ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-14 05:08:15 +00:00
Code Issues Actions 5 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

6
platform/telemetry/src/TelemetryQueue.js
View File

@ -32,6 +32,7 @@ define(
* a queued series of large objects, ensuring that no value is
* overwritten (but consolidated non-overlapping keys into single
* objects.)
* @memberof platform/telemetry
* @constructor
*/
function TelemetryQueue() {
@ -102,6 +103,7 @@ define(
/**
* Check if any value groups remain in this pool.
* @return {boolean} true if value groups remain
* @memberof platform/telemetry.TelemetryQueue#
*/
isEmpty: function () {
return queue.length < 1;
@ -112,6 +114,7 @@ define(
* where keys and values correspond to the arguments
* given to previous put functions.
* @return {object} key-value pairs
* @memberof platform/telemetry.TelemetryQueue#
*/
poll: function () {
// Decrement counts for the object that will be popped
@ -122,6 +125,7 @@ define(
* Put a key-value pair into the pool.
* @param {string} key the key to store the value under
* @param {*} value the value to store
* @memberof platform/telemetry.TelemetryQueue#
*/
put: function (key, value) {
getFreeObject(key)[key] = value;
@ -131,4 +135,4 @@ define(
return TelemetryQueue;
}
);
);