From 26a7c54ccba7df51d0f8bb33277b8a366bfd28f5 Mon Sep 17 00:00:00 2001 From: Paweł Marks Date: Tue, 5 Nov 2019 13:19:01 +0100 Subject: Adds constructors to documentation --- core/src/main/kotlin/DokkaDescriptorVisitor.kt | 6 ++++++ core/src/main/kotlin/Model/DocumentationNode.kt | 1 + .../transformers/DefaultDocumentationToPageTransformer.kt | 10 ++++------ 3 files changed, 11 insertions(+), 6 deletions(-) (limited to 'core/src/main/kotlin') diff --git a/core/src/main/kotlin/DokkaDescriptorVisitor.kt b/core/src/main/kotlin/DokkaDescriptorVisitor.kt index 979acdc5..ac54635b 100644 --- a/core/src/main/kotlin/DokkaDescriptorVisitor.kt +++ b/core/src/main/kotlin/DokkaDescriptorVisitor.kt @@ -36,6 +36,7 @@ object DokkaDescriptorVisitor : DeclarationDescriptorVisitorEmptyBodies, override val functions: List, override val properties: List, override val classes: List, diff --git a/core/src/main/kotlin/transformers/DefaultDocumentationToPageTransformer.kt b/core/src/main/kotlin/transformers/DefaultDocumentationToPageTransformer.kt index 54fd9a27..cae1d652 100644 --- a/core/src/main/kotlin/transformers/DefaultDocumentationToPageTransformer.kt +++ b/core/src/main/kotlin/transformers/DefaultDocumentationToPageTransformer.kt @@ -35,7 +35,7 @@ class DefaultDocumentationToPageTransformer( private fun pageForClass(c: Class, parent: PageNode): ClassPageNode = ClassPageNode(c.name, contentForClass(c), parent, c.dri, c).apply { - // TODO: Pages for constructors + appendChildren(c.constructors.map { pageForMember(it, this) }) appendChildren(c.classes.map { pageForClass(it, this) }) appendChildren(c.functions.map { pageForMember(it, this) }) appendChildren(c.properties.map { pageForMember(it, this) }) @@ -72,11 +72,9 @@ class DefaultDocumentationToPageTransformer( private fun contentForClass(c: Class) = content(platformData) { header(1) { text(c.name) } markdown(c.rawDocstring, c) - text("PING PAWEL TO ADD CONSTRUCTORS TO MODEL!!!") - block("Constructors", emptyList() /* TODO: CONSTRUCTORS*/) { - link(it.name, it.dri) + block("Constructors", c.constructors) { + link("signature for constructor", it.dri) text(it.briefDocstring) - text("message to Pawel from the future: you forgot about extracting constructors, didn't you?") } block("Functions", c.functions) { link(it.name, it.dri) @@ -91,7 +89,7 @@ class DefaultDocumentationToPageTransformer( markdown(f.rawDocstring, f) block("Parameters", f.children) { group { - text(it.name ?: "RECEIVER") + text(it.name ?: "") markdown(it.rawDocstring, it) } } -- cgit