From 0f9927f0778d88deec81542833dc58b0ba13a463 Mon Sep 17 00:00:00 2001 From: DIonysos Dajka Date: Wed, 24 Jun 2020 11:27:41 +0200 Subject: [PATCH] fix: Fix JSDoc comment syntax, noissue --- src/utils/styleProps.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/utils/styleProps.js b/src/utils/styleProps.js index 1801d5c8..2e504824 100644 --- a/src/utils/styleProps.js +++ b/src/utils/styleProps.js @@ -32,11 +32,11 @@ function getValueByIndex(prop, index = 0) { * Builds a CSS ruleset based on the props passed to the component. * * @param {object[]} stylePropConfig - Style prop configuration objects - * @param {string} stylePropConfig[].styleProp - Name of the style prop - * @param {Array} stylePropConfig[].properties - The CSS properties that the value should be applied to - * @param {Function} stylePropConfig[].getValue - Transforms the prop value into a valid CSS property value. + * @param {string} stylePropConfig.styleProp - Name of the style prop + * @param {Array} stylePropConfig.properties - The CSS properties that the value should be applied to + * @param {Function} stylePropConfig.getValue - Transforms the prop value into a valid CSS property value. * This function is only called when the prop's value is not null or undefined. - * @param {Function} stylePropConfig[].getRules - Use this instead of stylePropConfig.properties and stylePropConfig.getValue to define more complex style props that need to generate multiple CSS rules. Will be called with any value, so you have to make sure to return a falsy value if you don't want to add a rule. + * @param {Function} stylePropConfig.getRules - Use this instead of stylePropConfig.properties and stylePropConfig.getValue to define more complex style props that need to generate multiple CSS rules. Will be called with any value, so you have to make sure to return a falsy value if you don't want to add a rule. * @param {object} componentProps - Props that the component was called with * @param {number} breakpointIndex - If the passed prop is an array of responsive values, this number tells us which value to pick from the array * @@ -102,11 +102,11 @@ function getResponsiveRules(stylePropConfig, componentProps) { /** * * @param {object[]} stylePropConfig - Style prop configuration objects - * @param {string} stylePropConfig[].styleProp - Name of the style prop - * @param {Array} stylePropConfig[].properties - The CSS properties that the value should be applied to - * @param {Function} stylePropConfig[].getValue - Transforms the prop value into a valid CSS property value. + * @param {string} stylePropConfig.styleProp - Name of the style prop + * @param {Array} stylePropConfig.properties - The CSS properties that the value should be applied to + * @param {Function} stylePropConfig.getValue - Transforms the prop value into a valid CSS property value. * This function is only called when the prop's value is not null or undefined. - * @param {Function} stylePropConfig[].getRules - Use this instead of stylePropConfig.properties and stylePropConfig.getValue to define more complex style props that need to generate multiple CSS rules. Will be called with any value, so you have to make sure to return a falsy value if you don't want to add a rule. + * @param {Function} stylePropConfig.getRules - Use this instead of stylePropConfig.properties and stylePropConfig.getValue to define more complex style props that need to generate multiple CSS rules. Will be called with any value, so you have to make sure to return a falsy value if you don't want to add a rule. * @param {object} [baseRules] - Any static CSS rules to add before the dynamic styleProp rules * * @returns {Function} - A responsive style prop function that can be used directly in a styled component, e.g.