From 0c67b741c71752baca5b1f98bfa6d8496c0119c5 Mon Sep 17 00:00:00 2001 From: Andrei Arlou Date: Tue, 16 Nov 2021 16:25:43 +0200 Subject: [PATCH] Use apidoc directive in common/may-change.md (#22904) (#30775) --- akka-docs/src/main/paradox/common/may-change.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/akka-docs/src/main/paradox/common/may-change.md b/akka-docs/src/main/paradox/common/may-change.md index dfa1f41fa7..fee1bd7738 100644 --- a/akka-docs/src/main/paradox/common/may-change.md +++ b/akka-docs/src/main/paradox/common/may-change.md @@ -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