Skip to content
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

Jump to bottom

[K2] Support external modifier for properties #3613

Merged
merged 1 commit into from
May 23, 2024
Merged

[K2] Support external modifier for properties #3613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion ...brains/dokka/analysis/kotlin/symbols/translators/DefaultSymbolToDocumentableTranslator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,7 +926,8 @@ internal class DokkaSymbolVisitor(
ExtraModifiers.KotlinOnlyModifiers.Const.takeIf { (this as? KtKotlinPropertySymbol)?.isConst == true },
ExtraModifiers.KotlinOnlyModifiers.LateInit.takeIf { (this as? KtKotlinPropertySymbol)?.isLateInit == true },
//ExtraModifiers.JavaOnlyModifiers.Static.takeIf { isJvmStaticInObjectOrClassOrInterface() },
//ExtraModifiers.KotlinOnlyModifiers.External.takeIf { isExternal },
// TODO https://youtrack.jetbrains.com/issue/KT-68236/Analysis-API-add-isExternal-property-for-KtPropertySymbol
ExtraModifiers.KotlinOnlyModifiers.External.takeIf { (psi as? KtProperty)?.hasModifier(KtTokens.EXTERNAL_KEYWORD) == true },
//ExtraModifiers.KotlinOnlyModifiers.Static.takeIf { isStatic },
ExtraModifiers.KotlinOnlyModifiers.Override.takeIf { isOverride }
).toSet().takeUnless { it.isEmpty() }
Expand Down
47 changes: 45 additions & 2 deletions dokka-subprojects/plugin-base/src/test/kotlin/multiplatform/BasicMultiplatformTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ package multiplatform
import org.jetbrains.dokka.base.signatures.KotlinSignatureUtils.driOrNull
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.DFunction
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.model.*
import utils.OnlySymbols
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertTrue

class BasicMultiplatformTest : BaseAbstractTest() {

Expand Down Expand Up @@ -110,4 +110,47 @@ class BasicMultiplatformTest : BaseAbstractTest() {
}
}
}

@Test
fun `fun and prop should have external modifier`() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
name = "js"
displayName = "js"
analysisPlatform = "js"
sourceRoots = listOf("src/main/kotlin/js/Test.kt")
}
}
}

testInline(
"""
|/src/main/kotlin/js/Test.kt
|package multiplatform
|
|external fun fn(): Unit
|external val x: String
""".trimMargin(),
configuration
) {
documentablesMergingStage = {
fun DProperty.hasModifier(modifier: ExtraModifiers.KotlinOnlyModifiers): Boolean =
extra[AdditionalModifiers]
?.content
?.any { (_, modifiers) -> modifier in modifiers } == true

fun DFunction.hasModifier(modifier: ExtraModifiers.KotlinOnlyModifiers): Boolean =
extra[AdditionalModifiers]
?.content
?.any { (_, modifiers) -> modifier in modifiers } == true

val fn = it.dfs { it is DFunction && it.name == "fn" } as DFunction
assertTrue(fn.hasModifier(ExtraModifiers.KotlinOnlyModifiers.External))

val prop = it.dfs { it is DProperty && it.name == "x" } as DProperty
assertTrue(prop.hasModifier(ExtraModifiers.KotlinOnlyModifiers.External))
}
}
}
}
42 changes: 39 additions & 3 deletions dokka-subprojects/plugin-base/src/test/kotlin/signatures/SignatureTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.DokkaConfigurationImpl
import org.jetbrains.dokka.DokkaSourceSetID
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.model.DFunction
import org.jetbrains.dokka.model.DefinitelyNonNullable
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.model.*
import org.jsoup.nodes.Element
import utils.*
import kotlin.test.Test
Expand Down Expand Up @@ -1602,6 +1600,44 @@ class SignatureTest : BaseAbstractTest() {
)
}

@Test
fun `fun and prop should have external modifier`() {
val writerPlugin = TestOutputWriterPlugin()
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
name = "js"
displayName = "js"
analysisPlatform = "js"
classpath = listOf(commonStdlibPath ?: throw IllegalStateException("Common stdlib is not found"))
sourceRoots = listOf("src/main/kotlin/js/Test.kt")
externalDocumentationLinks = listOf(stdlibExternalDocumentationLink)
}
}
}

testInline(
"""
|/src/main/kotlin/js/Test.kt
|package multiplatform
|
|external fun fn(): Unit
|external val x: String
""".trimMargin(), configuration = configuration, pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val signatures =
writerPlugin.writer.renderedContent("root/multiplatform/index.html").signature().toList()
signatures[0].match(
"external val ", A("x"), ": ", A("String"), ignoreSpanWithTokenStyle = true
)
signatures[1].match(
"external fun", A("fn"), "()", ignoreSpanWithTokenStyle = true
)
}
}
}

private fun testRender(
query: String,
configuration: DokkaConfigurationImpl = this.configuration,
Expand Down
Loading