IJPL-224531 improve docs based on reviews' comments

GitOrigin-RevId: 8765caa1c00dd617daaeb9c5482ed4a47a42c80c
This commit is contained in:
Vladimir Krivosheev
2025-12-20 16:10:45 +00:00
committed by intellij-monorepo-bot
parent 0e8b9653f5
commit 3a05faea81
2 changed files with 9 additions and 1 deletions
@@ -10,7 +10,11 @@ import org.junit.jupiter.api.extension.ExtendWith
* Sets the [value] for the [Registry] [key] before an annotated test method (or a class),
* and reverts to the previous value after an annotated test method (or, respectively, a class).
*
* This annotation is preferred over manual [Registry.get] + [com.intellij.openapi.util.registry.RegistryValue.setValue] calls
* as it automatically handles cleanup after test completion.
*
* @see com.intellij.openapi.util.registry.RegistryValue.setValue
* @see TestDisposable alternative for manual registry value management
*/
@TestOnly
@Repeatable
@@ -1,4 +1,4 @@
// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.testFramework.junit5
import com.intellij.testFramework.junit5.fixture.TestFixtures
@@ -14,6 +14,10 @@ import org.junit.jupiter.api.extension.ExtendWith
* i.e., after all tests were run.
*
* @see com.intellij.testFramework.junit5.showcase.JUnit5ApplicationTest
* @see RegistryKey for setting registry values in tests
* @see TestDisposable for injecting test-scoped disposables
* @see RunInEdt for running tests in EDT
* @see SystemProperty for setting system properties in tests
*/
@TestOnly
@Target(AnnotationTarget.CLASS)