docs: update jsdoc comments

carbon-design-system · Jul 6, 2021 · 6908582 · 6908582
1 parent 0fda8b2
commit 6908582
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/packages/sketch/src/sharedStyles/colors.js b/packages/sketch/src/sharedStyles/colors.js
@@ -47,6 +47,8 @@ function formatColorName({ name, grade, formatFor }) {
  * the result
  * @param {object} params - syncColors parameters
  * @param {Document} params.document
+ * @param {string} params.formatFor - one of 'colorVariable' or
+ * 'sharedLayerStyle'
  * @returns {Array<SharedStyle|Swatch>}
  */
 export function syncColors({ document, formatFor }) {

diff --git a/packages/sketch/src/tools/sharedStyles.js b/packages/sketch/src/tools/sharedStyles.js
@@ -81,7 +81,7 @@ export function syncSharedStyle({
  * @param {object} params - syncColorStyle parameters
  * @param {Document} params.document
  * @param {string} params.name
- * @param {string} params.value
+ * @param {string} params.color
  * @returns {SharedStyle}
  */
 export function syncColorStyle({ document, name, color }) {