Skip to content

Commit 366eee4

Browse files
mfazekasmfazekas
authored
doc: fix doc generation for complex types (#2782)
1 parent 463d8e6 commit 366eee4

37 files changed

+3039
-385
lines changed

‎docs/Annotation.md

+95-11
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,101 @@ Annotation
88

99

1010
## props
11-
| Prop | Type | Default | Required | Description |
12-
| ---- | :-- | :----- | :------ | :---------- |
13-
| id | `string` | `none` | `true` | FIX ME NO DESCRIPTION |
14-
| animated | `boolean` | `false` | `false` | FIX ME NO DESCRIPTION |
15-
| animationDuration | `number` | `1000` | `false` | FIX ME NO DESCRIPTION |
16-
| animationEasingFunction | `func` | `Easing.linear` | `false` | FIX ME NO DESCRIPTION<br/>*signature:*`(x:number) => number` |
17-
| coordinates | `Array` | `none` | `true` | FIX ME NO DESCRIPTION |
18-
| onPress | `func` | `none` | `false` | FIX ME NO DESCRIPTION<br/>*signature:*`(event:OnPressEvent) => void` |
19-
| children | `ReactElement \| ReactElement[]` | `none` | `true` | FIX ME NO DESCRIPTION |
20-
| style | `object` | `none` | `false` | FIX ME NO DESCRIPTION |
21-
| icon | `string \| number \| object` | `none` | `false` | FIX ME NO DESCRIPTION |
11+
12+
13+
### id
14+
15+
```tsx
16+
string
17+
```
18+
_required_
19+
FIX ME NO DESCRIPTION
20+
21+
22+
23+
### animated
24+
25+
```tsx
26+
boolean
27+
```
28+
FIX ME NO DESCRIPTION
29+
30+
_defaults to:_ `false`
31+
32+
33+
### animationDuration
34+
35+
```tsx
36+
number
37+
```
38+
FIX ME NO DESCRIPTION
39+
40+
_defaults to:_ `1000`
41+
42+
43+
### animationEasingFunction
44+
45+
```tsx
46+
func
47+
```
48+
FIX ME NO DESCRIPTION
49+
*signature:*`(x:number) => number`
50+
51+
_defaults to:_ `Easing.linear`
52+
53+
54+
### coordinates
55+
56+
```tsx
57+
Array
58+
```
59+
_required_
60+
FIX ME NO DESCRIPTION
61+
62+
63+
64+
### onPress
65+
66+
```tsx
67+
func
68+
```
69+
FIX ME NO DESCRIPTION
70+
*signature:*`(event:OnPressEvent) => void`
71+
72+
73+
74+
### children
75+
76+
```tsx
77+
ReactElement | ReactElement[]
78+
```
79+
_required_
80+
FIX ME NO DESCRIPTION
81+
82+
83+
84+
### style
85+
86+
```tsx
87+
object
88+
```
89+
FIX ME NO DESCRIPTION
90+
91+
92+
93+
### icon
94+
95+
```tsx
96+
string | number | object
97+
```
98+
FIX ME NO DESCRIPTION
99+
100+
101+
102+
103+
104+
105+
22106

23107
## methods
24108
### onPress(event)

‎docs/Atmosphere.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,22 @@ Atmosphere
88

99

1010
## props
11-
| Prop | Type | Default | Required | Description |
12-
| ---- | :-- | :----- | :------ | :---------- |
13-
| style | `AtmosphereLayerStyleProps` | `none` | `true` | FIX ME NO DESCRIPTION |
11+
12+
13+
### style
14+
15+
```tsx
16+
AtmosphereLayerStyleProps
17+
```
18+
_required_
19+
FIX ME NO DESCRIPTION
20+
21+
22+
23+
24+
25+
26+
1427

1528

1629
## styles

‎docs/BackgroundLayer.md

+109-13
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,115 @@ BackgroundLayer
88

99

1010
## props
11-
| Prop | Type | Default | Required | Description |
12-
| ---- | :-- | :----- | :------ | :---------- |
13-
| id | `string` | `none` | `true` | A string that uniquely identifies the layer in the style to which it is added. |
14-
| existing | `boolean` | `none` | `false` | The id refers to en existing layer in the style. Does not create a new layer. |
15-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
16-
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
17-
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
18-
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |
19-
| layerIndex | `number` | `none` | `false` | Inserts a layer at a specified index |
20-
| filter | `FilterExpression` | `none` | `false` | Filter only the features in the source layer that satisfy a condition that you define |
21-
| minZoomLevel | `number` | `none` | `false` | The minimum zoom level at which the layer gets parsed and appears. |
22-
| maxZoomLevel | `number` | `none` | `false` | The maximum zoom level at which the layer gets parsed and appears. |
23-
| style | `BackgroundLayerStyleProps` | `none` | `false` | Customizable style attributes |
11+
12+
13+
### id
14+
15+
```tsx
16+
string
17+
```
18+
_required_
19+
A string that uniquely identifies the layer in the style to which it is added.
20+
21+
22+
23+
### existing
24+
25+
```tsx
26+
boolean
27+
```
28+
The id refers to en existing layer in the style. Does not create a new layer.
29+
30+
31+
32+
### sourceID
33+
34+
```tsx
35+
string
36+
```
37+
The source from which to obtain the data to style.
38+
If the source has not yet been added to the current style, the behavior is undefined.
39+
Inferred from parent source only if the layer is a direct child to it.
40+
41+
_defaults to:_ `MapboxGL.StyleSource.DefaultSourceID`
42+
43+
44+
### sourceLayerID
45+
46+
```tsx
47+
string
48+
```
49+
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
50+
51+
52+
53+
### aboveLayerID
54+
55+
```tsx
56+
string
57+
```
58+
Inserts a layer above aboveLayerID.
59+
60+
61+
62+
### belowLayerID
63+
64+
```tsx
65+
string
66+
```
67+
Inserts a layer below belowLayerID
68+
69+
70+
71+
### layerIndex
72+
73+
```tsx
74+
number
75+
```
76+
Inserts a layer at a specified index
77+
78+
79+
80+
### filter
81+
82+
```tsx
83+
FilterExpression
84+
```
85+
Filter only the features in the source layer that satisfy a condition that you define
86+
87+
88+
89+
### minZoomLevel
90+
91+
```tsx
92+
number
93+
```
94+
The minimum zoom level at which the layer gets parsed and appears.
95+
96+
97+
98+
### maxZoomLevel
99+
100+
```tsx
101+
number
102+
```
103+
The maximum zoom level at which the layer gets parsed and appears.
104+
105+
106+
107+
### style
108+
109+
```tsx
110+
BackgroundLayerStyleProps
111+
```
112+
Customizable style attributes
113+
114+
115+
116+
117+
118+
119+
24120

25121

26122
## styles

‎docs/Callout.md

+61-8
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,66 @@ Callout
88
Callout that displays information about a selected annotation near the annotation.
99

1010
## props
11-
| Prop | Type | Default | Required | Description |
12-
| ---- | :-- | :----- | :------ | :---------- |
13-
| title | `string` | `none` | `true` | String that gets displayed in the default callout. |
14-
| style | `ViewStyle` | `none` | `false` | Style property for the Animated.View wrapper, apply animations to this |
15-
| containerStyle | `ViewStyle` | `none` | `false` | Style property for the native RCTMGLCallout container, set at your own risk. |
16-
| contentStyle | `ViewStyle` | `none` | `false` | Style property for the content bubble. |
17-
| tipStyle | `ViewStyle` | `none` | `false` | Style property for the triangle tip under the content. |
18-
| textStyle | `ViewStyle` | `none` | `false` | Style property for the title in the content bubble. |
11+
12+
13+
### title
14+
15+
```tsx
16+
string
17+
```
18+
_required_
19+
String that gets displayed in the default callout.
20+
21+
22+
23+
### style
24+
25+
```tsx
26+
ViewStyle
27+
```
28+
Style property for the Animated.View wrapper, apply animations to this
29+
30+
31+
32+
### containerStyle
33+
34+
```tsx
35+
ViewStyle
36+
```
37+
Style property for the native RCTMGLCallout container, set at your own risk.
38+
39+
40+
41+
### contentStyle
42+
43+
```tsx
44+
ViewStyle
45+
```
46+
Style property for the content bubble.
47+
48+
49+
50+
### tipStyle
51+
52+
```tsx
53+
ViewStyle
54+
```
55+
Style property for the triangle tip under the content.
56+
57+
58+
59+
### textStyle
60+
61+
```tsx
62+
ViewStyle
63+
```
64+
Style property for the title in the content bubble.
65+
66+
67+
68+
69+
70+
71+
1972

2073

0 commit comments

Comments
 (0)