Skip to content

Commit 2410627

Browse files
committed
Screen: Further small style changes to jsdoc.
In particular, extract a one-line summary.
1 parent 83d420c commit 2410627

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/common/Screen.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,17 @@ type Props = {|
5353
|};
5454

5555
/**
56-
* A component representing a distinct screen of the app
57-
* ensuring consistent look-and-feel throughout.
58-
* It can control the status bar, can render a nav bar or
59-
* include a search input, center its contents, etc.
56+
* Wrapper component for each screen of the app, for consistent look-and-feel.
57+
*
58+
* Provides a nav bar, colors the status bar, can center the contents, etc.
59+
* The `children` are ultimately wrapped in a `ScrollView` from upstream.
6060
*
6161
* @prop [centerContent] - Should the contents be centered.
6262
* @prop children - Components to render inside the screen.
6363
* @prop [keyboardShouldPersistTaps] - Passed through to ScrollView.
6464
* @prop [padding] - Should padding be added to the contents of the screen.
6565
* @prop [scrollEnabled] - Passed through to ScrollView.
66-
* @prop [style] - Additional style for the wrapper container.
66+
* @prop [style] - Additional style for the ScrollView.
6767
*
6868
* @prop [search] - If 'true' show a search box in place of the title.
6969
* @prop [autoFocus] - If search bar enabled, should it be focused initially.

0 commit comments

Comments
 (0)