Skip to content

public-api-modifier README #1663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jolanrensen wants to merge 1 commit into
base: master
Choose a base branch
from
Open

public-api-modifier README #1663

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions plugins/public-api-modifier/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
## :plugins:public-api-modifier

This plugin makes annotated functions internal.
Helps to produce two artifacts from the same code: one with full API, one with reduced API.
This compiler plugin makes `@AccessApiOverload` annotated functions internal.
It could help to produce two artifacts from the same code: one with the full API, one with a reduced API.

This is an exploratory plugin that is NOT actually enabled.
See https://github.com/Kotlin/dataframe/pull/959 for more information.

You can test it by adding `compilerPluginClasspath(projects.pluginApiModifier)` in
[`:core`](../../core/build.gradle.kts).