azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Native: mention cinterop libraries in the ExperimentalForeignApi KDoc

Browse Source 
Now (mostly after 3f3f6eb) cinterop adds ExperimentalForeignApi to all
Kotlin declarations it generates from C and Objective-C libraries,
except for the platform libraries.
This commit changes the KDoc for ExperimentalForeignApi to reflect that
change.

^KT-58362
This commit is contained in:
Svyatoslav Scherbina
2023-07-25 17:18:00 +00:00
committed by Space Team
parent db908aefff
commit dcb34e0ec0
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
kotlin-native/Interop/Runtime/src/main/kotlin/kotlinx/cinterop/Annotations.kt
+3 -1
View File
@@ -39,10 +39,12 @@ public annotation class UnsafeNumber(val actualPlatformTypes: Array<String>)
public annotation class BetaInteropApi
/**
* Marks foreign-memory-related API as experimental.
* Marks foreign-language-related API as experimental.
*
* Foreign API includes all operations and classifiers that are required for operating with
* unmanaged and foreign memory, including but not limited to such declarations as [CPointer], [CPointed], [StableRef], and `Pinned`.
* It also includes API of C and Objective-C libraries, except for those that are available in Kotlin by default
* (like `platform.posix.*` or `platform.Foundation.*`).
*
* Such API is considered experimental and has the following known limitations and caveats:
* - It is either undocumented or lacks extensive and sound description.