Skip to content

Commit 19a17bc

Browse files
committed
Updating docs
1 parent 1d23aad commit 19a17bc

4 files changed

Lines changed: 40 additions & 1 deletion

File tree

src/events/EventEmitter.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ var EventEmitter = new Class({
6565
* Return an array listing the events for which the emitter has registered listeners.
6666
*
6767
* @method EventEmitter#eventNames
68+
* @since 3.0.0
6869
*
6970
* @return {array}
7071
*/
@@ -73,6 +74,7 @@ var EventEmitter = new Class({
7374
* Return the listeners registered for a given event.
7475
*
7576
* @method EventEmitter#listeners
77+
* @since 3.0.0
7678
*
7779
* @param {string|symbol} event - The event name.
7880
*
@@ -83,6 +85,7 @@ var EventEmitter = new Class({
8385
* Return the number of listeners listening to a given event.
8486
*
8587
* @method EventEmitter#listenerCount
88+
* @since 3.0.0
8689
*
8790
* @param {string|symbol} event - The event name.
8891
*
@@ -93,6 +96,7 @@ var EventEmitter = new Class({
9396
* Calls each of the listeners registered for a given event.
9497
*
9598
* @method EventEmitter#emit
99+
* @since 3.0.0
96100
*
97101
* @param {string|symbol} event - The event name.
98102
*
@@ -103,6 +107,7 @@ var EventEmitter = new Class({
103107
* Add a listener for a given event.
104108
*
105109
* @method EventEmitter#on
110+
* @since 3.0.0
106111
*
107112
* @param {string|symbol} event - The event name.
108113
* @param {function} fn - The listener function.
@@ -115,6 +120,7 @@ var EventEmitter = new Class({
115120
* Add a listener for a given event.
116121
*
117122
* @method EventEmitter#addListener
123+
* @since 3.0.0
118124
*
119125
* @param {string|symbol} event - The event name.
120126
* @param {function} fn - The listener function.
@@ -127,6 +133,7 @@ var EventEmitter = new Class({
127133
* Add a one-time listener for a given event.
128134
*
129135
* @method EventEmitter#once
136+
* @since 3.0.0
130137
*
131138
* @param {string|symbol} event - The event name.
132139
* @param {function} fn - The listener function.
@@ -139,6 +146,7 @@ var EventEmitter = new Class({
139146
* Remove the listeners of a given event.
140147
*
141148
* @method EventEmitter#removeListener
149+
* @since 3.0.0
142150
*
143151
* @param {string|symbol} event - The event name.
144152
* @param {function} fn - Only remove the listeners that match this function.
@@ -152,6 +160,7 @@ var EventEmitter = new Class({
152160
* Remove the listeners of a given event.
153161
*
154162
* @method EventEmitter#off
163+
* @since 3.0.0
155164
*
156165
* @param {string|symbol} event - The event name.
157166
* @param {function} fn - Only remove the listeners that match this function.
@@ -165,6 +174,7 @@ var EventEmitter = new Class({
165174
* Remove all listeners, or those of the specified event.
166175
*
167176
* @method EventEmitter#removeAllListeners
177+
* @since 3.0.0
168178
*
169179
* @param {string|symbol} [event] - The event name.
170180
*

src/gameobjects/bitmaptext/GetBitmapTextSize.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@
44
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
55
*/
66

7-
7+
/**
8+
* [description]
9+
*
10+
* @function GetBitmapTextSize
11+
* @since 3.0.0
12+
* @private
13+
*
14+
* @param {Phaser.GameObjects.DynamicBitmapText|Phaser.GameObjects.BitmapText} src - [description]
15+
* @param {boolean} round - [description]
16+
*/
817
var GetBitmapTextSize = function (src, round)
918
{
1019
var text = src.text;

src/gameobjects/bitmaptext/ParseXMLBitmapFont.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,26 @@
44
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
55
*/
66

7+
/**
8+
* @function getValue
9+
* @since 3.0.0
10+
* @private
11+
*/
712
function getValue (node, attribute)
813
{
914
return parseInt(node.getAttribute(attribute), 10);
1015
}
1116

17+
/**
18+
* @function ParseXMLBitmapFont
19+
* @since 3.0.0
20+
* @private
21+
*
22+
* @param {[type]} xml - [description]
23+
* @param {integer} xSpacing - [description]
24+
* @param {integer} ySpacing - [description]
25+
* @param {[type]} frame - [description]
26+
*/
1227
var ParseXMLBitmapFont = function (xml, xSpacing, ySpacing, frame)
1328
{
1429
if (xSpacing === undefined) { xSpacing = 0; }

src/gameobjects/components/Tint.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
55
*/
66

7+
/**
8+
* @function GetColor
9+
* @since 3.0.0
10+
* @private
11+
*/
712
var GetColor = function (value)
813
{
914
return (value >> 16) + (value & 0xff00) + ((value & 0xff) << 16);

0 commit comments

Comments
 (0)