docs: revert changes in event handler functions

remove @return tags (see #4988)
processing · Mar 18, 2021 · 766cc9a · 766cc9a
1 parent 81499b8
commit 766cc9a
Show file tree

Hide file tree

Showing 3 changed files with 0 additions and 13 deletions.
diff --git a/src/events/keyboard.js b/src/events/keyboard.js
@@ -123,7 +123,6 @@ p5.prototype.keyCode = 0;
  *
  * @method keyPressed
  * @param  {Object} [event] optional KeyboardEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -197,7 +196,6 @@ p5.prototype._onkeydown = function(e) {
  *
  * @method keyReleased
  * @param  {Object} [event] optional KeyboardEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -258,7 +256,6 @@ p5.prototype._onkeyup = function(e) {
  *
  * @method keyTyped
  * @param  {Object} [event] optional KeyboardEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>

diff --git a/src/events/mouse.js b/src/events/mouse.js
@@ -487,7 +487,6 @@ p5.prototype._setMouseButton = function(e) {
  *
  * @method mouseMoved
  * @param  {Object} [event] optional MouseEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -543,7 +542,6 @@ p5.prototype._setMouseButton = function(e) {
  *
  * @method mouseDragged
  * @param  {Object} [event] optional MouseEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -626,7 +624,6 @@ p5.prototype._onmousemove = function(e) {
  *
  * @method mousePressed
  * @param  {Object} [event] optional MouseEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -706,7 +703,6 @@ p5.prototype._onmousedown = function(e) {
  *
  * @method mouseReleased
  * @param  {Object} [event] optional MouseEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -785,7 +781,6 @@ p5.prototype._ondragover = p5.prototype._onmousemove;
  *
  * @method mouseClicked
  * @param  {Object} [event] optional MouseEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -854,7 +849,6 @@ p5.prototype._onclick = function(e) {
  *
  * @method doubleClicked
  * @param  {Object} [event] optional MouseEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -945,7 +939,6 @@ p5.prototype._pmouseWheelDeltaY = 0;
  *
  * @method mouseWheel
  * @param  {Object} [event] optional WheelEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>

diff --git a/src/events/touch.js b/src/events/touch.js
@@ -78,7 +78,6 @@ function getTouchInfo(canvas, w, h, e, i = 0) {
  *
  * @method touchStarted
  * @param  {Object} [event] optional TouchEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -159,7 +158,6 @@ p5.prototype._ontouchstart = function(e) {
  *
  * @method touchMoved
  * @param  {Object} [event] optional TouchEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>
@@ -232,7 +230,6 @@ p5.prototype._ontouchmove = function(e) {
  *
  * @method touchEnded
  * @param  {Object} [event] optional TouchEvent callback argument.
- * @return {*} false if any default behavior should be prevented for this event. (Optional)
  * @example
  * <div>
  * <code>