mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-22 16:18:08 +02:00
Code Activity

Consistently use string for string data types in JSDoc comments

Browse source 
Sometimes we also used `String`, but `string` is the what the JSDoc
documentation recommends.
This commit is contained in:
Tim van der Meij 2019-10-12 15:59:09 +02:00
parent e75991b49e
commit efd331daa1
No known key found for this signature in database
GPG key ID: 8C3FD2925A5F2762
6 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
web/app.js
View file

@ -764,7 +764,7 @@ let PDFViewerApplication = {
/**
* Show the error box.
* @param {String} message A message that is human readable.
* @param {string} message A message that is human readable.
* @param {Object} moreInfo (optional) Further information about the error
* that is more technical. Should have a 'message'
* and optionally a 'stack' property.

6
web/chromecom.js
View file

@ -30,8 +30,8 @@ let ChromeCom = {
* Creates an event that the extension is listening for and will
* asynchronously respond by calling the callback.
*
* @param {String} action The action to trigger.
* @param {String} data Optional data to send.
* @param {string} action The action to trigger.
* @param {string} data Optional data to send.
* @param {Function} callback Optional response callback that will be called
* with one data argument. When the request cannot be handled, the callback
* is immediately invoked with no arguments.
@ -56,7 +56,7 @@ let ChromeCom = {
/**
* Resolves a PDF file path and attempts to detects length.
*
* @param {String} file - Absolute URL of PDF file.
* @param {string} file - Absolute URL of PDF file.
* @param {OverlayManager} overlayManager - Manager for the viewer overlays.
* @param {Function} callback - A callback with resolved URL and file length.
*/

8
web/firefoxcom.js
View file

@ -32,8 +32,8 @@ let FirefoxCom = (function FirefoxComClosure() {
* synchronously respond to.
* NOTE: It is reccomended to use request() instead since one day we may not
* be able to synchronously reply.
* @param {String} action The action to trigger.
* @param {String} data Optional data to send.
* @param {string} action The action to trigger.
* @param {string} data Optional data to send.
* @return {*} The response.
*/
requestSync(action, data) {
@ -52,8 +52,8 @@ let FirefoxCom = (function FirefoxComClosure() {
/**
* Creates an event that the extension is listening for and will
* asynchronously respond by calling the callback.
* @param {String} action The action to trigger.
* @param {String} data Optional data to send.
* @param {string} action The action to trigger.
* @param {string} data Optional data to send.
* @param {Function} callback Optional response callback that will be called
* with one data argument.
*/

2
web/pdf_link_service.js
View file

@ -189,7 +189,7 @@ class PDFLinkService {
/**
* Prefix the full url on anchor links to make sure that links are resolved
* relative to the current URL instead of the one defined in <base href>.
* @param {String} anchor The anchor hash, including the #.
* @param {string} anchor The anchor hash, including the #.
* @returns {string} The hyperlink to the PDF object.
*/
getAnchorUrl(anchor) {