Skip to content

Commit eb57c32

Browse files
author
Nio Kasgami
authored
Fixing Misleading jsdoc
It's only a small corrections but I do noticed that the js doc in the cores files are REALLY misleading sometime or when you read the descriptions they often doesn't make any sences
1 parent ed171d2 commit eb57c32

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

js/rpg_core/Bitmap.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -448,8 +448,8 @@ Bitmap.prototype.clear = function() {
448448
* @method fillRect
449449
* @param {Number} x The x coordinate for the upper-left corner
450450
* @param {Number} y The y coordinate for the upper-left corner
451-
* @param {Number} width The width of the rectangle to clear
452-
* @param {Number} height The height of the rectangle to clear
451+
* @param {Number} width The width of the rectangle to fill
452+
* @param {Number} height The height of the rectangle to fill
453453
* @param {String} color The color of the rectangle in CSS format
454454
*/
455455
Bitmap.prototype.fillRect = function(x, y, width, height, color) {
@@ -477,11 +477,11 @@ Bitmap.prototype.fillAll = function(color) {
477477
* @method gradientFillRect
478478
* @param {Number} x The x coordinate for the upper-left corner
479479
* @param {Number} y The y coordinate for the upper-left corner
480-
* @param {Number} width The width of the rectangle to clear
481-
* @param {Number} height The height of the rectangle to clear
482-
* @param {String} color1 The start color of the gradation
483-
* @param {String} color2 The end color of the gradation
484-
* @param {Boolean} vertical Whether it draws a vertical gradient
480+
* @param {Number} width The width of the rectangle to fill
481+
* @param {Number} height The height of the rectangle to fill
482+
* @param {String} color1 The gradient starting color
483+
* @param {String} color2 The gradient ending color
484+
* @param {Boolean} vertical Wether the gradient should be draw as vertical or not
485485
*/
486486
Bitmap.prototype.gradientFillRect = function(x, y, width, height, color1,
487487
color2, vertical) {
@@ -502,11 +502,11 @@ Bitmap.prototype.gradientFillRect = function(x, y, width, height, color1,
502502
};
503503

504504
/**
505-
* Draw the filled circle.
505+
* Draw a bitmap in the shape of a circle
506506
*
507507
* @method drawCircle
508-
* @param {Number} x The x coordinate of the center of the circle
509-
* @param {Number} y The y coordinate of the center of the circle
508+
* @param {Number} x The x coordinate based on the circle center
509+
* @param {Number} y The y coordinate based on the circle center
510510
* @param {Number} radius The radius of the circle
511511
* @param {String} color The color of the circle in CSS format
512512
*/
@@ -878,4 +878,4 @@ Bitmap.prototype.startRequest = function(){
878878
this._decodeAfterRequest = false;
879879
this._requestImage(this._url);
880880
}
881-
};
881+
};

0 commit comments

Comments
 (0)