Skip to content

Commit 7a0baf9

Browse files
raghav710Rachel Nabors
authored andcommitted
Fix parameter formatting in dimensions doc (facebook#1447)
1 parent b33edd4 commit 7a0baf9

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/dimensions.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@ Initial dimensions are set before `runApplication` is called so they should be a
3131
3232
Example: `var {height, width} = Dimensions.get('window');`
3333

34-
@param {string} dim Name of dimension as defined when calling `set`. @returns {Object?} Value for the dimension.
34+
**Parameters:**
35+
36+
| Name | Type | Required | Description |
37+
| ------ | ------ | -------- | ----------------------------------------------------------------------------------------------|
38+
| dim | string | Yes | Name of dimension as defined when calling `set`. @returns {Object?} Value for the dimension. |
3539

3640
> For Android the `window` dimension will exclude the size used by the `status bar` (if not translucent) and `bottom navigation bar`
3741
@@ -55,4 +59,8 @@ static set(dims)
5559

5660
This should only be called from native code by sending the didUpdateDimensions event.
5761

58-
@param {object} dims string-keyed object of dimensions to set
62+
**Parameters:**
63+
64+
| Name | Type | Required | Description |
65+
| ------ | ------ | -------- | ------------------------------------------|
66+
| dims | object | Yes | string-keyed object of dimensions to set |

0 commit comments

Comments
 (0)