final review items, comment & documentation updates. see #19

js/ISLCConstants.js

@@ -18,9 +18,6 @@ define( function( require ) {
   var MIN_MASS = 1; // kg
   var MAX_MASS = 1000; // kg
 
-  // TODO: This is sim and screen specific, should not be a constant in INverseSquareLawConstants
-  // TODO: Consider caluclating this instead of choosing random values - might be tough when
-  // radii can grow.
   var MAX_DISTANCE_FROM_CENTER = 5; // meters, empirically determined boundary for objects
 
   var ISLCConstants = {

js/model/ISLCModel.js

@@ -101,7 +101,7 @@ define( function( require ) {
   return inherit( Object, ISLCModel, {
 
     /**
-     * step function makes sure masses doesn't goes out of bounds and don't overlap each other at each time step
+     * Step function makes sure masses doesn't goes out of bounds and don't overlap each other at each time step
      * @public
      */
     step: function() {

js/model/ISLCObject.js

@@ -39,7 +39,7 @@ define( function( require ) {
       leftObjectBoundary: ISLCConstants.LEFT_OBJECT_BOUNDARY,
       rightObjectBoundary: ISLCConstants.RIGHT_OBJECT_BOUNDARY,
 
-      tandem: Tandem.required, // tandem optional until sim is instrumented - TODO: come back to this
+      tandem: Tandem.required,
       tandemUnits: 'kilograms',
     }, options );
 

js/view/ISLCLegendNode.js

@@ -1,7 +1,8 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * A legend graphic consisting of a double-ended arrow, two endpoint lines, and a label string. Intended to visually indicate a distance scale.
+ * A legend graphic consisting of a double-ended arrow, two endpoint lines, and a label string. Intended to visually
+ * indicate a distance scale.
  *
  * @author  Michael Barlow
  */
@@ -16,11 +17,11 @@ define( function( require ) {
   var Text = require( 'SCENERY/nodes/Text' );
 
   /**
-   * @constructor
    * @param {ISLModel} model              
    * @param {ModelViewTransform2} modelViewTransform 
    * @param {int/float} width (in view coordinates)
    * @param {string} labelString
+   * @constructor
    */
   function ISLCLegendNode( width, labelString, options ) {
 

js/view/ISLCObjectNode.js

@@ -34,14 +34,14 @@ define( function( require ) {
 
   /**
    * 
-   * @constructor
-   * @param {ISLModel} model
-   * @param {ISLObjectModel} objectModel
+   * @param {ISLModel} model - the simulation model
+   * @param {ISLObjectModel} objectModel - the associated object's model within the sim
    * @param {Bounds2} layoutBounds - bounds of the screen view containing the object
    * @param {ModelViewTransform2} modelViewTransform
    * @param {Range} pullForceRange - the max and min possible force values
    * @param {Tandem} tandem
    * @param {Object} options
+   * @constructor
    */
   function ISLCObjectNode( model, objectModel, layoutBounds, modelViewTransform, pullForceRange, tandem, options ) {
 
@@ -85,6 +85,7 @@ define( function( require ) {
       tandem: tandem
     } );
 
+    // @protected
     this.layoutBounds = layoutBounds;
     this.objectModel = objectModel;
     this.model = model;
@@ -129,9 +130,6 @@ define( function( require ) {
     // set y position for the arrow
     this.arrowNode.y = options.y - options.forceArrowHeight;
 
-    // @private - the puller node
-    // options: ropeLength, shadowMinWidth, shadowMaxWidth, attractNegative, displayShadow
-    // we may only need to pass attractNegative & ropeLength
     var pullerOptionKeys = [
       'ropeLength',
       'shadowMinWidth',
@@ -140,6 +138,7 @@ define( function( require ) {
       'displayShadow'
     ];
 
+    // @private - the puller node
     this.pullerNode = new ISLCPullerNode(
       pullForceRange,
       tandem.createTandem( 'pullerNode' ),
@@ -158,12 +157,14 @@ define( function( require ) {
 
     // the 'object' - a shaded circle
     var radius = modelViewTransform.modelToViewDeltaX( objectModel.radiusProperty.get() );
+
+    // @protected - the object
     this.objectCircle = new Circle( radius );
 
     dragNode.addChild( this.pullerNode );
     dragNode.addChild( this.objectCircle );
 
-    // TODO: What is this circle doing here?
+    // Small black dot where vertical arrow line connects to the object
     dragNode.addChild( new Circle( 2, { fill: '#000' } ) );
 
     var labelCenterX = 0;
@@ -192,6 +193,8 @@ define( function( require ) {
     } ) );
 
     this.addChild( dragNode );
+
+    // @private
     this.y = options.y;
 
     // the marker line, connecting the arrow to the object, the first one is for the shadow so that
@@ -284,6 +287,9 @@ define( function( require ) {
 
   inherit( Node, ISLCObjectNode, {
 
+    /**
+     * Redraws the white radial gradient for the object - must be implemented in subtypes.
+     */
     updateGradient: function() {
       throw new Error( 'Update gradient must be implemented in subtypes.' );
     },

js/view/ISLCPullerNode.js

@@ -117,7 +117,6 @@ define( function( require ) {
    */
   function ISLCPullerNode( forceRange, tandem, options ) {
 
-    // REVIEW: This node doesn't pass options to Node 
     options = _.extend( { 
       ropeLength: 50,
       shadowMinWidth: 32,
@@ -157,7 +156,7 @@ define( function( require ) {
       tandem: tandem.createTandem( 'shadowNode' )
     } );
 
-    // create the puller/pusher image nodes
+    // create each of the puller/pusher image nodes
     var images = [];
     var i;
     for ( i = 0; i < this.pullerPusherImages.length; i++ ) {