azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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)

Browse Source
This commit is contained in:
James Strachan
2012-04-13 18:20:20 +01:00
parent d83b76b7a7
commit 20fcffbbb5
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/model/KotlinModel.kt
+10 -2
View File
@@ -781,8 +781,13 @@ abstract class KAnnotated(val model: KModel, val declarationDescriptor: Declarat
} }
fun detailedDescription(template: KDocTemplate): String { 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) val file = model.fileFor(declarationDescriptor)
return model.wikiConvert(wikiDescription, TemplateLinkRenderer(this, template), file) return model.wikiConvert(wiki, TemplateLinkRenderer(this, template), file)
} }
fun isLinkToSourceRepo(): Boolean { fun isLinkToSourceRepo(): Boolean {
@@ -895,7 +900,10 @@ class KPackage(model: KModel, val descriptor: NamespaceDescriptor,
override fun description(template: KDocTemplate): String { override fun description(template: KDocTemplate): String {
// lets see if we can find a custom summary // lets see if we can find a custom summary
val text = model.config.packageSummaryText[name] val text = model.config.packageSummaryText[name]
return if (text != null) text else super<KClassOrPackage>.description(template) return if (text != null)
wikiConvert(text, template).trimLeading("<p>").trimTrailing("</p>")
else
super<KClassOrPackage>.description(template)
} }