ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-13 04:38:15 +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

5
platform/features/scrolling/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/scrolling
* @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/scrolling.DomainColumn#
*/
getTitle: function () {
return domainMetadata.name;
@ -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/scrolling.DomainColumn#
*/
getValue: function (domainObject, datum) {
return {
@ -66,4 +69,4 @@ define(
return DomainColumn;
}
);
);

5
platform/features/scrolling/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/scrolling
* @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/scrolling.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/scrolling.NameColumn#
*/
getValue: function (domainObject) {
return {
@ -59,4 +62,4 @@ define(
return NameColumn;
}
);
);

5
platform/features/scrolling/src/RangeColumn.js
View File

@ -33,6 +33,7 @@ define(
* A column which will report telemetry range values
* (typically, measurements.) Used by the ScrollingListController.
*
* @memberof platform/features/scrolling
* @constructor
* @param rangeMetadata an object with the machine- and human-
* readable names for this range (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/scrolling.RangeColumn#
*/
getTitle: function () {
return rangeMetadata.name;
@ -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/scrolling.RangeColumn#
*/
getValue: function (domainObject, datum) {
var range = rangeMetadata.key,
@ -70,4 +73,4 @@ define(
return RangeColumn;
}
);
);

2
platform/features/scrolling/src/ScrollingListController.js
View File

@ -34,6 +34,7 @@ define(
/**
* The ScrollingListController is responsible for populating
* the contents of the scrolling list view.
* @memberof platform/features/scrolling
* @constructor
*/
function ScrollingListController($scope, formatter) {
@ -130,3 +131,4 @@ define(
return ScrollingListController;
}
);

5
platform/features/scrolling/src/ScrollingListPopulator.js
View File

@ -30,6 +30,7 @@ define(
* The ScrollingListPopulator is responsible for filling in the
* values which should appear within columns of a scrolling list
* view, based on received telemetry data.
* @memberof platform/features/scrolling
* @constructor
* @param {Column[]} columns the columns to be populated
*/
@ -50,6 +51,7 @@ define(
* data objects; expected to be in the same order
* as the domain objects provided at constructor
* @param {number} count the number of rows to provide
* @memberof platform/features/scrolling.ScrollingListPopulator#
*/
function getLatestDataValues(datas, count) {
var latest = [],
@ -136,6 +138,7 @@ define(
* Get the text which should appear in headers for the
* provided columns.
* @returns {string[]} column headers
* @memberof platform/features/scrolling.ScrollingListPopulator#
*/
getHeaders: function () {
return columns.map(function (column) {
@ -152,6 +155,7 @@ define(
* @returns {string[][]} an array of rows, each of which
* is an array of values which should appear
* in that row
* @memberof platform/features/scrolling.ScrollingListPopulator#
*/
getRows: function (datas, objects, count) {
var values = getLatestDataValues(datas, count);
@ -181,3 +185,4 @@ define(
}
);