Tweak docs before releasing 0.19

Reviewed By: mkonicek

Differential Revision:D2883844
Ninja: Only docs and React Native website, doesn't affect any fb apps

fb-gh-sync-id: 4bf56dc695224f172832ca5381cebceab9e5fe4f
This commit is contained in:
Martin Konicek 2016-01-30 17:10:14 -08:00 committed by facebook-github-bot-7
parent 9d0242fdc3
commit 679beb2a3a
4 changed files with 9 additions and 15 deletions

View File

@ -122,12 +122,7 @@ var AppState = {
_eventHandlers[type].delete(handler); _eventHandlers[type].delete(handler);
}, },
// TODO: getCurrentAppState callback seems to be called at a really late stage
// after app launch. Trying to get currentState when mounting App component
// will likely to have the initial value here.
// Initialize to 'active' instead of null.
currentState: ('active' : ?string), currentState: ('active' : ?string),
}; };
RCTDeviceEventEmitter.addListener( RCTDeviceEventEmitter.addListener(

View File

@ -118,8 +118,7 @@ class CameraRoll {
/** /**
* Saves the image to the camera roll / gallery. * Saves the image to the camera roll / gallery.
* *
* @param {string} tag On Android, this is a local URI, such * On Android, the tag is a local URI, such as `"file:///sdcard/img.png"`.
* as `"file:///sdcard/img.png"`.
* *
* On iOS, the tag can be one of the following: * On iOS, the tag can be one of the following:
* *
@ -128,8 +127,7 @@ class CameraRoll {
* - a tag not matching any of the above, which means the image data will * - a tag not matching any of the above, which means the image data will
* be stored in memory (and consume memory as long as the process is alive) * be stored in memory (and consume memory as long as the process is alive)
* *
* Returns a Promise which when resolved will be passed the new uri * Returns a Promise which when resolved will be passed the new URI.
*
*/ */
static saveImageWithTag(tag) { static saveImageWithTag(tag) {
invariant( invariant(
@ -147,13 +145,12 @@ class CameraRoll {
} }
/** /**
* Returns a Promise with photo identifier objects from the local camera * Returns a Promise with photo identifier objects from the local camera
* roll of the device matching shape defined by `getPhotosReturnChecker`. * roll of the device matching shape defined by `getPhotosReturnChecker`.
* *
* @param {object} params See `getPhotosParamChecker`. * @param {object} params See `getPhotosParamChecker`.
*
* Returns a Promise which when resolved will be of shape `getPhotosReturnChecker`
* *
* Returns a Promise which when resolved will be of shape `getPhotosReturnChecker`.
*/ */
static getPhotos(params) { static getPhotos(params) {
if (__DEV__) { if (__DEV__) {

View File

@ -84,12 +84,13 @@ var Picker = React.createClass({
enabled: React.PropTypes.bool, enabled: React.PropTypes.bool,
/** /**
* On Android, specifies how to display the selection items when the user taps on the picker: * On Android, specifies how to display the selection items when the user taps on the picker:
*
* - 'dialog': Show a modal dialog. This is the default. * - 'dialog': Show a modal dialog. This is the default.
* - 'dropdown': Shows a dropdown anchored to the picker view * - 'dropdown': Shows a dropdown anchored to the picker view
* *
* @platform android * @platform android
*/ */
mode: React.PropTypes.oneOf([MODE_DIALOG, MODE_DROPDOWN]), mode: React.PropTypes.oneOf(['dialog', 'dropdown']),
/** /**
* Style to apply to each of the item labels. * Style to apply to each of the item labels.
* @platform ios * @platform ios

View File

@ -199,6 +199,7 @@ var components = [
'../Libraries/CustomComponents/Navigator/Navigator.js', '../Libraries/CustomComponents/Navigator/Navigator.js',
'../Libraries/Components/Navigation/NavigatorIOS.ios.js', '../Libraries/Components/Navigation/NavigatorIOS.ios.js',
'../Libraries/Picker/PickerIOS.ios.js', '../Libraries/Picker/PickerIOS.ios.js',
'../Libraries/Components/Picker/Picker.js',
'../Libraries/Components/ProgressBarAndroid/ProgressBarAndroid.android.js', '../Libraries/Components/ProgressBarAndroid/ProgressBarAndroid.android.js',
'../Libraries/Components/ProgressViewIOS/ProgressViewIOS.ios.js', '../Libraries/Components/ProgressViewIOS/ProgressViewIOS.ios.js',
'../Libraries/PullToRefresh/PullToRefreshViewAndroid.android.js', '../Libraries/PullToRefresh/PullToRefreshViewAndroid.android.js',