Skip to content

Commit f922563

Browse files
mateoguzmanafacebook-github-bot
authored andcommitted
Fix unresolved KDoc references (react#51142)
Summary: Static code analysis shows that there are a lot of unresolved KDoc references. This is just another round addressing several of them. ## Changelog: [INTERNAL] - Fix unresolved KDoc references Pull Request resolved: react#51142 Test Plan: Verify that the comments link the classes correctly using Android Studio. Reviewed By: rshest Differential Revision: D74305933 Pulled By: javache fbshipit-source-id: f512a33fa5da46fb828bb76bd95d9502261ea08a
1 parent e48b496 commit f922563

13 files changed

Lines changed: 45 additions & 36 deletions

File tree

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/ReactNoCrashSoftException.kt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88
package com.facebook.react.bridge
99

1010
/**
11-
* Extends RuntimeException so that it may be caught by a [ReactSoftExceptionListener]. Any
12-
* [ReactSoftExceptionListener] that catches a ReactNoCrashSoftException should log it only and not
13-
* crash, no matter what.
11+
* Extends RuntimeException so that it may be caught by a
12+
* [ReactSoftExceptionLogger.ReactSoftExceptionListener]. Any
13+
* [ReactSoftExceptionLogger.ReactSoftExceptionListener] that catches a ReactNoCrashSoftException
14+
* should log it only and not crash, no matter what.
1415
*/
1516
public open class ReactNoCrashSoftException : RuntimeException {
1617

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/build/ReactBuildConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public object ReactBuildConfig {
3030

3131
@JvmField public val EXOPACKAGE_FLAGS: Int = BuildConfig.EXOPACKAGE_FLAGS
3232

33-
/** [Experimental] Enable React Native DevTools in release builds. */
33+
/** **Experimental** Enable React Native DevTools in release builds. */
3434
@JvmField
3535
public val UNSTABLE_ENABLE_FUSEBOX_RELEASE: Boolean = BuildConfig.UNSTABLE_ENABLE_FUSEBOX_RELEASE
3636

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/devsupport/DoubleTapReloadRecognizer.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ import android.view.View
1414
import android.widget.EditText
1515

1616
/**
17-
* A class allows recognizing double key tap of "R", used to reload JS in [AbstractReactActivity],
18-
* [RedBoxDialogSurfaceDelegate] and [com.facebook.react.ReactActivity].
17+
* A class allows recognizing double key tap of "R", used to reload JS in
18+
* [com.facebook.react.ReactDelegate], [RedBoxDialogSurfaceDelegate] and
19+
* [com.facebook.react.ReactActivity].
1920
*/
2021
public class DoubleTapReloadRecognizer {
2122
private var doRefresh = false

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/debug/DidJSUpdateUiDuringFrameDetector.kt

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ import com.facebook.react.uimanager.debug.NotThreadSafeViewHierarchyUpdateDebugL
1616
/**
1717
* Debug object that listens to bridge busy/idle events and UiManagerModule dispatches and uses it
1818
* to calculate whether JS was able to update the UI during a given frame. After being installed on
19-
* a [ReactBridge] and a [UIManagerModule], [.getDidJSHitFrameAndCleanup] should be called once per
20-
* frame via a [Choreographer.FrameCallback].
19+
* a [ReactBridge] and a [com.facebook.react.uimanager.UIManagerModule],
20+
* [.getDidJSHitFrameAndCleanup] should be called once per frame via a
21+
* [android.view.Choreographer.FrameCallback].
2122
*/
2223
internal class DidJSUpdateUiDuringFrameDetector :
2324
NotThreadSafeBridgeIdleDebugListener, NotThreadSafeViewHierarchyUpdateDebugListener {
@@ -53,10 +54,10 @@ internal class DidJSUpdateUiDuringFrameDetector :
5354
}
5455

5556
/**
56-
* Designed to be called from a [Choreographer.FrameCallback.doFrame] call.
57+
* Designed to be called from a [android.view.Choreographer.FrameCallback.doFrame] call.
5758
*
58-
* There are two 'success' cases that will cause [.getDidJSHitFrameAndCleanup] to return true for
59-
* a given frame:
59+
* There are two 'success' cases that will cause [getDidJSHitFrameAndCleanup] to return true for a
60+
* given frame:
6061
* 1. UIManagerModule finished dispatching a batched UI update on the UI thread during the frame.
6162
* This means that during the next hierarchy traversal, new UI will be drawn if needed (good).
6263
* 1. The bridge ended the frame idle (meaning there were no JS nor native module calls still in
@@ -67,10 +68,10 @@ internal class DidJSUpdateUiDuringFrameDetector :
6768
* NB: This call can only be called once for a given frame time range because it cleans up events
6869
* it recorded for that frame.
6970
*
70-
* NB2: This makes the assumption that onViewHierarchyUpdateEnqueued is called from the
71-
* [ ][UIManagerModule.onBatchComplete], e.g. while the bridge is still considered busy, which
72-
* means there is no race condition where the bridge has gone idle but a hierarchy update is
73-
* waiting to be enqueued.
71+
* NB2: This makes the assumption that [onViewHierarchyUpdateEnqueued] is called from the
72+
* [com.facebook.react.uimanager.UIManagerModule.onBatchComplete], e.g. while the bridge is still
73+
* considered busy, which means there is no race condition where the bridge has gone idle but a
74+
* hierarchy update is waiting to be enqueued.
7475
*
7576
* @param frameStartTimeNanos the time in nanos that the last frame started
7677
* @param frameEndTimeNanos the time in nanos that the last frame ended

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/modules/fresco/FrescoModule.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,8 @@ constructor(
145145
* Get the default Fresco configuration builder. Allows adding of configuration options in
146146
* addition to the default values.
147147
*
148-
* @return [ImagePipelineConfig.Builder] that has been initialized with default values
148+
* @return [com.facebook.imagepipeline.core.ImagePipelineConfig.Builder] that has been
149+
* initialized with default values
149150
*/
150151
@JvmStatic
151152
public fun getDefaultConfigBuilder(context: ReactContext): ImagePipelineConfig.Builder {

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/runtime/ReactInstance.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ import kotlin.collections.Collection
7979
import kotlin.jvm.JvmStatic
8080

8181
/**
82-
* A replacement for [com.facebook.react.CatalystInstance] responsible for creating and managing a
83-
* React Native instance
82+
* A replacement for [com.facebook.react.bridge.CatalystInstance] responsible for creating and
83+
* managing a React Native instance
8484
*/
8585
@ThreadSafe
8686
@DoNotStrip

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/ReactClippingViewGroupHelper.kt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import javax.annotation.concurrent.NotThreadSafe
1313

1414
/**
1515
* Provides implementation of common tasks for view and it's view manager supporting property
16-
* [removeClippedSubviews].
16+
* [com.facebook.react.uimanager.ReactClippingViewGroup.removeClippedSubviews].
1717
*/
1818
@NotThreadSafe
1919
public object ReactClippingViewGroupHelper {
@@ -23,9 +23,10 @@ public object ReactClippingViewGroupHelper {
2323
private val helperRect: Rect = Rect()
2424

2525
/**
26-
* Can be used by view that support [removeClippedSubviews] property to calculate area that given
27-
* [view] should be clipped to based on the clipping rectangle of it's parent in case when parent
28-
* is also set to clip it's children.
26+
* Can be used by view that support
27+
* [com.facebook.react.uimanager.ReactClippingViewGroup.removeClippedSubviews] property to
28+
* calculate area that given [view] should be clipped to based on the clipping rectangle of it's
29+
* parent in case when parent is also set to clip it's children.
2930
*
3031
* @param view view that we want to calculate clipping rect for
3132
* @param outputRect where the calculated rectangle will be written

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/ReactStylesDiffMap.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ import com.facebook.react.bridge.ReadableMap
1616
* accessor methods of [ReadableMap] by adding a default value property such that caller is enforced
1717
* to provide a default value for a style property.
1818
*
19-
* Instances of this class are used to update [View] or [CSSNode] style properties. Since properties
20-
* are generated by React framework based on what has been updated each value in this map should
21-
* either be interpreted as a new value set for a style property or as a "reset this property to
22-
* default" command in case when value is null (this is a way React communicates change in which the
23-
* style key that was previously present in a map has been removed).
19+
* Instances of this class are used to update [android.view.View] or [CSSNode] style properties.
20+
* Since properties are generated by React framework based on what has been updated each value in
21+
* this map should either be interpreted as a new value set for a style property or as a "reset this
22+
* property to default" command in case when value is null (this is a way React communicates change
23+
* in which the style key that was previously present in a map has been removed).
2424
*
2525
* NOTE: Accessor method with default value will throw an exception when the key is not present in
2626
* the map. Style applicator logic should verify whether the key exists in the map using [.hasKey]

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/annotations/ReactProp.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ package com.facebook.react.uimanager.annotations
2828
* value that is going to be used: [defaultBoolean], [defaultDouble], etc.)
2929
*
3030
* Since in case of property removal for non-primitive value type setter will be called with value
31-
* set to `null` it's required that value type is annotated with [Nullable].
31+
* set to `null` it's required that value type is annotated with [androidx.annotation.Nullable].
3232
*
3333
* Note: Since boolean property type can be represented both as primitive and wrapped default value
3434
* set through [defaultBoolean] is only respected for primitive type and for the wrapped type `null`

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/events/Event.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ import com.facebook.react.common.SystemClock.uptimeMillis
2424
* future and it is highly recommended to use only `getEventData`.
2525
*
2626
* Old, pre-Fabric Events only used viewTag as the identifier, but Fabric needs surfaceId as well as
27-
* viewTag. You may use [UIManagerHelper.getSurfaceId] on a Fabric-managed View to get the
28-
* surfaceId. Fabric will work without surfaceId - making [Event] backwards-compatible - but Events
29-
* without SurfaceId are slightly slower to propagate.
27+
* viewTag. You may use [com.facebook.react.uimanager.UIManagerHelper.getSurfaceId] on a
28+
* Fabric-managed View to get the surfaceId. Fabric will work without surfaceId - making [Event]
29+
* backwards-compatible - but Events without SurfaceId are slightly slower to propagate.
3030
*/
3131
public abstract class Event<T : Event<T>> {
3232
public var isInitialized: Boolean = false

0 commit comments

Comments
 (0)