Skip to content

Add KDoc documentation to GuardedFrameCallback #55022

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

Closed
mdvacca wants to merge 1 commit into from
Closed

Add KDoc documentation to GuardedFrameCallback #55022

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
17 changes: 17 additions & 0 deletions ...ct-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/GuardedFrameCallback.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,29 @@ import com.facebook.react.bridge.ReactContext
/**
* Abstract base for a Choreographer FrameCallback that should have any RuntimeExceptions it throws
* handled by the [JSExceptionHandler] registered if the app is in dev mode.
*
* @property exceptionHandler The handler for RuntimeExceptions thrown during frame callbacks.
* @constructor Creates a GuardedFrameCallback with the specified exception handler.
*/
public abstract class GuardedFrameCallback
protected constructor(private val exceptionHandler: JSExceptionHandler) :
Choreographer.FrameCallback {
/**
* Creates a GuardedFrameCallback using the exception handler from the provided ReactContext.
*
* @param reactContext The React context whose exception handler will be used.
*/
protected constructor(reactContext: ReactContext) : this(reactContext.exceptionHandler)

/**
* Choreographer frame callback implementation that guards [doFrameGuarded] with exception
* handling.
*
* Wraps calls to [doFrameGuarded] in a try-catch block. Any RuntimeExceptions thrown are caught
* and passed to the exception handler instead of crashing the app.
*
* @param frameTimeNanos The time in nanoseconds when the frame started being rendered.
*/
public override fun doFrame(frameTimeNanos: Long) {
try {
doFrameGuarded(frameTimeNanos)
Expand Down
Loading