aboutsummaryrefslogtreecommitdiff
path: root/plugins/javadoc/src
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-08-21 14:50:55 +0200
committerGitHub <noreply@github.com>2021-08-21 14:50:55 +0200
commit9be7ac19b3ad38c80c78f39443eb2f55b3b699c6 (patch)
treef82ee68f489d8cdf60fdd5a61cef10a2e0f072c1 /plugins/javadoc/src
parent0f866368324cf0bddd444567d26270ea02d8cd0f (diff)
downloaddokka-9be7ac19b3ad38c80c78f39443eb2f55b3b699c6.tar.gz
dokka-9be7ac19b3ad38c80c78f39443eb2f55b3b699c6.tar.bz2
dokka-9be7ac19b3ad38c80c78f39443eb2f55b3b699c6.zip
Make briefs contain first paragraph as in spec, resolve issues with i.e. (#2048)
* Make briefs contain first paragraph as in spec, resolve issues with i.e. * Html and the end
Diffstat (limited to 'plugins/javadoc/src')
-rw-r--r--plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt6
1 files changed, 3 insertions, 3 deletions
diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt
index 4d0a62c3..4dbd5ca7 100644
--- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt
+++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt
@@ -4,7 +4,7 @@ import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.signatures.SignatureProvider
import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConverter
-import org.jetbrains.dokka.base.translators.documentables.briefFromContentNodes
+import org.jetbrains.dokka.base.translators.documentables.firstSentenceBriefFromContentNodes
import org.jetbrains.dokka.javadoc.pages.*
import org.jetbrains.dokka.model.*
import org.jetbrains.dokka.model.doc.Description
@@ -194,10 +194,10 @@ open class JavadocPageCreator(context: DokkaContext) {
?: throw IllegalStateException("No source set found for ${jvm.sourceSetID} ")
private fun Documentable.brief(sourceSet: DokkaSourceSet? = highestJvmSourceSet): List<ContentNode> =
- briefFromContentNodes(descriptionToContentNodes(sourceSet))
+ firstSentenceBriefFromContentNodes(descriptionToContentNodes(sourceSet))
private fun DParameter.brief(sourceSet: DokkaSourceSet? = highestJvmSourceSet): List<ContentNode> =
- briefFromContentNodes(paramsToContentNodes(sourceSet).dropWhile { it is ContentDRILink })
+ firstSentenceBriefFromContentNodes(paramsToContentNodes(sourceSet).dropWhile { it is ContentDRILink })
private fun ContentNode.asJavadocNode(): JavadocSignatureContentNode =
(this as ContentGroup).firstChildOfTypeOrNull<JavadocSignatureContentNode>()