Fix the JSDoc comment for Catalog.parseDestDictionary
This commit is contained in:
parent
ce416eb26e
commit
c6008b4d7c
@ -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.
|
||||||
|
Loading…
Reference in New Issue
Block a user