Interface: Add missing param docs for singleEnableItems() and multipl…

…eEnableItems() (#22964)
WordPress · Jun 6, 2020 · ed80299 · ed80299
1 parent a9d2c1f
commit ed80299
Showing 1 changed file with 14 additions and 5 deletions.
diff --git a/packages/interface/src/store/reducer.js b/packages/interface/src/store/reducer.js
@@ -11,8 +11,12 @@ import { combineReducers } from '@wordpress/data';
 /**
  * Reducer to keep tract of the active area per scope.
  *
- * @param {boolean}  state   Previous state.
- * @param {Object}   action  Action Object.
+ * @param {boolean} state           Previous state.
+ * @param {Object}  action          Action object.
+ * @param {string}  action.type     Action type.
+ * @param {string}  action.itemType Type of item.
+ * @param {string}  action.scope    Item scope.
+ * @param {string}  action.item     Item name.
  *
  * @return {Object} Updated state.
  */
@@ -34,10 +38,15 @@ export function singleEnableItems(
 }
 
 /**
- * Reducer keeping track of the "pinned" items per scope
+ * Reducer keeping track of the "pinned" items per scope.
  *
- * @param {boolean}  state   Previous state.
- * @param {Object}   action  Action Object.
+ * @param {boolean} state           Previous state.
+ * @param {Object}  action          Action object.
+ * @param {string}  action.type     Action type.
+ * @param {string}  action.itemType Type of item.
+ * @param {string}  action.scope    Item scope.
+ * @param {string}  action.item     Item name.
+ * @param {boolean} action.isEnable Whether the item is pinned.
  *
  * @return {Object} Updated state.
  */