[Time Conductor] Add JSDoc to new bundle

Add JSDoc to platform/commonUI/formats, introduced to support
different time formats from the time conductor.
nasa/openmctweb#182.
This commit is contained in:
Victor Woeltjen 2015-10-28 08:29:56 -07:00
parent 00c0019122
commit 0ad22f6842
2 changed files with 30 additions and 0 deletions

View File

@ -63,6 +63,28 @@ define([
* @returns {string} the text representation of the value
*/
/**
* Provides access to `Format` objects which can be used to
* convert values between human-readable text and numeric
* representations.
* @interface FormatService
*/
/**
* Look up a format by its symbolic identifier.
* @param {string} key the identifier for this format
* @returns {Format} the format, or `undefined` if no such format
* is known.
*/
/**
* Provides formats from the `formats` extension category.
* @constructor
* @implements {FormatService}
* @memberof platform/commonUI/formats
* @param {Array.<function(new : Format)>} format constructors,
* from the `formats` extension category.
*/
function FormatProvider(formats) {
var formatMap = {};

View File

@ -37,6 +37,14 @@ define([
];
/**
* Formatter for UTC timestamps. Interprets numeric values as
* milliseconds since the start of 1970.
*
* @implements {Format}
* @constructor
* @memberof platform/commonUI/formats
*/
function UTCTimeFormat() {
}