aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
diff options
context:
space:
mode:
authorMarcin Aman <maman@virtuslab.com>2020-08-20 19:00:04 +0200
committerPaweł Marks <Kordyjan@users.noreply.github.com>2020-08-25 17:49:30 +0200
commitc9af371aa18dc50490dc3927ed88dfe8836c1bde (patch)
tree6b974aa9be26d9e3544327d17722d8f26e14cd4d /plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
parent7196323582dce7ca3f9b07262a1f94ecd8514539 (diff)
downloaddokka-c9af371aa18dc50490dc3927ed88dfe8836c1bde.tar.gz
dokka-c9af371aa18dc50490dc3927ed88dfe8836c1bde.tar.bz2
dokka-c9af371aa18dc50490dc3927ed88dfe8836c1bde.zip
Improve styles and functionality on module page #1336
Diffstat (limited to 'plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt')
-rw-r--r--plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
index a1f3c002..42700f20 100644
--- a/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
+++ b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
@@ -7,6 +7,7 @@ import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentCon
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.Documentable
import org.jetbrains.dokka.model.SourceSetDependent
+import org.jetbrains.dokka.model.doc.Description
import org.jetbrains.dokka.model.doc.DocTag
import org.jetbrains.dokka.model.properties.PropertyContainer
import org.jetbrains.dokka.model.toDisplaySourceSets
@@ -287,6 +288,22 @@ open class PageContentBuilder(
contents += ContentGroup(content, DCI(mainDRI, kind), sourceSets.toDisplaySourceSets(), styles, extra)
}
+ fun firstSentenceComment(
+ content: Description,
+ kind: Kind = ContentKind.Comment,
+ sourceSets: Set<DokkaSourceSet> = mainSourcesetData,
+ styles: Set<Style> = mainStyles,
+ extra: PropertyContainer<ContentNode> = mainExtra
+ ){
+ val builtDescription = commentsConverter.buildContent(
+ content.root,
+ DCI(mainDRI, kind),
+ sourceSets
+ )
+
+ contents += ContentGroup(briefFromContentNodes(builtDescription), DCI(mainDRI, kind), sourceSets.toDisplaySourceSets(), styles, extra)
+ }
+
fun group(
dri: Set<DRI> = mainDRI,
sourceSets: Set<DokkaSourceSet> = mainSourcesetData,