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

4
platform/features/rtscrolling/src/DomainColumn.js
View File

@ -33,6 +33,7 @@ define(
* A column which will report telemetry domain values
* (typically, timestamps.) Used by the ScrollingListController.
*
* @memberof platform/features/rtscrolling
* @constructor
* @param domainMetadata an object with the machine- and human-
* readable names for this domain (in `key` and `name`
@ -45,6 +46,7 @@ define(
/**
* Get the title to display in this column's header.
* @returns {string} the title to display
* @memberof platform/features/rtscrolling.DomainColumn#
*/
getTitle: function () {
return "Time";
@ -53,6 +55,7 @@ define(
* Get the text to display inside a row under this
* column.
* @returns {string} the text to display
* @memberof platform/features/rtscrolling.DomainColumn#
*/
getValue: function (domainObject, handle) {
return {
@ -67,3 +70,4 @@ define(
return DomainColumn;
}
);

4
platform/features/rtscrolling/src/NameColumn.js
View File

@ -33,6 +33,7 @@ define(
* A column which will report the name of the domain object
* which exposed specific telemetry values.
*
* @memberof platform/features/rtscrolling
* @constructor
*/
function NameColumn() {
@ -40,6 +41,7 @@ define(
/**
* Get the title to display in this column's header.
* @returns {string} the title to display
* @memberof platform/features/rtscrolling.NameColumn#
*/
getTitle: function () {
return "Name";
@ -48,6 +50,7 @@ define(
* Get the text to display inside a row under this
* column. This returns the domain object's name.
* @returns {string} the text to display
* @memberof platform/features/rtscrolling.NameColumn#
*/
getValue: function (domainObject) {
return {
@ -60,3 +63,4 @@ define(
return NameColumn;
}
);

2
platform/features/rtscrolling/src/RTScrollingListController.js
View File

@ -34,6 +34,7 @@ define(
/**
* The RTScrollingListController is responsible for populating
* the contents of the scrolling list view.
* @memberof platform/features/rtscrolling
* @constructor
*/
function RTScrollingListController($scope, telemetryHandler, telemetryFormatter) {
@ -135,3 +136,4 @@ define(
return RTScrollingListController;
}
);

4
platform/features/rtscrolling/src/RangeColumn.js
View File

@ -33,6 +33,7 @@ define(
* A column which will report telemetry range values
* (typically, measurements.) Used by the RTScrollingListController.
*
* @memberof platform/features/rtscrolling
* @constructor
* @param rangeMetadata an object with the machine- and human-
* readable names for this range (in `key` and `name`
@ -52,6 +53,7 @@ define(
/**
* Get the title to display in this column's header.
* @returns {string} the title to display
* @memberof platform/features/rtscrolling.RangeColumn#
*/
getTitle: function () {
return "Value";
@ -60,6 +62,7 @@ define(
* Get the text to display inside a row under this
* column.
* @returns {string} the text to display
* @memberof platform/features/rtscrolling.RangeColumn#
*/
getValue: function (domainObject, handle) {
var range = findRange(domainObject),
@ -81,3 +84,4 @@ define(
return RangeColumn;
}
);