Skip to content

Commit

Permalink
docs: update to width and height doc comments (#4592)
Browse files Browse the repository at this point in the history
  • Loading branch information
mboles authored and gkatsev committed Sep 1, 2017
1 parent 5e23048 commit 006fb3b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/js/player.js
Original file line number Diff line number Diff line change
Expand Up @@ -605,10 +605,11 @@ class Player extends Component {
}

/**
* A getter/setter for the `Player`'s width.
* A getter/setter for the `Player`'s width. Returns the player's configured value.
* To get the current width use `currentWidth()`.
*
* @param {number} [value]
* The value to set the `Player's width to.
* The value to set the `Player`'s width to.
*
* @return {number}
* The current width of the `Player` when getting.
Expand All @@ -618,10 +619,11 @@ class Player extends Component {
}

/**
* A getter/setter for the `Player`'s height.
* A getter/setter for the `Player`'s height. Returns the player's configured value.
* To get the current height use `currentheight()`.
*
* @param {number} [value]
* The value to set the `Player's heigth to.
* The value to set the `Player`'s heigth to.
*
* @return {number}
* The current height of the `Player` when getting.
Expand Down

0 comments on commit 006fb3b

Please sign in to comment.