[Time Conductor] Add JSDoc for params

This commit is contained in:
Victor Woeltjen 2015-10-30 14:08:11 -07:00
parent b12bb55495
commit 796d6b800a
3 changed files with 16 additions and 0 deletions

View File

@ -40,6 +40,11 @@ define(
* {@see FormatService} * {@see FormatService}
* @constructor * @constructor
* @memberof platform/commonUI/general * @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) { function DateTimeFieldController($scope, formatService, defaultFormat) {
var formatter = formatService.getFormat(defaultFormat); var formatter = formatService.getFormat(defaultFormat);

View File

@ -35,6 +35,12 @@ define(
* Controller used by the `time-controller` template. * Controller used by the `time-controller` template.
* @memberof platform/commonUI/general * @memberof platform/commonUI/general
* @constructor * @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) { function TimeRangeController($scope, formatService, defaultFormat, now) {
var tickCount = 2, var tickCount = 2,

View File

@ -36,6 +36,11 @@ define(
* the range (usually value) of a data series. * the range (usually value) of a data series.
* @memberof platform/telemetry * @memberof platform/telemetry
* @constructor * @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) { function TelemetryFormatter(formatService, defaultFormatKey, $log) {
this.formatService = formatService; this.formatService = formatService;