From 20fcffbbb5ad6eeea1a612c7be1f8c98883153f8 Mon Sep 17 00:00:00 2001 From: James Strachan Date: Fri, 13 Apr 2012 18:20:20 +0100 Subject: [PATCH] allow kdoc package summaries to use markdown for formatting and links (which works nicely in a pom.xml if using maven for example and avoids HTML escaping issues) --- .../org/jetbrains/kotlin/doc/model/KotlinModel.kt | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt index ff6c94b5b04..de3862a4d2e 100644 --- a/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt +++ b/libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt @@ -781,8 +781,13 @@ abstract class KAnnotated(val model: KModel, val declarationDescriptor: Declarat } fun detailedDescription(template: KDocTemplate): String { + val wiki = wikiDescription + return wikiConvert(wiki, template) + } + + protected fun wikiConvert(wiki: String, template: KDocTemplate): String { val file = model.fileFor(declarationDescriptor) - return model.wikiConvert(wikiDescription, TemplateLinkRenderer(this, template), file) + return model.wikiConvert(wiki, TemplateLinkRenderer(this, template), file) } fun isLinkToSourceRepo(): Boolean { @@ -895,7 +900,10 @@ class KPackage(model: KModel, val descriptor: NamespaceDescriptor, override fun description(template: KDocTemplate): String { // lets see if we can find a custom summary val text = model.config.packageSummaryText[name] - return if (text != null) text else super.description(template) + return if (text != null) + wikiConvert(text, template).trimLeading("

").trimTrailing("

") + else + super.description(template) }