[Time Conductor] Addressed documentation issues

platform/commonUI/formats/src/DurationFormat.js

@@ -33,9 +33,11 @@ define([
 
 
     /**
-     * Formatter for UTC timestamps. Interprets numeric values as
-     * milliseconds since the start of 1970. Displays only the utc time. Can
-     * be used, with care, for specifying time intervals.
+     * Formatter for duration. Uses moment to produce a date from a given
+     * value, but output is formatted to display only time. Can be used for
+     * specifying a time duration. For specifying duration, it's best to
+     * specify a date of January 1, 1970, as the ms offset will equal the
+     * duration represented by the time.
      *
      * @implements {Format}
      * @constructor

platform/features/conductor-v2/src/timeSystems/TickSource.js

@@ -22,8 +22,10 @@
 
 define([], function () {
     /**
-     * A tick source is a timing of timing signals. Usage is simple, a
-     * listener registers a callback which is invoked when this source 'ticks'.
+     * A tick source is an event generator such as a timing signal, or
+     * indicator of data availability, which can be used to advance the Time
+     * Conductor. Usage is simple, a listener registers a callback which is
+     * invoked when this source 'ticks'.
      *
      * @interface
      * @constructor

platform/features/conductor-v2/src/timeSystems/TimeSystem.js

@@ -38,10 +38,21 @@ define([], function () {
         this._tickSources = [];
     }
 
+    /**
+     * Time formats are defined as extensions. Time systems that implement
+     * this interface should provide an array of format keys supported by them.
+     *
+     * @returns {string[]} An array of time format keys
+     */
     TimeSystem.prototype.formats = function () {
         throw new Error('Not implemented');
     };
 
+    /**
+     * Returns the tick sources supported by this time system. Tick sources
+     * are event generators that can be used to advance the time conductor
+     * @returns {TickSource[]} The tick sources supported by this time system.
+     */
     TimeSystem.prototype.tickSources = function () {
         throw new Error('Not implemented');
     };

platform/features/conductor-v2/src/timeSystems/UTCTimeSystem.js

@@ -46,8 +46,6 @@ define([
             'glyph': '\u0043'
         };
 
-        //Time formats are defined as extensions. Include the key
-        // for the corresponding time format here
         this._formats = ['utc'];
         this._tickSources = [new LocalClock($timeout, DEFAULT_PERIOD)];
     }