Addon-docs: Support JSDoc params to describe the signature of a function in the props table

Is your feature request related to a problem? Please describe. I would like to be able to define the signature of my function in description column of the props table.

I love how it’s done in Semantic UI React documentation

This is define with JSDoc:

    /**
     * Called on blur.
     *
     * @param {SyntheticEvent} event - React's original SyntheticEvent.
     * @param {object} data - All props.
     */
    onBlur: PropTypes.func,

This doesn’t seem to be a native feature of react-docgen. I made a quick test on the playground and I get the following:

    "bar": {
      "type": {
        "name": "custom",
        "raw": "function(props, propName, componentName) {\n  // ...\n}"
      },
      "required": false,
      "description": "Description of prop \"bar\" (a custom validation function).\n@param {SyntheticEvent} event - Test",
      "defaultValue": {
        "value": "21",
        "computed": false
      }
    },

I guess they somehow parse the JSDoc in the description prop.

[shilman]

@Losses there are two different codepaths, one for react-docgen-typescript-loader (the recommended 5.3 setup) and one for babel-plugin-react-docgen (the recommended 6.0 setup). i’m guessing @patricklafrance fixed this for the former but not the latter.

More info: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#rolling-back

[patricklafrance]

Still need to add the @params and @returns tags optional description under the func type.

Working on it now!