Some code style fixes #949
Conversation
Aliance
commented
Jul 28, 2015
Aliance
commented
| @@ -332,16 +325,16 @@ Crafty.c("Collision", { | |||
| * @see .checkHits | |||
| * @see .hit | |||
| */ | |||
| onHit: function (comp, callback, callbackOff) { | |||
| onHit: function (component, hit, noHit) { | |||
There was a problem hiding this comment.
I actually liked the previous parameter names more, as the -Off part reflected their purpose better - function to be called after collision resolved.
Some suggestions: callbackOn/-Off, hitOn/-Off, etc.
There was a problem hiding this comment.
I agree, but PHPStorm highlights if function argument and phpdoc @param are different. May be change it in phpdoc?
There was a problem hiding this comment.
Let's update the documentation then accordingly
|
Looks good, have couple of suggestions. |
| @@ -78,17 +75,15 @@ Crafty.c("Collision", { | |||
| * | |||
| * @see Crafty.polygon | |||
| */ | |||
| collision: function (poly) { | |||
| collision: function (polygon) { | |||
There was a problem hiding this comment.
I renamed this argument like it described here. You don't mind?
| * checks for collisions. | ||
| * @param collisionData - Collision data object used to track collisions with | ||
| * the specified component. | ||
| /** |
There was a problem hiding this comment.
I've change /**@ to /** (removed the @) not /* because of IDE highlighting, as I can see, you documentation gets only /**@?
And I deleted #._createCollisionHandler and @comp Collision 'cause of its uselessness in private methods, also moved the description to the top of jsdoc.
|
This PR inspired me to open #951. We will hopefully fix code styles automatically soon, so I suggest you don't bother too much about indentation, as there are ~25 more files that need these fixes too :) |
|
Ok, I see. Do I need to revert indentation changes? |
|
Sorry for the long wait, I have been away from my working PC. |
