mirror of
https://github.com/status-im/react-native.git
synced 2025-01-09 17:15:54 +00:00
22f59a88a6
Summary: As part of improving the API and Component reference docs #8154 this pull request adds the following: - jsdoc support for API docs. See the AlertIOS changes as an example. - type definitions support and added to both API and Component docs. This is supported via react-docgen and jsdoc. - better formatting of method properties (now shown in a table). FYI, API and Component docs were previously generated in two different ways. Components were using react-docgen and that basically remains as-is. APIs were using custom parsing code and that's been switched to use a jsdoc parser + react-docgen as an option for typedefs (it could also use the jsdoc parser). Two docs have been updated to showcase how we'd like the new docs to look: - AlertIOS (API): showing method parameters, examples, typedefs, more details overall. - Statusbar (Component): showing method parameters, typedefs, more details overall. **Note**: To convert new API docs to use the new format, add `jsdoc` to the initial file comment. C Closes https://github.com/facebook/react-native/pull/8196 Differential Revision: D3465037 Pulled By: lacker fbshipit-source-id: 78415d44bc5be02db802f5b1f7a0b249689abdf7
30 lines
831 B
JSON
30 lines
831 B
JSON
{
|
|
"scripts": {
|
|
"start": "RN_VERSION=next node server/server.js",
|
|
"gh-pages": "node publish-gh-pages.js"
|
|
},
|
|
"dependencies": {
|
|
"bluebird": "^2.9.21",
|
|
"connect": "2.8.3",
|
|
"esprima-fb": "15001.1001.0-dev-harmony-fb",
|
|
"fs.extra": "1.3.2",
|
|
"glob": "6.0.4",
|
|
"jstransform": "11.0.3",
|
|
"mkdirp": "^0.5.1",
|
|
"optimist": "0.6.0",
|
|
"react": "~0.13.0",
|
|
"react-docgen": "^2.9.0",
|
|
"react-page-middleware": "git://github.com/facebook/react-page-middleware.git",
|
|
"request": "^2.69.0",
|
|
"semver-compare": "^1.0.0",
|
|
"babel-core": "^6.6.4",
|
|
"babel-plugin-external-helpers": "^6.5.0",
|
|
"babel-polyfill": "^6.6.1",
|
|
"babel-preset-react-native": "~1.6.0",
|
|
"babel-register": "^6.6.0",
|
|
"babel-types": "^6.6.4",
|
|
"jsdoc-api": "^1.1.0",
|
|
"deep-assign": "^2.0.0"
|
|
}
|
|
}
|