Skip to content

Fix interface companion objects spuriously rendered #4274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix interface companion objects spuriously rendered #4274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b9b642
Fix interface companion objects spuriously rendered
Seggan Sep 20, 2025
48212dc
Forgot to remove debug log
Seggan Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions ...java/src/main/kotlin/org/jetbrains/dokka/kotlinAsJava/converters/KotlinToJavaConverter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ public class KotlinToJavaConverter(
* Companion objects requires some custom logic for rendering as Java.
* They are excluded from usual classlikes rendering and added after.
*/
internal fun DClass.classlikesInJava(): List<DClasslike> {
internal fun <T> T.classlikesInJava(): List<DClasslike> where T : DClasslike, T : WithCompanion {
val classlikes = classlikes
.filter { it.name != companion?.name }
.map { it.asJava() }
Expand Down Expand Up @@ -442,9 +442,10 @@ public class KotlinToJavaConverter(
.filterNot { it.hasJvmSynthetic() }
.flatMap { it.asJava(dri.classNames ?: name) },
properties = emptyList(),
classlikes = classlikes.map { it.asJava() }, // TODO: public static final class DefaultImpls with impls for methods
classlikes = classlikesInJava(), // TODO: public static final class DefaultImpls with impls for methods
generics = generics.map { it.asJava() },
supertypes = supertypes.mapValues { it.value.map { it.asJava() } }
supertypes = supertypes.mapValues { it.value.map { it.asJava() } },
companion = companion?.companionAsJava()
)

internal fun DAnnotation.asJava(): DAnnotation = copy(
Expand Down
25 changes: 24 additions & 1 deletion ...bprojects/plugin-kotlin-as-java/src/test/kotlin/kotlinAsJavaPlugin/CompanionAsJavaTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,29 @@ class CompanionAsJavaTest : BaseAbstractTest() {
}
}

@Test
fun `interface companion should not be rendered when companion is not rendered`() {
testInline(
"""
|/src/main/kotlin/kotlinAsJavaPlugin/sample.kt
|package kotlinAsJavaPlugin
|interface MyInterface {
| companion object $COMPANION_NAME {
| @JvmStatic fun staticFun(): String = ""
| }
|}
""".trimMargin(),
configuration,
) {
documentablesTransformationStage = { module ->
val parentInterface = module.packages.flatMap { it.classlikes }
.firstOrNull { it.name == "MyInterface" } as DInterface

assertCompanionNotRendered(parentInterface)
}
}
}

@Test
fun `companion object with nested classes is rendered`() {
testInline(
Expand Down Expand Up @@ -521,7 +544,7 @@ private fun assertCompanionRendered(parentClass: DClass) {
)
}

private fun assertCompanionNotRendered(parentClass: DClass) {
private fun <T> assertCompanionNotRendered(parentClass: T) where T : DClasslike, T : WithCompanion {
assertNull(parentClass.companion, "Companion should be null")
assertTrue(
parentClass.classlikes.none { it.name == COMPANION_NAME },
Expand Down