From 4f88b524a7f9361ad7428ad80882d422a7e336da Mon Sep 17 00:00:00 2001 From: Justin Obara Date: Mon, 6 Aug 2018 12:21:11 -0400 Subject: [PATCH] GPII-3053: linting --- extension/src/content_scripts/utils.js | 8 ++++---- extension/src/lib/PrefsEditor.js | 5 +++++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/extension/src/content_scripts/utils.js b/extension/src/content_scripts/utils.js index caa7c10..64676d0 100644 --- a/extension/src/content_scripts/utils.js +++ b/extension/src/content_scripts/utils.js @@ -21,12 +21,12 @@ * jQuery object with 1 or more elements. If no elements found, it returns * either an empty jQuery object or the default, if a default is provided. * - * @param that {Object} - a fluid.viewComponent - * @param selectors {String|Array} - one or more selector names to search through in the order to try. + * @param {Component} that - a fluid.viewComponent + * @param {String|Array} selectorNames - one or more selector names to search through in the order to try. * The selector names must correspond to selectors in the component's * selectors block. - * @param deflt {Any} - a default value to use if no elements found for any of the selector names - * @returns {Any} - a jQuery object if found. If nothing found, either the deflt value or undefined is returned. + * @param {Any} deflt - a default value to use if no elements found for any of the selector names + * @return {Any} - a jQuery object if found. If nothing found, either the `deflt` value or undefined is returned. */ gpii.chrome.utils.findFirstSelector = function (that, selectorNames, deflt) { selectorNames = fluid.makeArray(selectorNames); diff --git a/extension/src/lib/PrefsEditor.js b/extension/src/lib/PrefsEditor.js index 19bbf14..4100dda 100644 --- a/extension/src/lib/PrefsEditor.js +++ b/extension/src/lib/PrefsEditor.js @@ -147,6 +147,11 @@ * Sends the prefsEditor.model to the store and fires onSave * Overrides the default writeImpl functionality as all of the model, including the default values, must be sent * to the store. + * + * @param {Component} that - the component + * @param {Object} modelToSave - the model to be written + * + * @return {Promise} promise - a promise that is resolved when the model is saved. */ gpii.chrome.prefs.extensionPanel.writeImpl = function (that, modelToSave) { var promise = fluid.promise();