Skip to content

Commit cbf9408

Browse files
mdvaccafacebook-github-bot
authored andcommitted
Introduce FrameworkAPI annotation to document APIs that are provided ONLY for frameworks (#38686)
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
1 parent 17ebe6c commit cbf9408

File tree

1 file changed

+18
-0
lines changed
  • packages/react-native/ReactAndroid/src/main/java/com/facebook/react/common/annotations

1 file changed

+18
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*/
7+
8+
package com.facebook.react.common.annotations
9+
10+
@Retention(AnnotationRetention.RUNTIME)
11+
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
12+
@RequiresOptIn(
13+
level = RequiresOptIn.Level.ERROR,
14+
message =
15+
"This API is provided only for React Native frameworks and not intended for general users. " +
16+
"This API can change between minor versions in alignment with React Native frameworks " +
17+
"and won't be considered a breaking change.")
18+
annotation class FrameworkAPI

0 commit comments

Comments
 (0)