Introduce FrameworkAPI annotation to document APIs that are provided ONLY for frameworks (#38686)

mdvacca · facebook-github-bot · commit cbf9408dd0e3 · 2023-07-30T11:54:13.000-07:00
Summary: Pull Request resolved: #38686 In this diff I'm introducing the FrameworkAPI annotation to document APIs that are provided ONLY for frameworks changelog: [internal] internal Reviewed By: cortinico Differential Revision: D47839411 fbshipit-source-id: 254a1f6cd42279478fba0ddb3f3736bb2b675bae
diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/annotations/FrameworkAPI.kt b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/annotations/FrameworkAPI.kt
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package com.facebook.react.common.annotations
+
+@Retention(AnnotationRetention.RUNTIME)
+@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
+@RequiresOptIn(
+    level = RequiresOptIn.Level.ERROR,
+    message =
+        "This API is provided only for React Native frameworks and not intended for general users. " +
+            "This API can change between minor versions in alignment with React Native frameworks " +
+            "and won't be considered a breaking change.")
+annotation class FrameworkAPI
