aboutsummaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2020-03-03 19:56:07 +0100
committerKamil Doległo <kamilok1965@users.noreply.github.com>2020-03-04 18:00:19 +0100
commit8ea1e6752aadc7da2bd9e1fff7f4040d16e3d864 (patch)
tree106203e2a17b7b6d49603d8b0d3841e2222a24ad /plugins
parente4044ec67ad90041b02bb84c4b966ffeac537617 (diff)
downloaddokka-8ea1e6752aadc7da2bd9e1fff7f4040d16e3d864.tar.gz
dokka-8ea1e6752aadc7da2bd9e1fff7f4040d16e3d864.tar.bz2
dokka-8ea1e6752aadc7da2bd9e1fff7f4040d16e3d864.zip
Improve JavaSignatureProvider
Diffstat (limited to 'plugins')
-rw-r--r--plugins/kotlin-as-java/src/main/kotlin/JavaSignatureProvider.kt42
-rw-r--r--plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt11
2 files changed, 31 insertions, 22 deletions
diff --git a/plugins/kotlin-as-java/src/main/kotlin/JavaSignatureProvider.kt b/plugins/kotlin-as-java/src/main/kotlin/JavaSignatureProvider.kt
index 526546f2..6a6acf6d 100644
--- a/plugins/kotlin-as-java/src/main/kotlin/JavaSignatureProvider.kt
+++ b/plugins/kotlin-as-java/src/main/kotlin/JavaSignatureProvider.kt
@@ -15,7 +15,7 @@ import org.jetbrains.dokka.pages.PlatformData
import org.jetbrains.dokka.utilities.DokkaLogger
class JavaSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogger) : SignatureProvider {
- private val contentBuilder = PageContentBuilder(ctcc, logger)
+ private val contentBuilder = PageContentBuilder(ctcc, this, logger)
override fun signature(documentable: Documentable): List<ContentNode> = when (documentable) {
is Function -> signature(documentable)
@@ -30,9 +30,8 @@ class JavaSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogge
private fun signature(c: Classlike) = c.platformData.map { signature(c, it) }.distinct()
private fun signature(c: Classlike, platform: PlatformData) = contentBuilder.contentFor(c, ContentKind.Symbol) {
- text(c.visibility[platform]?.externalDisplayName ?: "")
if (c is Class) {
- text(c.modifier.toString())
+ text(c.modifier.takeIf { it != WithAbstraction.Modifier.Empty }?.toString()?.toLowerCase().orEmpty())
}
when (c) {
is Class -> text(" class ")
@@ -42,19 +41,27 @@ class JavaSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogge
is Annotation -> text(" @interface ")
}
text(c.name!!)
- if (c is WithSupertypes) {
- list(c.supertypes.getValue(platform), prefix = " : ") {
+ if (c is WithGenerics) {
+ val generics = c.generics.filterOnPlatform(platform)
+ if (generics.isNotEmpty()) {
+ text("<")
+ list(generics) {
+ +this@JavaSignatureProvider.signature(it)
+ }
+ text(">")
+ }
+ }
+ if (c is WithSupertypes && c.supertypes.containsKey(platform)) {
+ list(c.supertypes.getValue(platform), prefix = " extends ") {
link(it.sureClassNames, it)
}
}
}
private fun signature(f: Function, platform: PlatformData) = contentBuilder.contentFor(f, ContentKind.Symbol) {
- text(f.visibility[platform]?.externalDisplayName ?: "")
- text(f.modifier.toString())
+ text(f.modifier.takeIf { it != WithAbstraction.Modifier.Empty }?.toString()?.toLowerCase().orEmpty())
val returnType = f.type
if (!f.isConstructor && returnType.constructorFqName != Unit::class.qualifiedName) {
- text(": ")
type(returnType)
}
text(" ")
@@ -63,28 +70,26 @@ class JavaSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogge
if (generics.isNotEmpty()) {
text("<")
generics.forEach {
- signature(it)
+ this@JavaSignatureProvider.signature(it)
}
text(">")
}
text("(")
- list(listOfNotNull(f.receiver) + f.parameters.filterOnPlatform(platform)) {
+ list(f.parameters.filterOnPlatform(platform)) {
type(it.type)
text(" ")
link(it.name!!, it.dri)
- text(", ")
}
text(")")
}
private fun signature(t: TypeParameter) = contentBuilder.contentFor(t, ContentKind.Symbol) {
- link(t.name, t.dri)
+ text(t.name.substringAfterLast("."))
if (t.bounds.isNotEmpty()) {
- text("<")
+ text(" extends ")
t.bounds.forEach {
- signature(it, t.dri, t.platformData)
+ +signature(it, t.dri, t.platformData)
}
- text(">")
}
}
@@ -93,13 +98,16 @@ class JavaSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogge
is TypeConstructor -> contentBuilder.contentFor(dri, platforms.toSet()) {
link(p.dri.classNames.orEmpty(), p.dri)
- }.children + p.projections.flatMap { signature(it, dri, platforms) }
+ list(p.projections, prefix = "<", suffix = ">") {
+ +signature(it, dri, platforms)
+ }
+ }.children
is Variance -> contentBuilder.contentFor(dri, platforms.toSet()) {
text(p.kind.toString() + " ")
}.children + signature(p.inner, dri, platforms)
- is Star -> contentBuilder.contentFor(dri, platforms.toSet()) { text("*") }.children
+ is Star -> contentBuilder.contentFor(dri, platforms.toSet()) { text("?") }.children
is Nullable -> signature(p.inner, dri, platforms) + contentBuilder.contentFor(
dri,
diff --git a/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt b/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt
index 19c4ef19..f7fc57ff 100644
--- a/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt
+++ b/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt
@@ -61,6 +61,7 @@ internal fun Property.asJava(isTopLevel: Boolean = false, relocateToClass: Strin
} else {
dri.withClass(relocateToClass)
},
+// name = name.o,
modifier = if (setter == null) {
WithAbstraction.Modifier.Final
} else {
@@ -113,7 +114,8 @@ internal fun Function.asJava(containingClassName: String): Function {
// dri = dri.copy(callable = dri.callable?.asJava()),
name = newName,
type = type.asJava(),
- parameters = parameters.map { it.asJava() }
+ parameters = listOfNotNull(receiver?.asJava()) + parameters.map { it.asJava() },
+ receiver = null
) // TODO: should receiver be the first param?
}
@@ -129,9 +131,7 @@ internal fun Classlike.asJava(): Classlike = when (this) {
internal fun Class.asJava(): Class = copy(
constructors = constructors.map { it.asJava(name) },
functions = (functions + properties.map { it.getter } + properties.map { it.setter }).filterNotNull().map {
- it.asJava(
- name
- )
+ it.asJava(name)
},
properties = properties.map { it.asJava() },
classlikes = classlikes.map { it.asJava() }
@@ -191,7 +191,8 @@ internal fun Annotation.asJava(): Annotation = copy(
) // TODO investigate if annotation class can have methods and properties not from constructor
internal fun Parameter.asJava(): Parameter = copy(
- type = type.asJava()
+ type = type.asJava(),
+ name = if (name.isNullOrBlank()) "\$self" else name
)
internal fun String.getAsPrimitive(): JvmPrimitiveType? = org.jetbrains.kotlin.builtins.PrimitiveType.values()