forked from facebook/react-native
-
Notifications
You must be signed in to change notification settings - Fork 3
RN Docs standards
Ayush Jain edited this page Aug 13, 2020
·
5 revisions
The project would involve following changes/standards to the documentation:
-
Remove asterisk from comments (JSDoc).
-
Update title and description of each component to sync it with corresponding markdown file in
react-native-website
. -
@platform
annotation for specifying the platform(s). -
@default
annotation for default values of the props.For default values on different platform use default with platform annotation.
@default {@platform android} @default {@platform ios} '#007AFF'
-
Use
@type
annotation for platform dependent supported datatypes@type enum(‘small’, ‘large’) @type {@platform android} number
-
Follow markdown format for line breaks i.e., a single new line for the space and double new line for the line break.