docs: Address JSDOC warnings

cfpb · Nov 3, 2023 · 01be9f1 · 01be9f1
1 parent 796c405
commit 01be9f1
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/packages/cfpb-atomic-component/src/utilities/atomic-helpers.js b/packages/cfpb-atomic-component/src/utilities/atomic-helpers.js
@@ -100,9 +100,9 @@ function setInitFlag(element) {
 
 /**
  * @param {string} selector - Selector to search for in the document.
- * @param {Object} config - Configuration will be provided to the Constructor's init()
  * @param {Function} Constructor - A constructor function.
  * @param {HTMLElement} [scope] - A dom node in which to query the selector.
+ * @param {object} config - Configuration will be provided to the Constructor's init()
  *   If not supplied, it defaults to the `document`.
  * @returns {Array} List of instances that were instantiated.
  */

diff --git a/packages/cfpb-forms/src/organisms/Multiselect.js b/packages/cfpb-forms/src/organisms/Multiselect.js
@@ -538,7 +538,7 @@ function Multiselect(element) {
 
   /**
    * Set up and create the multiselect.
-   * @param multiselectConfig Multiselect configuration options
+   * @param {object} multiselectConfig - Multiselect configuration options
    * @returns {Multiselect} An instance.
    */
   function init(multiselectConfig = DEFAULT_CONFIG) {

diff --git a/packages/cfpb-forms/src/organisms/MultiselectModel.js b/packages/cfpb-forms/src/organisms/MultiselectModel.js
@@ -29,7 +29,7 @@ function stringMatch(x, y) {
  * @param {HTMLOptionsCollection} options -
  *   Set of options from a <select> element.
  * @param {string} name - a unique name for this multiselect.
- * @param {Object} config - Customization of Multiselect behavior
+ * @param {object} config - Customization of Multiselect behavior
  */
 function MultiselectModel(options, name, config) {
   const _options = options;