Docs
Reference
Handlers
componentDocblock

componentDocblockHandler

Reads the react components leading block comment and adds its content as description to the documentation. This works on all component types.

Examples

When the componentDocblockHandler is active the following component will result in the output below

component.tsx
/**
 * This is my component and this is its description.
 */
() => <div />;

Output

JSON
[
  {
    "description": "This is my component and this is its description."
  }
]