Skip to content

Class description does not work with @decorators #18

Closed
@theogravity

Description

@theogravity

Trying to use the @Radium decorator from radium

import React, { Component } from 'react'
import Radium from 'radium'

/**
 * react-docgen does not parse this description when a @decorator is present
 */
@Radium
export default class extends Component {
  static displayName = 'DocCommentExample'

  static styleguide = {
    index: '5.2',
    category: 'Features!',
    title: 'Additional examples via doc comment'
  }

  static propTypes = {
    /**
     * Block level
     */
    block: React.PropTypes.bool,
    /**
     * Style types `'default|primary|success|info'`
     */
    bsStyle: React.PropTypes.oneOf(['default', 'primary', 'success', 'info'])
  }

  static defaultProps = {
    bsStyle: 'default'
  }

  render () {
    return <div></div>
  }
}

Parsed output:

{
    "description": "",
    "displayName": "DocCommentExample",
    "props": {
        "block": {
            "type": {
                "name": "bool"
            },
            "required": false,
            "description": "Block level"
        },
        "bsStyle": {
            "type": {
                "name": "enum",
                "value": [
                    {
                        "value": "'default'",
                        "computed": false
                    },
                    {
                        "value": "'primary'",
                        "computed": false
                    },
                    {
                        "value": "'success'",
                        "computed": false
                    },
                    {
                        "value": "'info'",
                        "computed": false
                    }
                ]
            },
            "required": false,
            "description": "Style types `'default|primary|success|info'`",
            "defaultValue": {
                "value": "'default'",
                "computed": false
            }
        }
    }
}

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions