phetsims / color-vision

"Color Vision" is an educational simulation in HTML5, by PhET Interactive Simulations.
http://phet.colorado.edu/en/simulation/color-vision
GNU General Public License v3.0
1 stars 7 forks source link

specify Property type in JSdoc for function parameters #48

Closed pixelzoom closed 10 years ago

pixelzoom commented 10 years ago

This is a general comment, example from RGBSlider:

@param {Property} intensityProperty the intensity property for this color from the model

It's not part of the JSdoc specification, but I recommend indicating the type of the Property, like this:

@param {Property} intensityProperty the intensity property for this color from the model

aaronsamuel137 commented 10 years ago

I have made this change. For instance,

@param {Property} intensityProperty the intensity property for this color from the model

has become

@param {Property<Number>} intensityProperty the intensity property for this color from the model

(which is what I think you meant to write in your comment).

The only cases where {Property} appears without a type are in IconToggleNode and HeadToggleNode, which could take any type of Property.

Assigning to @pixelzoom for review

pixelzoom commented 10 years ago

Looks good, closing.