Skip to content

chore(doc): Add custom platform annotation in jsdoc #5317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antonis merged 1 commit into from
Oct 31, 2025
Merged

chore(doc): Add custom platform annotation in jsdoc #5317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion packages/core/src/js/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,22 @@ export interface BaseReactNativeOptions {
/** Enable NDK on Android
*
* @default true
* @platform android
*/
enableNdk?: boolean;

/** Enable scope sync from Java to NDK on Android
* Only has an effect if `enableNdk` is `true`.
*
* @platform android
*/
enableNdkScopeSync?: boolean;

/** When enabled, all the threads are automatically attached to all logged events on Android */
/**
* When enabled, all the threads are automatically attached to all logged events on Android
*
* @platform android
*/
attachThreads?: boolean;

/**
Expand Down Expand Up @@ -89,6 +96,7 @@ export interface BaseReactNativeOptions {
* Renamed from `enableOutOfMemoryTracking` in v5.
*
* @default true
* @platform ios
*/
enableWatchdogTerminationTracking?: boolean;

Expand Down Expand Up @@ -123,6 +131,7 @@ export interface BaseReactNativeOptions {
* iOS only
*
* @default true
* @platform ios
*/
enableAppHangTracking?: boolean;

Expand All @@ -135,6 +144,7 @@ export interface BaseReactNativeOptions {
* iOS only
*
* @default 2
* @platform ios
*/
appHangTimeoutInterval?: number;

Expand Down Expand Up @@ -280,6 +290,7 @@ export interface BaseReactNativeOptions {
* - Note: The mechanism of hooking into `__cxa_throw` could cause issues with symbolication on iOS due to caching of symbol references.
*
* @default false
* @platform ios
*/
enableUnhandledCPPExceptionsV2?: boolean;
};
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/js/replay/mobilereplay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export interface MobileReplayOptions {
* - Experiment: This is an experimental feature and is therefore disabled by default.
*
* @deprecated Use `enableViewRendererV2` instead.
* @platform ios
*/
enableExperimentalViewRenderer?: boolean;

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

Expand All @@ -75,6 +77,7 @@ export interface MobileReplayOptions {
* - Experiment: This is an experimental feature and is therefore disabled by default.
*
* @default false
* @platform ios
*/
enableFastViewRendering?: boolean;

Expand Down
Loading