A few JSDoc fixes. (#252)

lib/fetchResource.js

@@ -13,7 +13,7 @@ const upgradeToHttps = require('./upgradeToHttps');
 /**
  * Download the resource
  *
- * @param {string} resourceUrl
+ * @param {string} resourceUrl - The URL to fetch
  * @param {Function} cb - callback
  * @return {Object.XMLHttpRequest} request object
  */

lib/generate.js

@@ -12,8 +12,11 @@ const fetchResource = require('./fetchResource');
 /**
  * Generate SRI data for a resource
  *
+ * @param {Array} options - Options Object
  * @param {Array} options.algorithms - List of desired hash algorithms
  * @param {string} options.url - Resource URL
+ * @param {Function} cb - callback
+ * @return {Function.cb}
  */
 const generate = (options, cb) => {
   if (typeof options.algorithms === 'string') {

lib/generateElement.js

@@ -10,8 +10,8 @@ const generate = require('./generate');
  * Wrap SRI data for resourceUrl in a script tag
  *
  * @deprecated pending move to isomorphic app
- * @param {string} resourceUrl
- * @param {Array} algorithms
+ * @param {string} resourceUrl - Resource URL
+ * @param {Array} algorithms - The desired hash algorithms
  * @param {Function} cb - callback
  */
 const generateElement = (resourceUrl, algorithms, cb) => {

lib/guessResourceType.js

@@ -11,6 +11,7 @@ const resourceTypes = require('./data/resourceTypes');
 /**
  * Figure out what type of resource the user is requesting.
  *
+ * @param {Object} resource - resource object
  * @param {string} resource.ct - content-type
  * @param {string} resource.url - URL
  * @return {string} assumed file extension

lib/moduleForProtocol.js

@@ -11,7 +11,7 @@ const { URL } = require('url');
 /**
  * Choose corresponding module (http or https) for downloading a resource.
  *
- * @param {string} urlString
+ * @param {string} urlString - Input URL
  * @return {Object} http or https module
  */
 const moduleForProtocol = (urlString) => {

lib/processResource.js

@@ -11,7 +11,7 @@ const eligibility = require('./eligibility');
  *
  * @param {string} data
  * @param {Object} response
- * @param {string} resourceUrl
+ * @param {string} resourceUrl - Resource URL
  * @param {Function} cb - callback
  * @return {Function.cb}
  */

lib/shuffleArray.js

@@ -8,6 +8,9 @@
  * Shuffle the elements of the array.
  *
  * https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
+ *
+ * @param {Array} oldArray - The input Array
+ * @return {Array} The new shuffled Array
  */
 const shuffleArray = (oldArray) => {
   const array = oldArray.slice(0);

lib/upgradeToHttps.js

@@ -10,7 +10,7 @@ const secureHosts = require('./data/secureHosts');
 /**
  * Upgrade the given URL to HTTPS, if it's from a host believed to support it.
  *
- * @param {string} urlString
+ * @param {string} urlString - Input URL
  * @return {string} processed URL
  */
 const upgradeToHttps = (urlString) => {