Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #7853 from Snuffleupagus/jsdoc-parseDestDictionary

Browse Source 
Fix the JSDoc comment for `Catalog.parseDestDictionary`
This commit is contained in:
Tim van der Meij 2016-11-27 16:21:03 +01:00 committed by GitHub
commit e6720ad558
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/core/obj.js
View File

@ -589,12 +589,17 @@ var Catalog = (function CatalogClosure() {
}; };
/** /**
* Helper function used to parse the contents of destination dictionaries. * @typedef ParseDestDictionaryParameters
* @param {Dict} destDict - The dictionary containing the destination. * @property {Dict} destDict - The dictionary containing the destination.
* @param {Object} resultObj - The object where the parsed destination * @property {Object} resultObj - The object where the parsed destination
* properties will be placed. * properties will be placed.
* @param {string} docBaseUrl - (optional) The document base URL that is used * @property {string} docBaseUrl - (optional) The document base URL that is
* when attempting to recover valid absolute URLs from relative ones. * used when attempting to recover valid absolute URLs from relative ones.
*/
/**
* Helper function used to parse the contents of destination dictionaries.
* @param {ParseDestDictionaryParameters} params
*/ */
Catalog.parseDestDictionary = function Catalog_parseDestDictionary(params) { Catalog.parseDestDictionary = function Catalog_parseDestDictionary(params) {
// Lets URLs beginning with 'www.' default to using the 'http://' protocol. // Lets URLs beginning with 'www.' default to using the 'http://' protocol.