JSDoc, see #409

phetsims · Mar 7, 2018 · f58213f · f58213f
1 parent 6881ad9
commit f58213f
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/js/energy-skate-park-basics/model/ControlPointIO.js b/js/energy-skate-park-basics/model/ControlPointIO.js
@@ -31,12 +31,22 @@ define( function( require ) {
   phetioInherit( ObjectIO, 'ControlPointIO', ControlPointIO, {}, {
     documentation: 'A control point that can manipulate the track.',
 
+    /**
+     * Encodes a ControlPoint instance to a state.
+     * @param {ControlPoint} controlPoint
+     * @returns {Object}
+     */
     toStateObject: function( controlPoint ) {
       assert && assertInstanceOf( controlPoint, phet.energySkateParkBasics.ControlPoint );
       return controlPoint ? controlPoint.tandem.phetioID : 'null';
     },
 
-    // Support null
+    /**
+     * Decodes a ControlPoint from a state object. Supports null.
+     *
+     * @param {Object} stateObject
+     * @return {ControlPoint}
+     */
     fromStateObject: function( stateObject ) {
       if ( stateObject === 'null' ) {
         return null;