ZenBrowserMirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/zen-browser/pdf.js.git synced 2025-07-08 17:30:09 +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

12
src/display/display_utils.js
View file

@ -252,7 +252,7 @@ class PageViewport {
/**
* Clones viewport, with optional additional properties.
* @param {PageViewportCloneParameters} [params]
* @return {PageViewport} Cloned viewport.
* @returns {PageViewport} Cloned viewport.
*/
clone({ scale = this.scale, rotation = this.rotation,
dontFlip = false, } = {}) {
@ -271,7 +271,7 @@ class PageViewport {
* converting PDF location into canvas pixel coordinates.
* @param {number} x - The x-coordinate.
* @param {number} y - The y-coordinate.
* @return {Object} Object containing `x` and `y` properties of the
* @returns {Object} Object containing `x` and `y` properties of the
* point in the viewport coordinate space.
* @see {@link convertToPdfPoint}
* @see {@link convertToViewportRectangle}
@ -283,8 +283,8 @@ class PageViewport {
/**
* Converts PDF rectangle to the viewport coordinates.
* @param {Array} rect - The xMin, yMin, xMax and yMax coordinates.
* @return {Array} Array containing corresponding coordinates of the rectangle
* in the viewport coordinate space.
* @returns {Array} Array containing corresponding coordinates of the
* rectangle in the viewport coordinate space.
* @see {@link convertToViewportPoint}
*/
convertToViewportRectangle(rect) {
@ -298,7 +298,7 @@ class PageViewport {
* for converting canvas pixel location into PDF one.
* @param {number} x - The x-coordinate.
* @param {number} y - The y-coordinate.
* @return {Object} Object containing `x` and `y` properties of the
* @returns {Object} Object containing `x` and `y` properties of the
* point in the PDF coordinate space.
* @see {@link convertToViewportPoint}
*/
@ -514,7 +514,7 @@ class PDFDateString {
* parts of the date string).
*
* @param {string} input
* @return {Date|null}
* @returns {Date|null}
*/
static toDateObject(input) {
if (!input || !isString(input)) {