Add unit tests for KDoc links to Java (#3584)

Two new tests have been added in `LinkTest.kt`. One is to verify that a KDoc link correctly points to Java annotation methods, and the second test is for Java synthetic properties.
Kotlin · Apr 25, 2024 · d6c9fc8 · d6c9fc8
1 parent 17ea994
commit d6c9fc8
Showing 1 changed file with 59 additions and 0 deletions.
diff --git a/dokka-subprojects/plugin-base/src/test/kotlin/markdown/LinkTest.kt b/dokka-subprojects/plugin-base/src/test/kotlin/markdown/LinkTest.kt
@@ -1040,6 +1040,65 @@ class LinkTest : BaseAbstractTest() {
         }
     }
 
+    @Test
+    fun `KDoc link should lead to java annotation methods`() {
+        testInline(
+            """
+            |/src/main/kotlin/Testing.kt
+            |package example
+            |
+            |/**
+            | * [Storage.value]
+            | */
+            |val usage = 0            
+            |/src/example/Storage.java
+            |package example;
+            |@interface Storage {
+            |  String value() default "";
+            |}
+        """.trimMargin(),
+            configuration
+        ) {
+            documentablesMergingStage = { module ->
+                assertEquals(DRI("example", "Storage", Callable("value", null, emptyList())), module.getLinkDRIFrom("usage"))
+            }
+        }
+    }
+
+    @Test
+    fun `KDoc link should lead to java synthetic properties`() {
+        testInline(
+            """
+            |/src/main/kotlin/Testing.kt
+            |package example
+            |
+            |/**
+            | * value: [Storage.value] is unresolved
+            | * setValue: [Storage.setValue]
+            | * prop: [Storage.prop]
+            | */
+            |val usage = 0            
+            |/src/example/Storage.java
+            |package example;
+            |class Storage {
+            |    void prop() {}
+            |    void setValue(String value) {}
+            |    String getProp() { return null; }
+            |}
+        """.trimMargin(),
+            configuration
+        ) {
+            documentablesMergingStage = { module ->
+                assertEquals(
+                    listOf(
+                        "Storage.setValue" to DRI("example", "Storage", Callable("setValue", null, listOf(TypeConstructor("kotlin.String", emptyList())))),
+                        "Storage.prop" to DRI("example", "Storage", Callable("prop", null, emptyList()))
+                    ),
+                    module.getAllLinkDRIFrom("usage"))
+            }
+        }
+    }
+
     private fun DModule.getLinkDRIFrom(name: String): DRI? {
         val link =  this.dfs { it.name == name }?.documentation?.values?.single()?.firstMemberOfTypeOrNull<DocumentationLink>()
         return link?.dri