ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-18 23:28:14 +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

9
platform/telemetry/src/TelemetryController.js
View File

@ -34,6 +34,7 @@ define(
* which need to issue requests for telemetry data and use the
* results
*
* @memberof platform/telemetry
* @constructor
*/
function TelemetryController($scope, $q, $timeout, $log) {
@ -314,6 +315,7 @@ define(
* given index will correspond to the telemetry-providing
* domain object at the same index.
* @returns {Array} an array of metadata objects
* @memberof platform/telemetry.TelemetryController#
*/
getMetadata: function () {
return self.metadatas;
@ -328,6 +330,7 @@ define(
* given index will correspond to the telemetry-providing
* domain object at the same index.
* @returns {DomainObject[]} an array of metadata objects
* @memberof platform/telemetry.TelemetryController#
*/
getTelemetryObjects: function () {
return self.telemetryObjects;
@ -345,6 +348,7 @@ define(
* response at a given index will correspond to the
* telemetry-providing domain object at the same index.
* @returns {Array} an array of responses
* @memberof platform/telemetry.TelemetryController#
*/
getResponse: function getResponse(arg) {
var id = arg && (typeof arg === 'string' ?
@ -364,6 +368,7 @@ define(
* show user feedback, such as a wait spinner.
*
* @returns {boolean} true if the request is still outstanding
* @memberof platform/telemetry.TelemetryController#
*/
isRequestPending: function () {
return self.pending > 0;
@ -372,6 +377,7 @@ define(
* Issue a new data request. This will change the
* request parameters that are passed along to all
* telemetry capabilities managed by this controller.
* @memberof platform/telemetry.TelemetryController#
*/
requestData: function (request) {
self.request = request || {};
@ -382,6 +388,7 @@ define(
* perform its polling activity.
* @param {number} durationMillis the interval at
* which to poll, in milliseconds
* @memberof platform/telemetry.TelemetryController#
*/
setRefreshInterval: function (durationMillis) {
self.interval = durationMillis;
@ -392,4 +399,4 @@ define(
return TelemetryController;
}
);
);