mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Aniket Kumar
44cb09ac46
Summary: Fixes https://github.com/MLH-Fellowship/react-native/issues/60 The PR is part of an effort to update the code comments to match the current documentation on the React Native website. The project is a part of the MLH Fellowship program and involves the automatic generation of the website docs from code comments and flow types as the end result. To learn more about the project you can visit the project wiki: - [Project Details](https://github.com/MLH-Fellowship/0.4.x-projects/wiki/React-Native-Flowtype-API-Docs-Generator) - [RN Docs Standards](https://github.com/MLH-Fellowship/react-native/wiki/RN-Docs-standards) Link to the documentation(the source of truth): - [switch.md](https://github.com/MLH-Fellowship/react-native-website/blob/master/docs/switch.md) ## Changes * Update the title and prop description from docs. * Remove unnecessary `*` from the code comments. * Add Snack player example specified in the docs to the code comments as JSDoc. * Add `type` annotation to parse supported datatype by the prop. * Add `platform` annotation to specify platforms supported by a prop. * Add `default` annotation to parse default value of prop. ## Changelog [Internal] Pull Request resolved: https://github.com/facebook/react-native/pull/29546 Test Plan: All changes are made to the code comments and thus there is no need for testing. Reviewed by jevakallio Reviewed By: cpojer Differential Revision: D22921438 Pulled By: motiz88 fbshipit-source-id: eaab1e04252c15d7d3dd18a2b162fa97a4478dd6