Skip to content

Commit 5f3f000

Browse files
JoelMarceyMorgan Pretty
authored andcommitted
Fix nits in update View API documentation
Summary: Ref comments in facebook#8341 Ref facebook#8203 Closes facebook#8361 Differential Revision: D3477174 Pulled By: caabernathy fbshipit-source-id: 495011c2d370d06d355e966d6ba2c52880146183
1 parent 5381bc4 commit 5f3f000

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Libraries/Components/View/View.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
*
99
* @providesModule View
1010
* @flow
11-
* @jsdoc
1211
*/
1312
'use strict';
1413

@@ -134,15 +133,15 @@ const View = React.createClass({
134133

135134
propTypes: {
136135
/**
137-
* When true, indicates that the view is an accessibility element. By default,
136+
* When `true`, indicates that the view is an accessibility element. By default,
138137
* all the touchable elements are accessible.
139138
*/
140139
accessible: PropTypes.bool,
141140

142141
/**
143142
* Overrides the text that's read by the screen reader when the user interacts
144143
* with the element. By default, the label is constructed by traversing all the
145-
* children and accumulating all the Text nodes separated by space.
144+
* children and accumulating all the `Text` nodes separated by space.
146145
*/
147146
accessibilityLabel: PropTypes.string,
148147

@@ -250,14 +249,15 @@ const View = React.createClass({
250249
onAccessibilityTap: PropTypes.func,
251250

252251
/**
253-
* When `accessible` is true, the system will invoke this function when the
252+
* When `accessible` is `true`, the system will invoke this function when the
254253
* user performs the magic tap gesture.
255254
*/
256255
onMagicTap: PropTypes.func,
257256

258257
/**
259-
* Used to locate this view in end-to-end tests. NB: disables the 'layout-only
260-
* view removal' optimization for this view!
258+
* Used to locate this view in end-to-end tests.
259+
*
260+
* > This disables the 'layout-only view removal' optimization for this view!
261261
*/
262262
testID: PropTypes.string,
263263

@@ -285,7 +285,7 @@ const View = React.createClass({
285285
onResponderMove: PropTypes.func,
286286

287287
/**
288-
* Another responser is already active and will not release it to that `View` asking to be
288+
* Another responder is already active and will not release it to that `View` asking to be
289289
* the responder.
290290
*
291291
* `View.props.onResponderReject: (event) => {}`, where `event` is a synthetic touch event as
@@ -296,7 +296,7 @@ const View = React.createClass({
296296
/**
297297
* Fired at the end of the touch.
298298
*
299-
* `View.props.onResponderRelease`: (event) => {}`, where `event` is a synthetic touch event as
299+
* `View.props.onResponderRelease: (event) => {}`, where `event` is a synthetic touch event as
300300
* described above.
301301
*/
302302
onResponderRelease: PropTypes.func,
@@ -381,7 +381,7 @@ const View = React.createClass({
381381
onLayout: PropTypes.func,
382382

383383
/**
384-
* Controls whether the View can be the target of touch events.
384+
* Controls whether the `View` can be the target of touch events.
385385
*
386386
* - `'auto'`: The View can be the target of touch events.
387387
* - `'none'`: The View is never the target of touch events.
@@ -426,7 +426,7 @@ const View = React.createClass({
426426
* for scrolling content when there are many subviews, most of which are
427427
* offscreen. For this property to be effective, it must be applied to a
428428
* view that contains many subviews that extend outside its bound. The
429-
* subviews must also have overflow: hidden, as should the containing view
429+
* subviews must also have `overflow: hidden`, as should the containing view
430430
* (or one of its superviews).
431431
*/
432432
removeClippedSubviews: PropTypes.bool,

0 commit comments

Comments
 (0)