[JSDoc] Add annotations

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

View File

@@ -33,6 +33,7 @@ define(
* A column which will report telemetry domain values
* (typically, timestamps.) Used by the ScrollingListController.
*
* @memberof platform/features/rtevents
* @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/rtevents.DomainColumn#
*/
getTitle: function () {
// At the moment there does not appear to be a way to get the
@@ -55,6 +57,7 @@ define(
* Get the text to display inside a row under this
* column.
* @returns {string} the text to display
* @memberof platform/features/rtevents.DomainColumn#
*/
getValue: function (domainObject, handle) {
return {
@@ -69,3 +72,4 @@ define(
return DomainColumn;
}
);

View File

@@ -35,6 +35,7 @@ define(
/**
* The RTEventListController is responsible for populating
* the contents of the messages view.
* @memberof platform/features/rtevents
* @constructor
*/
function RTEventListController($scope, telemetryHandler, telemetryFormatter) {
@@ -136,3 +137,4 @@ define(
return RTEventListController;
}
);

View File

@@ -34,6 +34,7 @@ define(
* A column which will report telemetry range values
* (typically, measurements.) Used by the RTEventListController.
*
* @memberof platform/features/rtevents
* @constructor
* @param rangeMetadata an object with the machine- and human-
* readable names for this range (in `key` and `name`
@@ -46,6 +47,7 @@ define(
/**
* Get the title to display in this column's header.
* @returns {string} the title to display
* @memberof platform/features/rtevents.RangeColumn#
*/
getTitle: function () {
return "Message";
@@ -54,6 +56,7 @@ define(
* Get the text to display inside a row under this
* column.
* @returns {string} the text to display
* @memberof platform/features/rtevents.RangeColumn#
*/
getValue: function (domainObject, handle) {
return {
@@ -66,3 +69,4 @@ define(
return RangeColumn;
}
);

View File

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

View File

@@ -31,6 +31,7 @@ define(
/**
* Policy controlling when the real time Messages view should be avaliable.
* @memberof platform/features/rtevents
* @constructor
*/
function RTMessagesViewPolicy() {
@@ -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/rtevents.RTMessagesViewPolicy#
*/
allow: function (view, domainObject) {
// This policy only applies for the RT Messages view
@@ -71,4 +73,4 @@ define(
return RTMessagesViewPolicy;
}
);
);