add doc, #185

phetsims · Nov 5, 2019 · aaf5ea9 · aaf5ea9
1 parent 7335a41
commit aaf5ea9
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/js/gravity-force-lab/view/describers/GravityForceLabRulerDescriber.js b/js/gravity-force-lab/view/describers/GravityForceLabRulerDescriber.js
@@ -47,9 +47,14 @@ define( require => {
     RULER_VERTICAL_REGIONS.indexOf( justBelowCentersString ) );
   const SHOW_RULER_REGIONS = ISLCQueryParameters.showRulerRegions;
 
-  /**
-   */
   class GravityForceLabRulerDescriber {
+
+    /**
+     * @param {Property.<number>} rulerPositionProperty
+     * @param {ModelViewTransform2} modelViewTransform
+     * @param {Array.<number>} viewYPositions - a list of Y positions, least (top) to greatest (bottom)
+     * @param {PositionDescriber} positionDescriber
+     */
     constructor( rulerPositionProperty, modelViewTransform, viewYPositions, positionDescriber ) {
 
       assert && assert( RULER_VERTICAL_REGIONS.length === viewYPositions.length, 'Unexpected number of y positions' );