Improve KDoc

JetBrains · Oct 10, 2024 · 69ee9af · 69ee9af
1 parent 538b00e
commit 69ee9af
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/...rifier/verifier-test/src/test/java/com/jetbrains/pluginverifier/tests/BaseBytecodeTest.kt b/...rifier/verifier-test/src/test/java/com/jetbrains/pluginverifier/tests/BaseBytecodeTest.kt
@@ -201,8 +201,10 @@ abstract class BaseBytecodeTest {
   /**
    * Builds an instance of the IDE with specified bundled plugins.
    *
+   * By default, this IDE contains the `com.intellij` plugin available in the `lib/idea.jar`.
+   *
    * @param bundledPlugins List of plugins to include in the `plugins` directory.
-   * @param bundledCorePlugins List of plugins to include in the `lib` directory of the IDE.
+   * @param additionalCorePlugins Additional plugins to include in the `lib` directory of the IDE.
    * @param includeKotlinStdLib Whether to include the Kotlin standard library.
    * @param productInfo JSON contents of `product-info.json`
    * @param version The version string of this IDE.
@@ -211,7 +213,7 @@ abstract class BaseBytecodeTest {
    */
   internal fun buildIdeWithBundledPlugins(
     bundledPlugins: List<PluginSpec> = emptyList(),
-    bundledCorePlugins: List<PluginSpec> = emptyList(),
+    additionalCorePlugins: List<PluginSpec> = emptyList(),
     includeKotlinStdLib: Boolean = false,
     productInfo: String? = null,
     version: String = "IU-192.1",
@@ -237,7 +239,7 @@ abstract class BaseBytecodeTest {
             }
           }
         }
-        bundledCorePlugins.forEach { plugin ->
+        additionalCorePlugins.forEach { plugin ->
           plugin.buildJar(this)
         }
         if (includeKotlinStdLib) {

diff --git a/...ier/verifier-test/src/test/java/com/jetbrains/pluginverifier/tests/JsonPluginUsageTest.kt b/...ier/verifier-test/src/test/java/com/jetbrains/pluginverifier/tests/JsonPluginUsageTest.kt
@@ -72,7 +72,7 @@ class JsonPluginUsageTest : BaseBytecodeTest() {
 
   @Test
   fun `plugin uses JSON classes, JSON plugin is declared and includes classes`() {
-    val targetIde = buildIdeWithBundledPlugins(bundledCorePlugins = listOf(jsonPlugin))
+    val targetIde = buildIdeWithBundledPlugins(additionalCorePlugins = listOf(jsonPlugin))
     assertEquals(2, targetIde.bundledPlugins.size)
 
     assertVerified {