Skip to content

Commit

Permalink
Fix spelling of the "DestinationMaps" type
Browse files Browse the repository at this point in the history
There was an unintended plural-S.
Only occured in documentation. Also add the @global keyword for JSDoc.
  • Loading branch information
marcows committed Dec 27, 2018
1 parent 620b10d commit 3fbfdcb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion data/usemaps.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ function addLink(name, uri)
/**
* Add links for all enabled destination maps to the panel.
*
* @param {DestinationsMaps} destMaps - destination maps
* @param {DestinationMaps} destMaps - destination maps
*
* @fires pagesize
*/
Expand Down
6 changes: 4 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,20 @@
/**
* Configured destination maps.
*
* @typedef {Object[]} DestinationsMaps
* @typedef {Object[]} DestinationMaps
*
* @property {String} name - name of the map
* @property {String} templateurl - template URL with variables
* @property {String} enabled - enabled or disabled in configuration
*
* @global
*/

/**
* Event to pass destination maps around.
*
* @event destmaps
* @type {DestinationsMaps}
* @type {DestinationMaps}
*/

var preferences = require("sdk/simple-prefs");
Expand Down

0 comments on commit 3fbfdcb

Please sign in to comment.