Reviewed function declarations, see #64

phetsims · Feb 7, 2018 · 1abaedf · 1abaedf
1 parent 7235c9e
commit 1abaedf
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/js/friction/view/magnifier/AtomCanvasNode.js b/js/friction/view/magnifier/AtomCanvasNode.js
@@ -138,6 +138,5 @@ define( function( require ) {
     registerAtom: function( atom ) {
       this.atoms.push( atom );
     }
-
   } );
-} );
+} );
diff --git a/js/friction/view/magnifier/AtomNode.js b/js/friction/view/magnifier/AtomNode.js
@@ -91,6 +91,10 @@ define( function( require ) {
   friction.register( 'AtomNode', AtomNode );
 
   return inherit( Node, AtomNode, {
+
+    /**
+     * TODO: visibility annotation
+     */
     evaporate: function() {
       var self = this;
 
@@ -117,9 +121,18 @@ define( function( require ) {
       // TODO: does this file need a dispose function?
       this.model.newStepProperty.link( self.handler );
     },
+
+    /**
+     * TODO: visibility annotation
+     * @returns {number}
+     */
     getYrange: function() {
       return this.model.distanceProperty.get() + this.model.atoms.distanceY * this.model.toEvaporate.length;
     },
+
+    /**
+     * @public
+     */
     reset: function() {
       this.x0 = this.options.x;
       this.y0 = this.options.y;

diff --git a/js/friction/view/magnifier/MagnifierNode.js b/js/friction/view/magnifier/MagnifierNode.js
@@ -284,6 +284,9 @@ define( function( require ) {
       this.atomCanvasNode.invalidatePaint(); // tell the atom canvas to redraw itself
     },
 
+    /**
+     * @param {FrictionModel} model
+     */
     addAtoms: function( model ) {
       var self = this;
       var topAtoms = this.param.topAtoms;

diff --git a/js/friction/view/magnifier/MagnifierTargetNode.js b/js/friction/view/magnifier/MagnifierTargetNode.js
@@ -57,6 +57,12 @@ define( function( require ) {
   return inherit( Node, MagnifierTargetNode, {
 
     // TODO: rename method
+    /**
+     * TODO: document
+     * @param {number} x
+     * @param {number} y
+     * TODO: mark visibility
+     */
     set: function( x, y ) {
       this.pathLeft.setShape( new Shape()
         .moveTo( this.leftAnchor.x, this.leftAnchor.y )
-Original file line number
+Diff line change
@@ Expand Up / @@ -138,6 +138,5 @@ define( function( require ) { @@
         registerAtom: function( atom ) {
           this.atoms.push( atom );
         }
       } );
-    } );
+    } );