Add BCV API dumps #194
Add BCV API dumps #194
Conversation
- add BCV - hide internal KxBM functionality with an opt-in annotation - minor tidying of plugin build script https://youtrack.jetbrains.com/issue/KT-66948
plugin/main/src/kotlinx/benchmark/gradle/BenchmarkConfiguration.kt
Outdated
Show resolved
Hide resolved
plugin/main/src/kotlinx/benchmark/gradle/internal/KotlinxBenchmarkPluginInternalApi.kt
Outdated
Show resolved
Hide resolved
…al api - they shouldn't be accessed by plugin users.
| * Please remove references to internal API to supported stable references. | ||
| * If you still require access to these APIs, please raise an issue. | ||
| */ | ||
| @RequiresOptIn(level = WARNING) |
There was a problem hiding this comment.
I would suggest adding a message to the annotation in addition or even instead to the KDoc as it's more visible and accessible even without the sources
There was a problem hiding this comment.
A message would indeed be helpful. But a lengthy one could overwhelm users. Especially if the internal API is used in multiple instances, as this would clutter the build log. I prefer a shorter message in addition to the documentation, such as "This API is internal to the Kotlinx Benchmark project and will be hidden in a future release."
There was a problem hiding this comment.
Thanks Alex, I forgot that @RequiresOptIn had a message option.
I used a more generic message @qurbonzoda Internal Kotlinx Benchmark API. It may be changed in future releases without notice., since it might be used on things that can't be made internal - WDYT?
Resolves https://youtrack.jetbrains.com/issue/KT-66948