Skip to content

Commit

Permalink
fix jsDoc and spelling in dot (see #49)
Browse files Browse the repository at this point in the history
  • Loading branch information
veillette committed Jun 17, 2016
1 parent 455447c commit 551f726
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 21 deletions.
10 changes: 5 additions & 5 deletions js/Bounds2.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ define( function( require ) {
* @constructor
* @public
*
* @param {number} minX - The intial minimum X coordinate of the bounds.
* @param {number} minY - The intial minimum Y coordinate of the bounds.
* @param {number} maxX - The intial maximum X coordinate of the bounds.
* @param {number} maxY - The intial maximum Y coordinate of the bounds.
* @param {number} minX - The initial minimum X coordinate of the bounds.
* @param {number} minY - The initial minimum Y coordinate of the bounds.
* @param {number} maxX - The initial maximum X coordinate of the bounds.
* @param {number} maxY - The initial maximum Y coordinate of the bounds.
*/
function Bounds2( minX, minY, maxX, maxY ) {
assert && assert( maxY !== undefined, 'Bounds2 requires 4 parameters' );
Expand Down Expand Up @@ -769,7 +769,7 @@ define( function( require ) {
* @param {number} amount
* @returns {Bounds2}
*/
eroded: function( d ) { return this.dilated( -d ); },
eroded: function( amount ) { return this.dilated( -amount ); },

/**
* A bounding box that is contracted horizontally (on the left and right) by the specified amount.
Expand Down
14 changes: 7 additions & 7 deletions js/Bounds3.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ define( function( require ) {
* @constructor
* @public
*
* @param {number} minX - The intial minimum X coordinate of the bounds.
* @param {number} minY - The intial minimum Y coordinate of the bounds.
* @param {number} minZ - The intial minimum Z coordinate of the bounds.
* @param {number} maxX - The intial maximum X coordinate of the bounds.
* @param {number} maxY - The intial maximum Y coordinate of the bounds.
* @param {number} maxZ - The intial maximum Z coordinate of the bounds.
* @param {number} minX - The initial minimum X coordinate of the bounds.
* @param {number} minY - The initial minimum Y coordinate of the bounds.
* @param {number} minZ - The initial minimum Z coordinate of the bounds.
* @param {number} maxX - The initial maximum X coordinate of the bounds.
* @param {number} maxY - The initial maximum Y coordinate of the bounds.
* @param {number} maxZ - The initial maximum Z coordinate of the bounds.
*/
function Bounds3( minX, minY, minZ, maxX, maxY, maxZ ) {
assert && assert( maxY !== undefined, 'Bounds3 requires 4 parameters' );
Expand Down Expand Up @@ -753,7 +753,7 @@ define( function( require ) {
* @param {number} amount
* @returns {Bounds3}
*/
eroded: function( d ) { return this.dilated( -d ); },
eroded: function( amount ) { return this.dilated( -amount ); },

/**
* A bounding box that is contracted horizontally (on the left and right) by the specified amount.
Expand Down
2 changes: 1 addition & 1 deletion js/Matrix3.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ define( function( require ) {
Matrix3.Types = {
// NOTE: if an inverted matrix of a type is not that type, change inverted()!
// NOTE: if two matrices with identical types are multiplied, the result should have the same type. if not, changed timesMatrix()!
// NOTE: on adding a type, exaustively check all type usage
// NOTE: on adding a type, exhaustively check all type usage
OTHER: 0, // default
IDENTITY: 1,
TRANSLATION_2D: 2,
Expand Down
2 changes: 1 addition & 1 deletion js/Quaternion.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/**
* Quaternion, see http://en.wikipedia.org/wiki/Quaternion
*
* TODO: convert from JME-style parameterization into classical mathematical description?
* TODO: convert from JME-style parametrization into classical mathematical description?
*
* @author Jonathan Olson <[email protected]>
*/
Expand Down
7 changes: 4 additions & 3 deletions js/Transform3.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ define( function( require ) {
* Optimized prepended translation such that: this.matrix = translation( x, y ) * this.matrix.
* @public
*
* @param {Matrix3} matrix
* @param {number} x - x-coordinate
* @param {number} y - y-coordinate
*/
prependTranslation: function( x, y ) {
// See scenery#119 for more details on the need.
Expand Down Expand Up @@ -563,8 +564,8 @@ define( function( require ) {
* @param {Bounds2} bounds
* @returns {Bounds2}
*/
inverseBounds2: function( bounds2 ) {
return bounds2.transformed( this.getInverse() );
inverseBounds2: function( bounds ) {
return bounds.transformed( this.getInverse() );
},

/**
Expand Down
5 changes: 3 additions & 2 deletions js/Vector2.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,11 @@ define( function( require ) {
},

/**
* The squared Euclidean distance between this vector (treated as a point) and another point (x,y).
* The squared Euclidean distance between this vector (treated as a point) and another point with coordinates (x,y).
* @public
*
* @param {Vector2} point
* @param {number} x
* @param {number} y
* @returns {number}
*/
distanceSquaredXY: function( x, y ) {
Expand Down
4 changes: 3 additions & 1 deletion js/Vector3.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ define( function( require ) {
* The squared Euclidean distance between this vector (treated as a point) and another point (x,y,z).
* @public
*
* @param {Vector3} point
* @param {number} x
* @param {number} y
* @param {number} z
* @returns {number}
*/
distanceSquaredXYZ: function( x, y, z ) {
Expand Down
5 changes: 4 additions & 1 deletion js/Vector4.js
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,10 @@ define( function( require ) {
* The squared Euclidean distance between this vector (treated as a point) and another point (x,y,z,w).
* @public
*
* @param {Vector4} point
* @param {number} x
* @param {number} y
* @param {number} z
* @param {number} w
* @returns {number}
*/
distanceSquaredXYZW: function( x, y, z, w ) {
Expand Down

0 comments on commit 551f726

Please sign in to comment.