Skip to content

Commit 8e653ac

Browse files
authored
chore(doc): Add custom platform annotation in jsdoc (#5317)
1 parent aa28c7f commit 8e653ac

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

packages/core/src/js/options.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,22 @@ export interface BaseReactNativeOptions {
5252
/** Enable NDK on Android
5353
*
5454
* @default true
55+
* @platform android
5556
*/
5657
enableNdk?: boolean;
5758

5859
/** Enable scope sync from Java to NDK on Android
5960
* Only has an effect if `enableNdk` is `true`.
61+
*
62+
* @platform android
6063
*/
6164
enableNdkScopeSync?: boolean;
6265

63-
/** When enabled, all the threads are automatically attached to all logged events on Android */
66+
/**
67+
* When enabled, all the threads are automatically attached to all logged events on Android
68+
*
69+
* @platform android
70+
*/
6471
attachThreads?: boolean;
6572

6673
/**
@@ -89,6 +96,7 @@ export interface BaseReactNativeOptions {
8996
* Renamed from `enableOutOfMemoryTracking` in v5.
9097
*
9198
* @default true
99+
* @platform ios
92100
*/
93101
enableWatchdogTerminationTracking?: boolean;
94102

@@ -123,6 +131,7 @@ export interface BaseReactNativeOptions {
123131
* iOS only
124132
*
125133
* @default true
134+
* @platform ios
126135
*/
127136
enableAppHangTracking?: boolean;
128137

@@ -135,6 +144,7 @@ export interface BaseReactNativeOptions {
135144
* iOS only
136145
*
137146
* @default 2
147+
* @platform ios
138148
*/
139149
appHangTimeoutInterval?: number;
140150

@@ -280,6 +290,7 @@ export interface BaseReactNativeOptions {
280290
* - Note: The mechanism of hooking into `__cxa_throw` could cause issues with symbolication on iOS due to caching of symbol references.
281291
*
282292
* @default false
293+
* @platform ios
283294
*/
284295
enableUnhandledCPPExceptionsV2?: boolean;
285296
};

packages/core/src/js/replay/mobilereplay.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface MobileReplayOptions {
4848
* - Experiment: This is an experimental feature and is therefore disabled by default.
4949
*
5050
* @deprecated Use `enableViewRendererV2` instead.
51+
* @platform ios
5152
*/
5253
enableExperimentalViewRenderer?: boolean;
5354

@@ -62,6 +63,7 @@ export interface MobileReplayOptions {
6263
* Eventually, we will remove this feature flag and use the new view renderer by default.
6364
*
6465
* @default true
66+
* @platform ios
6567
*/
6668
enableViewRendererV2?: boolean;
6769

@@ -75,6 +77,7 @@ export interface MobileReplayOptions {
7577
* - Experiment: This is an experimental feature and is therefore disabled by default.
7678
*
7779
* @default false
80+
* @platform ios
7881
*/
7982
enableFastViewRendering?: boolean;
8083

0 commit comments

Comments
 (0)