From 1012445ef5cb5cd50e84e8d89910efa9d45c042d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateo=20Guzm=C3=A1n?= Date: Tue, 1 Apr 2025 12:19:01 -0700 Subject: [PATCH] Fix unresolved KDoc references (#50403) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Summary: Static code analysis detected some unresolved KDoc references. In this PR, I’m addressing a few of them. ## Changelog: [INTERNAL] - Fix some unresolved KDoc references Pull Request resolved: https://github.com/facebook/react-native/pull/50403 Test Plan: ```sh yarn test-android yarn android ``` Reviewed By: cortinico Differential Revision: D72234349 Pulled By: javache fbshipit-source-id: 0877992cce5d76124b83c5261ec680683caadc9c --- .../main/java/com/facebook/react/bridge/CatalystInstance.kt | 4 ++-- .../com/facebook/react/bridge/LifecycleEventListener.kt | 2 ++ .../src/main/java/com/facebook/react/bridge/UIManager.kt | 3 ++- .../main/java/com/facebook/react/common/SurfaceDelegate.kt | 2 ++ .../com/facebook/react/common/build/ReactBuildConfig.kt | 2 +- .../react/devsupport/interfaces/DevSupportManager.kt | 4 ++-- .../java/com/facebook/react/jstasks/HeadlessJsTaskConfig.kt | 6 +----- .../facebook/react/jstasks/HeadlessJsTaskEventListener.kt | 5 +++-- .../facebook/react/modules/core/PermissionAwareActivity.kt | 2 ++ .../facebook/react/touch/OnInterceptTouchEventListener.kt | 4 ++-- .../java/com/facebook/react/uimanager/BlendModeHelper.kt | 2 +- .../src/main/java/com/facebook/react/uimanager/PixelUtil.kt | 2 +- .../com/facebook/react/uimanager/ReactClippingViewGroup.kt | 4 ++-- .../com/facebook/react/uimanager/drawable/BorderDrawable.kt | 2 +- .../react/views/swiperefresh/ReactSwipeRefreshLayout.kt | 1 + .../react/views/text/internal/span/ReactClickableSpan.kt | 1 + 16 files changed, 26 insertions(+), 20 deletions(-) diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/CatalystInstance.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/CatalystInstance.kt index e5a8146b7de..3809a0c7f81 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/CatalystInstance.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/CatalystInstance.kt @@ -93,14 +93,14 @@ public interface CatalystInstance : MemoryPressureListener, JSInstance, JSBundle @VisibleForTesting public fun setGlobalVariable(propName: String, jsonValue: String) /** - * Do not use this anymore. Use [getRuntimeExecutor] instead. Get the C pointer (as a long) to the + * Do not use this anymore. Use [runtimeExecutor] instead. Get the C pointer (as a long) to the * JavaScriptCore context associated with this instance. * *

Use the following pattern to ensure that the JS context is not cleared while you are using * it: JavaScriptContextHolder jsContext = reactContext.getJavaScriptContextHolder() * synchronized(jsContext) { nativeThingNeedingJsContext(jsContext.get()); } */ - @get:Deprecated("Use getRuntimeExecutor() instead.") + @get:Deprecated("Use runtimeExecutor instead.") public val javaScriptContextHolder: JavaScriptContextHolder public val runtimeExecutor: RuntimeExecutor? diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/LifecycleEventListener.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/LifecycleEventListener.kt index 414b61a5652..304b189a2cb 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/LifecycleEventListener.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/LifecycleEventListener.kt @@ -7,6 +7,8 @@ package com.facebook.react.bridge +import android.app.Activity + /** * Listener for receiving activity lifecycle events. * diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/UIManager.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/UIManager.kt index c0729f86de9..f7d2d4d6557 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/UIManager.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/UIManager.kt @@ -124,7 +124,8 @@ public interface UIManager : PerformanceCounter { * * @param reactTag tag * @return view if found - * @throws IllegalViewOperationException if tag could not be resolved. + * @throws [com.facebook.react.uimanager.IllegalViewOperationException] if tag could not be + * resolved. */ public fun resolveView(reactTag: Int): View? diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/SurfaceDelegate.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/SurfaceDelegate.kt index 16fe6d6b373..e8d380e55ab 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/SurfaceDelegate.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/SurfaceDelegate.kt @@ -7,6 +7,8 @@ package com.facebook.react.common +import android.view.View + /** * Interface for handling a surface in React Native. In mobile platform a surface can be any * container that holds some [View]. For example, a Dialog can be a surface to wrap content view diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/build/ReactBuildConfig.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/build/ReactBuildConfig.kt index 29a829acbff..4460e57f77a 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/build/ReactBuildConfig.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/build/ReactBuildConfig.kt @@ -23,7 +23,7 @@ public object ReactBuildConfig { @JvmField public val IS_INTERNAL_BUILD: Boolean = BuildConfig.IS_INTERNAL_BUILD /** - * [true] if Perfetto was enabled on this build (`WITH_PERFETTO=1`), indicating it is a profiling + * `true` if Perfetto was enabled on this build (`WITH_PERFETTO=1`), indicating it is a profiling * build. */ @JvmField public val ENABLE_PERFETTO: Boolean = BuildConfig.ENABLE_PERFETTO diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/devsupport/interfaces/DevSupportManager.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/devsupport/interfaces/DevSupportManager.kt index 40351ddaaa4..b9e77d596a3 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/devsupport/interfaces/DevSupportManager.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/devsupport/interfaces/DevSupportManager.kt @@ -19,8 +19,8 @@ import java.io.File /** * Interface for accessing and interacting with development features. In dev mode, use the - * implementation [BridgeDevSupportManager]. In production mode, use the dummy implementation - * [ReleaseDevSupportManager]. + * implementation [com.facebook.react.devsupport.BridgeDevSupportManager]. In production mode, use + * the dummy implementation [com.facebook.react.devsupport.ReleaseDevSupportManager]. */ public interface DevSupportManager : JSExceptionHandler { diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskConfig.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskConfig.kt index 7b10570dd1c..f1cfbd9dd21 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskConfig.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskConfig.kt @@ -20,11 +20,7 @@ import com.facebook.react.bridge.WritableMap * accidentally keeping the device awake for long periods of time because JS crashed or some * request timed out. A value of 0 means no timeout (should only be used for long-running tasks * such as music playback). - * @property allowedInForeground whether to allow this task to run while the app is in the - * foreground (i.e. there is a host in resumed mode for the current ReactContext). Only set this - * to true if you really need it. Note that tasks run in the same JS thread as UI code, so doing - * expensive operations would degrade user experience. - * @property allowedInForeground whether to allow this task to run while the app is in the + * @property isAllowedInForeground whether to allow this task to run while the app is in the * foreground (i.e. there is a host in resumed mode for the current ReactContext). Only set this * to true if you really need it. Note that tasks run in the same JS thread as UI code, so doing * expensive operations would degrade user experience. diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskEventListener.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskEventListener.kt index ae0ab4cbc15..b645f29cd92 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskEventListener.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskEventListener.kt @@ -18,8 +18,9 @@ public interface HeadlessJsTaskEventListener { public fun onHeadlessJsTaskStart(taskId: Int) /** - * Called when a JS task finishes (i.e. when [HeadlessJsTaskSupportModule.notifyTaskFinished] is - * called, or when it times out), on the UI thread. + * Called when a JS task finishes (i.e. when + * [om.facebook.react.modules.core.HeadlessJsTaskSupportModule.notifyTaskFinished] is called, or + * when it times out), on the UI thread. */ public fun onHeadlessJsTaskFinish(taskId: Int) } diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/core/PermissionAwareActivity.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/core/PermissionAwareActivity.kt index f4089724d54..608084b8681 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/core/PermissionAwareActivity.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/core/PermissionAwareActivity.kt @@ -7,6 +7,8 @@ package com.facebook.react.modules.core +import android.app.Activity + /** * Interface used to denote activities that can forward permission requests and call * [PermissionListener] with the permission request results. diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/touch/OnInterceptTouchEventListener.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/touch/OnInterceptTouchEventListener.kt index 539b0f9ef73..77df4d2ce4b 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/touch/OnInterceptTouchEventListener.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/touch/OnInterceptTouchEventListener.kt @@ -17,9 +17,9 @@ import android.view.ViewGroup public fun interface OnInterceptTouchEventListener { /** - * Called when a onInterceptTouch is invoked on a view group + * Called when a onInterceptTouch is invoked on a view group. * - * @param v The view group the onInterceptTouch has been called on + * @param view The view group the onInterceptTouch has been called on. * @param event The motion event being dispatched down the hierarchy. * @return Return true to steal motion event from the children and have the dispatched to this * view, or return false to allow motion event to be delivered to children view diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/BlendModeHelper.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/BlendModeHelper.kt index 1dd376372e7..70bd8f19acf 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/BlendModeHelper.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/BlendModeHelper.kt @@ -17,7 +17,7 @@ import com.facebook.react.R @TargetApi(29) internal object BlendModeHelper { - /** @see https://www.w3.org/TR/compositing-1/#mix-blend-mode */ + /** @see mix-blend-mode */ @JvmStatic fun parseMixBlendMode(mixBlendMode: String?): BlendMode? { if (mixBlendMode == null || Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) { diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/PixelUtil.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/PixelUtil.kt index 0a65d6e9f1b..f7ad6ca5b35 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/PixelUtil.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/PixelUtil.kt @@ -63,7 +63,7 @@ public object PixelUtil { return value / DisplayMetricsHolder.getWindowDisplayMetrics().density } - /** @return [float] that represents the density of the display metrics for device screen. */ + /** @return [Float] that represents the density of the display metrics for device screen. */ @JvmStatic public fun getDisplayMetricDensity(): Float = DisplayMetricsHolder.getWindowDisplayMetrics().density diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/ReactClippingViewGroup.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/ReactClippingViewGroup.kt index 91ee8946b1d..77e100b11e2 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/ReactClippingViewGroup.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/ReactClippingViewGroup.kt @@ -24,10 +24,10 @@ public interface ReactClippingViewGroup { /** * Notify view that clipping area may have changed and it should recalculate the list of children * that should be attached/detached. This method should be called only when property - * `removeClippedSubviews` is set to `true` on a view. + * [removeClippedSubviews] is set to `true` on a view. * * CAUTION: Views are responsible for calling [updateClippingRect] on it's children. This should - * happen if child implement [ReactClippingViewGroup], return true from [getRemoveClippedSubviews] + * happen if child implement [ReactClippingViewGroup], return true from [removeClippedSubviews] * and clipping rect change of the current view may affect clipping rect of this child. */ public fun updateClippingRect() diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/drawable/BorderDrawable.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/drawable/BorderDrawable.kt index f6f6edf4ac5..d0bc783284b 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/drawable/BorderDrawable.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/drawable/BorderDrawable.kt @@ -1053,7 +1053,7 @@ internal class BorderDrawable( * Multiplies the color with the given alpha. * * @param color color to be multiplied - * @param alpha value between 0 and 255 + * @param rawAlpha value between 0 and 255 * @return multiplied color */ private fun multiplyColorAlpha(color: Int, rawAlpha: Int): Int { diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/swiperefresh/ReactSwipeRefreshLayout.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/swiperefresh/ReactSwipeRefreshLayout.kt index e3201890f4c..c9b95799686 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/swiperefresh/ReactSwipeRefreshLayout.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/swiperefresh/ReactSwipeRefreshLayout.kt @@ -9,6 +9,7 @@ package com.facebook.react.views.swiperefresh import android.view.MotionEvent import android.view.ViewConfiguration +import android.view.ViewGroup import androidx.swiperefreshlayout.widget.SwipeRefreshLayout import com.facebook.react.bridge.ReactContext import com.facebook.react.uimanager.PixelUtil diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/text/internal/span/ReactClickableSpan.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/text/internal/span/ReactClickableSpan.kt index b3c43a04a89..f55cd505350 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/text/internal/span/ReactClickableSpan.kt +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/text/internal/span/ReactClickableSpan.kt @@ -14,6 +14,7 @@ import android.view.View import com.facebook.react.bridge.ReactContext import com.facebook.react.uimanager.UIManagerHelper import com.facebook.react.views.text.ReactTextView +import com.facebook.react.views.text.TextLayoutManager import com.facebook.react.views.view.ViewGroupClickEvent /**