diff options
| author | Kamil Doległo <kamilok1965@interia.pl> | 2020-04-03 12:45:54 +0200 |
|---|---|---|
| committer | Paweł Marks <Kordyjan@users.noreply.github.com> | 2020-04-07 11:43:41 +0200 |
| commit | fe24837fb51d5004ec3d7d728ce4c325a192e426 (patch) | |
| tree | ec8a3548d06036fa042ff52447eb35d22497d0ee /plugins/base/src/main/kotlin/translators/documentables | |
| parent | 828b20f1d7ba7e84f34452452ffa395638a72f2e (diff) | |
| download | dokka-fe24837fb51d5004ec3d7d728ce4c325a192e426.tar.gz dokka-fe24837fb51d5004ec3d7d728ce4c325a192e426.tar.bz2 dokka-fe24837fb51d5004ec3d7d728ce4c325a192e426.zip | |
Add DTypeAlias documentable
Diffstat (limited to 'plugins/base/src/main/kotlin/translators/documentables')
| -rw-r--r-- | plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt | 20 |
1 files changed, 19 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 67284b22..5ed44e18 100644 --- a/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt +++ b/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt @@ -32,7 +32,8 @@ open class DefaultPageCreator( open fun pageForPackage(p: DPackage): PackagePageNode = PackagePageNode( p.name, contentForPackage(p), setOf(p.dri), p, p.classlikes.map(::pageForClasslike) + - p.functions.map(::pageForFunction) + p.functions.map(::pageForFunction) + + p.typealiases.map(::pageForTypeAlias) ) open fun pageForEnumEntry(e: DEnumEntry): ClasslikePageNode = @@ -56,6 +57,8 @@ open class DefaultPageCreator( open fun pageForFunction(f: DFunction) = MemberPageNode(f.name, contentForFunction(f), setOf(f.dri), f) + open fun pageForTypeAlias(t: DTypeAlias) = MemberPageNode(t.name, contentForTypeAlias(t), setOf(t.dri), t) + private val WithScope.filteredFunctions get() = functions.filter { it.extra[InheritedFunction]?.isInherited != true } @@ -73,6 +76,15 @@ open class DefaultPageCreator( header(1) { text("Package ${p.name}") } } +contentForScope(p, p.dri, p.platformData) + block("Type aliases", 2, ContentKind.Classlikes, p.typealiases, p.platformData.toSet()) { + link(it.name, it.dri) + group { + +buildSignature(it) + group(kind = ContentKind.BriefComment) { + text(it.briefDocumentation()) + } + } + } } protected open fun contentForScope( @@ -304,6 +316,12 @@ open class DefaultPageCreator( +contentForComments(f) } + protected open fun contentForTypeAlias(t: DTypeAlias) = contentBuilder.contentFor(t) { + header(1) { text(t.name) } + +buildSignature(t) + +contentForComments(t) + } + protected open fun TagWrapper.toHeaderString() = this.javaClass.toGenericString().split('.').last() //TODO: It isn't platform-aware and produces wrong docs Probably should use platformDependentHint |
