react-native/website/jsdocs
Christine Abernathy 22f59a88a6 Improve autogen for reference docs including jsdoc support
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
2016-06-21 14:28:43 -07:00
..
TypeExpressionParser.js Lint code - change double quotes to single in website/jsdocs. Add/remove semicolons to keep code style 2015-03-26 11:14:54 -07:00
findExportDefinition.js Lint code - change double quotes to single in website/jsdocs. Add/remove semicolons to keep code style 2015-03-26 11:14:54 -07:00
generic-function-visitor.js Lint code - change double quotes to single in website/jsdocs. Add/remove semicolons to keep code style 2015-03-26 11:14:54 -07:00
jsdoc-conf.json Improve autogen for reference docs including jsdoc support 2016-06-21 14:28:43 -07:00
jsdoc-plugin-values.js Improve autogen for reference docs including jsdoc support 2016-06-21 14:28:43 -07:00
jsdocs.js [autodocs] add doc blocks to more things 2015-09-03 11:53:20 -07:00
meta.js Lint code - change double quotes to single in website/jsdocs. Add/remove semicolons to keep code style 2015-03-26 11:14:54 -07:00
traverseFlat.js Lint code - change double quotes to single in website/jsdocs. Add/remove semicolons to keep code style 2015-03-26 11:14:54 -07:00
type.js Lint code - change double quotes to single in website/jsdocs. Add/remove semicolons to keep code style 2015-03-26 11:14:54 -07:00