raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Use apidoc directive in common/may-change.md (#22904) (#30775)

Browse source
This commit is contained in:
Andrei Arlou 2021-11-16 16:25:43 +02:00 • committed by GitHub
parent 9b591a0476
commit 0c67b741c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
akka-docs/src/main/paradox/common/may-change.md
View file

@ -13,7 +13,7 @@ Concretely **may change** means that an API or module is in early access mode an
Complete modules can be marked as **may change**, which will be stated in the module's description and in the docs.
Individual public APIs can be annotated with `akka.api.annotation.ApiMayChange` to signal that it has less
Individual public APIs can be annotated with @javadoc[ApiMayChange](akka.annotation.ApiMayChange) to signal that it has less
guarantees than the rest of the module it lives in. For example, when while introducing "new" Java 8 APIs into
existing stable modules, these APIs may be marked with this annotation to signal that they are not frozen yet.
Please use such methods and classes with care, however if you see such APIs that is the best point in time to try them