diff options
author | Paweł Marks <pmarks@virtuslab.com> | 2020-07-10 18:52:54 +0200 |
---|---|---|
committer | Paweł Marks <Kordyjan@users.noreply.github.com> | 2020-07-13 10:14:16 +0200 |
commit | ec318a2ac97aa5ab88564dc36474131fc03cba61 (patch) | |
tree | 599aa509e8c82f406bc95e4e843b259acf891585 /plugins/base/src | |
parent | 43957996a2c530d7c22e00d841af9ad349cbf70a (diff) | |
download | dokka-ec318a2ac97aa5ab88564dc36474131fc03cba61.tar.gz dokka-ec318a2ac97aa5ab88564dc36474131fc03cba61.tar.bz2 dokka-ec318a2ac97aa5ab88564dc36474131fc03cba61.zip |
Render explicitly documented primary constructors
Diffstat (limited to 'plugins/base/src')
-rw-r--r-- | plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt | 2 | ||||
-rw-r--r-- | plugins/base/src/test/kotlin/content/signatures/SkippingParenthesisForConstructorsTest.kt | 61 |
2 files changed, 62 insertions, 1 deletions
diff --git a/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt b/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt index 19df2515..40283d82 100644 --- a/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt +++ b/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt @@ -197,7 +197,7 @@ open class DefaultPageCreator( "Constructors", 2, ContentKind.Constructors, - c.constructors.filter { it.extra[PrimaryConstructorExtra] == null }, + c.constructors.filter { it.extra[PrimaryConstructorExtra] == null || it.documentation.isNotEmpty() }, c.sourceSets, extra = PropertyContainer.empty<ContentNode>() + SimpleAttr.header("Constructors") ) { diff --git a/plugins/base/src/test/kotlin/content/signatures/SkippingParenthesisForConstructorsTest.kt b/plugins/base/src/test/kotlin/content/signatures/SkippingParenthesisForConstructorsTest.kt index c2fbd26f..7de48664 100644 --- a/plugins/base/src/test/kotlin/content/signatures/SkippingParenthesisForConstructorsTest.kt +++ b/plugins/base/src/test/kotlin/content/signatures/SkippingParenthesisForConstructorsTest.kt @@ -190,4 +190,65 @@ class ConstructorsSignaturesTest : AbstractCoreTest() { } } } + + @Test + fun `class with explicitly documented constructor`() { + testInline( + """ + |/src/main/kotlin/test/source.kt + |package test + | + | /** + | * some comment + | * @constructor ctor comment + | **/ + |class SomeClass(a: String) + """.trimIndent(), testConfiguration + ) { + pagesTransformationStage = { module -> + val page = module.children.single { it.name == "test" } + .children.single { it.name == "SomeClass" } as ContentPage + page.content.assertNode { + group { + header(1) { +"SomeClass" } + platformHinted { + skipAllNotMatching() + group { + +"class" + link { +"SomeClass" } + +"(a:" + group { link { +"String" } } + +")" + } + } + } + group { + header { +"Constructors" } + table { + group { + link { +"<init>" } + platformHinted { + group { + group { + +"ctor comment" + } + } + group { + +"fun" + link { +"<init>" } + +"(a:" + group { + link { +"String" } + } + +")" + } + } + } + } + skipAllNotMatching() + } + } + } + } + } } |