Skip to content

Commit

Permalink
docs: revert changes in windowResized()
Browse files Browse the repository at this point in the history
remove description about "return false"
remove @param, @return tags
(see #4988)
  • Loading branch information
fal-works committed Mar 18, 2021
1 parent 87dee13 commit 81499b8
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions src/core/environment.js
Original file line number Diff line number Diff line change
Expand Up @@ -421,14 +421,9 @@ p5.prototype.windowHeight = getWindowHeight();
/**
* The <a href="#/p5/windowResized">windowResized()</a> function is called once
* every time the browser window is resized. This is a good place to resize the
* canvas or do any other adjustments to accommodate the new window size.<br><br>
* Browsers may have different default behaviors attached to various UI
* events. To prevent any default behavior for this event, add "return false"
* to the end of the method.
* canvas or do any other adjustments to accommodate the new window size.
*
* @method windowResized
* @param {Object} [event] optional UIEvent callback argument.
* @return {*} false if any default behavior should be prevented for this event. (Optional)
* @example
* <div class="norender"><code>
* function setup() {
Expand Down

0 comments on commit 81499b8

Please sign in to comment.