#190 use @public instead of "all fields are @public"

phetsims · Nov 12, 2015 · 4e41bbe · 4e41bbe
1 parent b0654e4
commit 4e41bbe
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/js/common/model/BodyState.js b/js/common/model/BodyState.js
@@ -22,7 +22,7 @@ define( function( require ) {
    */
   function BodyState( position, velocity, acceleration, mass, exploded ) {
 
-    // all fields are @public
+    // @public
     this.position = position;
     this.velocity = velocity;
     this.acceleration = acceleration;

diff --git a/js/common/model/GravityAndOrbitsClock.js b/js/common/model/GravityAndOrbitsClock.js
@@ -33,7 +33,7 @@ define( function( require ) {
   function GravityAndOrbitsClock( baseDTValue, steppingProperty, timeSpeedScaleProperty ) {
     var thisClock = this;
 
-    // all fields are @public
+    // @public
     this.runningProperty = new Property( false );
     this.simulationTimeProperty = new Property( 0 );
     this.dt = baseDTValue * timeSpeedScaleProperty.get();

diff --git a/js/common/module/BodyConfiguration.js b/js/common/module/BodyConfiguration.js
@@ -25,7 +25,7 @@ define( function( require ) {
    */
   function BodyConfiguration( mass, radius, x, y, vx, vy ) {
 
-    // all fields are @public
+    // @public
     this.fixed = false; // True if the object doesn't move when the clock ticks
     this.mass = mass;
     this.radius = radius;

diff --git a/js/common/module/ModeList.js b/js/common/module/ModeList.js
@@ -90,7 +90,7 @@ define( function( require ) {
   // static class: SunEarthModeConfig
   function SunEarthModeConfig() {
 
-    // all fields are @public
+    // @public
     this.sun = new BodyConfiguration( SUN_MASS, SUN_RADIUS, 0, 0, 0, 0 );
     this.earth = new BodyConfiguration(
       EARTH_MASS, EARTH_RADIUS, EARTH_PERIHELION, 0, 0, EARTH_ORBITAL_SPEED_AT_PERIHELION );
@@ -115,7 +115,7 @@ define( function( require ) {
   // static class: SunEarthMoonModeConfig
   function SunEarthMoonModeConfig() {
 
-    // all fields are @public
+    // @public
     this.sun = new BodyConfiguration( SUN_MASS, SUN_RADIUS, 0, 0, 0, 0 );
     this.earth = new BodyConfiguration(
       EARTH_MASS, EARTH_RADIUS, EARTH_PERIHELION, 0, 0, EARTH_ORBITAL_SPEED_AT_PERIHELION );
@@ -142,7 +142,7 @@ define( function( require ) {
   // static class: EarthMoonModeConfig
   function EarthMoonModeConfig() {
 
-    // all fields are @public
+    // @public
     this.earth = new BodyConfiguration( EARTH_MASS, EARTH_RADIUS, EARTH_PERIHELION, 0, 0, 0 );
     this.moon = new BodyConfiguration( MOON_MASS, MOON_RADIUS, MOON_X, MOON_Y, MOON_SPEED, 0 );
     ModeConfig.call( this, 400 );
@@ -165,12 +165,13 @@ define( function( require ) {
   // static class: EarthSpaceStationModeConfig
   function EarthSpaceStationModeConfig() {
 
-    // all fields are @public
+    // @public
     this.earth = new BodyConfiguration( EARTH_MASS, EARTH_RADIUS, 0, 0, 0, 0 );
     this.spaceStation = new BodyConfiguration( SPACE_STATION_MASS, SPACE_STATION_RADIUS,
       SPACE_STATION_PERIGEE + EARTH_RADIUS + SPACE_STATION_RADIUS, 0, 0, SPACE_STATION_SPEED );
     ModeConfig.call( this, 21600 );
 
+    // @public
     // Sampled at runtime from MeasuringTape
     this.initialMeasuringTapeLocation = new Line( 3162119, 7680496, 6439098, 7680496 );
     this.forceScale = FORCE_SCALE * 3E13;

diff --git a/js/common/module/ModeListParameterList.js b/js/common/module/ModeListParameterList.js
@@ -22,13 +22,14 @@ define( function( require ) {
    */
   function ModeListParameterList( playButtonPressedProperty, gravityEnabledProperty, steppingProperty, rewindingProperty, timeSpeedScaleProperty ) {
 
-    // all fields are @public
+    // @public
     this.playButtonPressedProperty = playButtonPressedProperty;
     this.gravityEnabledProperty = gravityEnabledProperty;
 
-    // True if the user is pressing the "step" button, to support storing states for the rewind feature
+    // @public True if the user is pressing the "step" button, to support storing states for the rewind feature
     this.steppingProperty = steppingProperty;
 
+    // @public
     // Flag to indicate if a "rewind" event is taking place, to support storing states for the rewind feature
     this.rewindingProperty = rewindingProperty;
     this.timeSpeedScaleProperty = timeSpeedScaleProperty;