visibility annotation, see #37

phetsims · Mar 2, 2018 · c2b2a8b · c2b2a8b
1 parent ffcfaba
commit c2b2a8b
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/js/model/ISLCObject.js b/js/model/ISLCObject.js
@@ -95,6 +95,8 @@ define( function( require ) {
 
     /**
      * Calculate radius for the object - must be implemented in subtypes.
+     *
+     * @public
      */
     calculateRadius: function() {
       throw new Error( 'calculateRadius must be implemented in descendent types' );

diff --git a/js/view/ISLCForceArrowNode.js b/js/view/ISLCForceArrowNode.js
@@ -93,7 +93,9 @@ define( function( require ) {
     arrowOptions.fill = options.arrowFill;
     arrowOptions.tandem = options.tandem.createTandem( 'arrow' );
 
+    // @private
     this.arrow = new ArrowNode( 0, -options.forceArrowHeight, 200, -options.forceArrowHeight, arrowOptions );
+
     Node.call( this, {} );
     this.addChild( this.arrowText );
     this.addChild( this.arrow );

diff --git a/js/view/ISLCObjectControlPanel.js b/js/view/ISLCObjectControlPanel.js
@@ -120,6 +120,7 @@ define( function( require ) {
 
     Panel.call( this, numberControl, panelOptions );
 
+    // @protected - used in Accessibility.js
     this.groupFocusHighlight = new GroupFocusHighlightFromNode( this, {
       useLocalBounds: true,
       dilationCoefficient: 3.7,

diff --git a/js/view/ISLCObjectNode.js b/js/view/ISLCObjectNode.js
@@ -321,6 +321,8 @@ define( function( require ) {
 
     /**
      * Redraws the white radial gradient for the object - must be implemented in subtypes.
+     *
+     * @public
      */
     updateGradient: function() {
       throw new Error( 'Update gradient must be implemented in subtypes.' );
@@ -329,6 +331,7 @@ define( function( require ) {
     /**
      * Sets whether or not the readouts above the arrows use scientific notation in their display of the value.
      *
+     * @public
      * @param {boolean} useScientificNotation
      */
     setReadoutsInScientificNotation: function( useScientificNotation ) {
@@ -340,6 +343,8 @@ define( function( require ) {
 
     /**
      * Updates the radius, arrow length & direction, force readout, and the visible puller image.
+     *
+     * @public
      */
     redrawForce: function() {
       this.objectCircle.setRadius( this.modelViewTransform.modelToViewDeltaX( this.objectModel.radiusProperty.get() ) );