From 796d6b800aa76bd71ceb31f5ecef1fa95068d9d2 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 30 Oct 2015 14:08:11 -0700 Subject: [PATCH] [Time Conductor] Add JSDoc for params --- .../general/src/controllers/DateTimeFieldController.js | 5 +++++ .../commonUI/general/src/controllers/TimeRangeController.js | 6 ++++++ platform/telemetry/src/TelemetryFormatter.js | 5 +++++ 3 files changed, 16 insertions(+) diff --git a/platform/commonUI/general/src/controllers/DateTimeFieldController.js b/platform/commonUI/general/src/controllers/DateTimeFieldController.js index 40e80a99b2..7b58834aa5 100644 --- a/platform/commonUI/general/src/controllers/DateTimeFieldController.js +++ b/platform/commonUI/general/src/controllers/DateTimeFieldController.js @@ -40,6 +40,11 @@ define( * {@see FormatService} * @constructor * @memberof platform/commonUI/general + * @param $scope the Angular scope for this controller + * @param {FormatService} formatService the service to user to format + * domain values + * @param {string} defaultFormat the format to request when no + * format has been otherwise specified */ function DateTimeFieldController($scope, formatService, defaultFormat) { var formatter = formatService.getFormat(defaultFormat); diff --git a/platform/commonUI/general/src/controllers/TimeRangeController.js b/platform/commonUI/general/src/controllers/TimeRangeController.js index fd30d3a231..b0ef5efe70 100644 --- a/platform/commonUI/general/src/controllers/TimeRangeController.js +++ b/platform/commonUI/general/src/controllers/TimeRangeController.js @@ -35,6 +35,12 @@ define( * Controller used by the `time-controller` template. * @memberof platform/commonUI/general * @constructor + * @param $scope the Angular scope for this controller + * @param {FormatService} formatService the service to user to format + * domain values + * @param {string} defaultFormat the format to request when no + * format has been otherwise specified + * @param {Function} now a function to return current system time */ function TimeRangeController($scope, formatService, defaultFormat, now) { var tickCount = 2, diff --git a/platform/telemetry/src/TelemetryFormatter.js b/platform/telemetry/src/TelemetryFormatter.js index 1aa24b644d..cff80cf355 100644 --- a/platform/telemetry/src/TelemetryFormatter.js +++ b/platform/telemetry/src/TelemetryFormatter.js @@ -36,6 +36,11 @@ define( * the range (usually value) of a data series. * @memberof platform/telemetry * @constructor + * @param {FormatService} formatService the service to user to format + * domain values + * @param {string} defaultFormatKey the format to request when no + * format has been otherwise specified + * @param $log Angular's `$log`, to log warnings */ function TelemetryFormatter(formatService, defaultFormatKey, $log) { this.formatService = formatService;