Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
misc
src
test
CHANGELOG.md
README.md
package.json

README.md

esdoc2 React Plugin (PoC)

This plugin is proof of concept. So, the plugin has only minimum features. We are waiting for your pull request!

Example

/**
 * This is MyClass.
 * @reactProps {!number} prop1 - this is prop1
 * @reactProps {string} prop2 - this is prop2
 */
export default class MyClass extends React.Component {
}

Install

npm install esdoc2-react-plugin

Config

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {"name": "esdoc2-standard-plugin"},
    {"name": "esdoc2-react-plugin"}
  ]
}

Dependency

  • esdoc2-standard-plugin

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru

You can’t perform that action at this time.