From c6008b4d7cc35cad1e6f88c13afa7bbb49e0116e Mon Sep 17 00:00:00 2001 From: Jonas Jenwald Date: Sun, 27 Nov 2016 11:18:18 +0100 Subject: [PATCH] Fix the JSDoc comment for `Catalog.parseDestDictionary` --- src/core/obj.js | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/core/obj.js b/src/core/obj.js index a501d40d4..84daa2e1e 100644 --- a/src/core/obj.js +++ b/src/core/obj.js @@ -589,12 +589,17 @@ var Catalog = (function CatalogClosure() { }; /** - * Helper function used to parse the contents of destination dictionaries. - * @param {Dict} destDict - The dictionary containing the destination. - * @param {Object} resultObj - The object where the parsed destination + * @typedef ParseDestDictionaryParameters + * @property {Dict} destDict - The dictionary containing the destination. + * @property {Object} resultObj - The object where the parsed destination * properties will be placed. - * @param {string} docBaseUrl - (optional) The document base URL that is used - * when attempting to recover valid absolute URLs from relative ones. + * @property {string} docBaseUrl - (optional) The document base URL that is + * 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) { // Lets URLs beginning with 'www.' default to using the 'http://' protocol.