aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/main/kotlin/translators
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-03-10 02:29:18 +0100
committerGitHub <noreply@github.com>2021-03-10 02:29:18 +0100
commit5672eac58619fc13c1f611d1e7fe599444400f3b (patch)
treeb6658adb2b7c564ab72daee9b8c88e35e635e78f /plugins/base/src/main/kotlin/translators
parentac2c1adf18289acbff8a79e8cbabe58e00f30f63 (diff)
downloaddokka-5672eac58619fc13c1f611d1e7fe599444400f3b.tar.gz
dokka-5672eac58619fc13c1f611d1e7fe599444400f3b.tar.bz2
dokka-5672eac58619fc13c1f611d1e7fe599444400f3b.zip
Headers in tables (#1768)
Diffstat (limited to 'plugins/base/src/main/kotlin/translators')
-rw-r--r--plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt21
-rw-r--r--plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt4
2 files changed, 23 insertions, 2 deletions
diff --git a/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt b/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
index 55c2837c..07e52851 100644
--- a/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
+++ b/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
@@ -121,7 +121,17 @@ open class DefaultPageCreator(
}
+contentForComments(m)
- block("Packages", 2, ContentKind.Packages, m.packages, m.sourceSets.toSet(), needsAnchors = true) {
+ block(
+ "Packages",
+ 2,
+ ContentKind.Packages,
+ m.packages,
+ m.sourceSets.toSet(),
+ needsAnchors = true,
+ headers = listOf(
+ headers("Name")
+ )
+ ) {
val documentations = it.sourceSets.map { platform ->
it.descriptions[platform]?.also { it.root }
}
@@ -565,7 +575,10 @@ open class DefaultPageCreator(
list,
sourceSets,
needsAnchors = true,
- extra = mainExtra + SimpleAttr.header(name)
+ extra = mainExtra + SimpleAttr.header(name),
+ headers = listOf(
+ headers("Name", "Summary")
+ )
) {
link(it.name, it.dri, kind = ContentKind.Main)
sourceSetDependentHint(it.dri, it.sourceSets.toSet(), kind = ContentKind.SourceSetDependentHint) {
@@ -584,6 +597,10 @@ open class DefaultPageCreator(
if (collection.any()) {
header(2, name, kind = kind)
table(kind, extra = extra, styles = emptySet()) {
+ header {
+ group { text("Name") }
+ group { text("Summary") }
+ }
collection
.groupBy { it.name } // This groupBy should probably use LocationProvider
// This hacks displaying actual typealias signatures along classlike ones
diff --git a/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
index ba21f089..f98e284f 100644
--- a/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
+++ b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
@@ -146,6 +146,10 @@ open class PageContentBuilder(
}.build()
}
+ internal fun headers(vararg label: String) = contentFor(mainDRI, mainSourcesetData) {
+ label.forEach { text(it) }
+ }
+
fun <T : Documentable> block(
name: String,
level: Int,