ZenBrowserMirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/zen-browser/pdf.js.git synced 2025-07-08 09:20:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Consistently use @returns for returned data types in JSDoc comments

Browse source 
Sometimes we also used `@return`, but `@returns` is what the JSDoc
documentation recommends. Even though `@return` works as an alias, it's
good to use the recommended syntax and to be consistent within the
project.
This commit is contained in:
Tim van der Meij 2019-10-12 18:14:29 +02:00
parent 8b4ae6f3eb
commit ca3a58f93a
No known key found for this signature in database
GPG key ID: 8C3FD2925A5F2762
16 changed files with 77 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

6
web/grab_to_pan.js
View file

@ -93,7 +93,7 @@ GrabToPan.prototype = {
* Override this method to change the default behaviour.
*
* @param node {Element} The target of the event
* @return {boolean} Whether to not react to the click event.
* @returns {boolean} Whether to not react to the click event.
*/
ignoreTarget: function GrabToPan_ignoreTarget(node) {
// Use matchesSelector to check whether the clicked element
@ -205,8 +205,8 @@ var isSafari6plus = /Apple/.test(navigator.vendor) &&
/**
* Whether the left mouse is not pressed.
* @param event {MouseEvent}
* @return {boolean} True if the left mouse button is not pressed.
* False if unsure or if the left mouse button is pressed.
* @returns {boolean} True if the left mouse button is not pressed,
* False if unsure or if the left mouse button is pressed.
*/
function isLeftMouseReleased(event) {
if ('buttons' in event && isNotIEorIsIE10plus) {