Merge pull request #7853 from Snuffleupagus/jsdoc-parseDestDictionary

Fix the JSDoc comment for `Catalog.parseDestDictionary`
mozilla · Nov 27, 2016 · e6720ad · e6720ad
2 parents ce416eb + c6008b4
commit e6720ad
Showing 1 changed file with 10 additions and 5 deletions.
diff --git 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.