alihan/openmct
1
0
Fork 0
Code Issues Pull Requests 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/events/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/events
* @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/events.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/events.DomainColumn#
*/
getValue: function (domainObject, data, index) {
return telemetryFormatter.formatDomainValue(
@@ -64,4 +67,4 @@ define(
return DomainColumn;
}
);
);

2
platform/features/events/src/EventListController.js
View File

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

2
platform/features/events/src/EventListPopulator.js
View File

@@ -158,4 +158,4 @@ define(
return EventListPopulator;
}
);
);

5
platform/features/events/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/events
* @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/events.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/events.RangeColumn#
*/
getValue: function (domainObject, data, index) {
return telemetryFormatter.formatRangeValue(
@@ -64,4 +67,4 @@ define(
return RangeColumn;
}
);
);

2
platform/features/events/src/directives/MCTDataTable.js
View File

@@ -71,4 +71,4 @@ define(
return MCTDataTable;
}
);
);

4
platform/features/events/src/policies/MessagesViewPolicy.js
View File

@@ -31,6 +31,7 @@ define(
/**
* Policy controlling when the Messages view should be avaliable.
* @memberof platform/features/events
* @constructor
*/
function MessagesViewPolicy() {
@@ -52,6 +53,7 @@ define(
* @param {Action} action the action
* @param domainObject the domain object which will be viewed
* @returns {boolean} true if not disallowed
* @memberof platform/features/events.MessagesViewPolicy#
*/
allow: function (view, domainObject) {
// This policy only applies for the Messages view
@@ -71,4 +73,4 @@ define(
return MessagesViewPolicy;
}
);
);