Skip to content

Commit

Permalink
Remove type annotations for Property subtype declarations, see #268
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Dec 18, 2018
1 parent 68f6805 commit 28cf8e7
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 12 deletions.
12 changes: 6 additions & 6 deletions js/common/model/Scene.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ define( require => {
// @private {number} - indicates the time when the pulse began, or 0 if there is no pulse.
this.pulseStartTime = 0;

// @public {Property.<Boolean>} - whether the button for the first source is pressed. This is also used for the
// @public - whether the button for the first source is pressed. This is also used for the
// slits screen plane wave source.
this.button1PressedProperty = new BooleanProperty( false );

// @public {Property.<Boolean>} - whether the button for the second source is pressed
// @public - whether the button for the second source is pressed
this.button2PressedProperty = new BooleanProperty( false );

// @public (read-only) {string} - units for this scene
Expand Down Expand Up @@ -99,7 +99,7 @@ define( require => {

const centerFrequency = ( config.minimumFrequency + config.maximumFrequency ) / 2;

// @public {Property.<number>} - the frequency in the appropriate units for the scene
// @public - the frequency in the appropriate units for the scene
this.frequencyProperty = new NumberProperty( centerFrequency, {
range: new Range( config.minimumFrequency, config.maximumFrequency )
} );
Expand All @@ -121,7 +121,7 @@ define( require => {
units: this.timeUnits
} );

// @public {Property.<Number>} - distance between the sources in the units of the scene, or 0 if there is only one
// @public - distance between the sources in the units of the scene, or 0 if there is only one
// source initialized to match the initial slit separation,
// see https://github.com/phetsims/wave-interference/issues/87
this.sourceSeparationProperty = new NumberProperty(
Expand All @@ -142,7 +142,7 @@ define( require => {
// start slightly left of 50.5 so it will round to 50 instead of 51
this.barrierLocationProperty = new Property( new Vector2( this.lattice.width / 2 - 1E-6, 0 ) );

// @public {Property.<number>} - the floor of the continuous barrier location (x coordinate only)
// @public {DerivedProperty.<number>} - the floor of the continuous barrier location (x coordinate only)
this.barrierLatticeCoordinateProperty = new DerivedProperty(
[ this.barrierLocationProperty ],
barrierLocation => Math.round( barrierLocation.x )
Expand All @@ -153,7 +153,7 @@ define( require => {
units: this.positionUnits
} );

// @public {Property.<Number>} - distance between the center of the slits, in the units for this scene
// @public - distance between the center of the slits, in the units for this scene
this.slitSeparationProperty = new NumberProperty( config.initialSlitSeparation, {
units: this.positionUnits
} );
Expand Down
2 changes: 1 addition & 1 deletion js/common/model/SoundScene.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ define( require => {
// on the Slits screen, see https://github.com/phetsims/wave-interference/issues/109
this.showSoundParticles = showSoundParticles;

// @public {Property.<string>} - indicates the selected view for sound
// @public {Property.<SoundViewType>} - indicates the selected view for sound
this.viewSelectionProperty = new Property( SoundViewType.WAVES, {
validValues: SoundViewType.VALUES
} );
Expand Down
8 changes: 4 additions & 4 deletions js/diffraction/model/DiffractionModel.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ define( require => {
class DiffractionModel {
constructor() {

// @public {Property.<boolean>} whether the laser is emitting light
// @public - whether the laser is emitting light
this.onProperty = new BooleanProperty( true );

// @public {Property.<number>} dimensions of the square aperture
// @public - dimensions of the square aperture
this.squareWidthProperty = new NumberProperty( 16 );
this.squareHeightProperty = new NumberProperty( 16 );

// @public {Property.<number>} dimensions of the elliptical aperture
// @public - dimensions of the elliptical aperture
this.sigmaXProperty = new NumberProperty( 10 );
this.sigmaYProperty = new NumberProperty( 10 );
this.gaussianMagnitudeProperty = new NumberProperty( 400 );

// @public {Property.<number>} characteristics of the grating
// @public - characteristics of the grating
this.numberOfLinesProperty = new NumberProperty( 10 );
this.angleProperty = new NumberProperty( 0 );

Expand Down
3 changes: 2 additions & 1 deletion js/waves/model/WavesScreenModel.js
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,9 @@ define( require => {
// @public
this.isWaveMeterInPlayAreaProperty = new BooleanProperty( false );

// @public {Property.<number>} - amount the 3d view is rotated. 0 means top view, 1 means side view.
const rotationRange = new Range( 0, 1 );

// @public - amount the 3d view is rotated. 0 means top view, 1 means side view.
this.rotationAmountProperty = new NumberProperty( 0, {
range: rotationRange
} );
Expand Down

0 comments on commit 28cf8e7

Please sign in to comment.