aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/Formats/StructuredFormatService.kt21
-rw-r--r--src/Kotlin/ContentBuilder.kt2
-rw-r--r--src/Kotlin/DocumentationBuilder.kt14
-rw-r--r--src/Model/Content.kt24
-rw-r--r--src/Model/DocumentationNode.kt8
5 files changed, 34 insertions, 35 deletions
diff --git a/src/Formats/StructuredFormatService.kt b/src/Formats/StructuredFormatService.kt
index fe127732..6ec75379 100644
--- a/src/Formats/StructuredFormatService.kt
+++ b/src/Formats/StructuredFormatService.kt
@@ -98,23 +98,24 @@ public abstract class StructuredFormatService(val locationService: LocationServi
appendSectionWithSubject(it.getKey(), location, it.getValue(), to)
}
- for (section in node.content.sections) {
- if (section.subjectName != null) continue
- appendLine(to, formatStrong(formatText(section.label)))
+ for (section in node.content.sections.filter { it.subjectName == null }) {
+ appendLine(to, formatStrong(formatText(section.tag)))
appendLine(to, formatText(location, section))
}
}
}
}
- fun appendSectionWithSubject(title: String, location: Location, parameterSections: List<ContentSection>, to: StringBuilder) {
+ fun Content.getSectionsWithSubjects(): Map<String, List<ContentSection>> =
+ sections.filter { it.subjectName != null }.groupBy { it.tag }
+
+ fun appendSectionWithSubject(title: String, location: Location, subjectSections: List<ContentSection>, to: StringBuilder) {
appendHeader(to, title, 3)
- parameterSections.forEach {
- val parameterName = it.subjectName
- if (parameterName != null) {
- to.append(formatCode(parameterName)).append(" - ")
- val formatted = formatText(location, it)
- to.append(formatted)
+ subjectSections.forEach {
+ val subjectName = it.subjectName
+ if (subjectName != null) {
+ to.append(formatCode(subjectName)).append(" - ")
+ to.append(formatText(location, it))
appendLine(to)
}
}
diff --git a/src/Kotlin/ContentBuilder.kt b/src/Kotlin/ContentBuilder.kt
index 95e08c92..35beec54 100644
--- a/src/Kotlin/ContentBuilder.kt
+++ b/src/Kotlin/ContentBuilder.kt
@@ -112,7 +112,7 @@ public fun DocumentationBuilder.buildContentTo(tree: MarkdownNode, target: Conte
private fun keepWhitespace(node: ContentNode) = node is ContentParagraph || node is ContentSection
public fun DocumentationBuilder.buildInlineContentTo(tree: MarkdownNode, target: ContentNode) {
- val inlineContent = tree.children.firstOrNull { it.type == MarkdownElementTypes.PARAGRAPH }?.children ?: listOf(tree)
+ val inlineContent = tree.children.singleOrNull { it.type == MarkdownElementTypes.PARAGRAPH }?.children ?: listOf(tree)
inlineContent.forEach {
buildContentTo(it, target)
}
diff --git a/src/Kotlin/DocumentationBuilder.kt b/src/Kotlin/DocumentationBuilder.kt
index 053615bc..c0533437 100644
--- a/src/Kotlin/DocumentationBuilder.kt
+++ b/src/Kotlin/DocumentationBuilder.kt
@@ -41,13 +41,15 @@ class DocumentationBuilder(val session: ResolveSession, val options: Documentati
fun parseDocumentation(descriptor: DeclarationDescriptor): Content {
val kdoc = findKDoc(descriptor)
- val docText = kdoc?.getContent() ?: ""
- val tree = parseMarkdown(docText)
+ if (kdoc == null) {
+ return Content.Empty
+ }
+ val tree = parseMarkdown(kdoc.getContent())
//println(tree.toTestString())
val content = buildContent(tree)
if (kdoc is KDocSection) {
- val tags = PsiTreeUtil.getChildrenOfType(kdoc, javaClass<KDocTag>())
- tags?.forEach {
+ val tags = kdoc.getTags()
+ tags.forEach {
if (it.getName() == "code") {
content.append(functionBody(descriptor, it.getContent()))
} else {
@@ -61,11 +63,13 @@ class DocumentationBuilder(val session: ResolveSession, val options: Documentati
return content
}
+ fun KDocSection.getTags(): Array<KDocTag> = PsiTreeUtil.getChildrenOfType(this, javaClass<KDocTag>()) ?: array()
+
fun displayName(sectionName: String?): String? =
when(sectionName) {
"param" -> "Parameters"
"throws", "exception" -> "Exceptions"
- else -> sectionName
+ else -> sectionName?.capitalize()
}
fun link(node: DocumentationNode, descriptor: DeclarationDescriptor) {
diff --git a/src/Model/Content.kt b/src/Model/Content.kt
index 2fae317d..e59037d2 100644
--- a/src/Model/Content.kt
+++ b/src/Model/Content.kt
@@ -1,5 +1,7 @@
package org.jetbrains.dokka
+import kotlin.properties.Delegates
+
public abstract class ContentNode {
val children = arrayListOf<ContentNode>()
@@ -32,7 +34,7 @@ public class ContentNodeLink(val node : DocumentationNode) : ContentBlock()
public class ContentExternalLink(val href : String) : ContentBlock()
public class ContentList() : ContentBlock()
public class ContentListItem() : ContentBlock()
-public class ContentSection(public val label: String, public val subjectName: String?) : ContentBlock()
+public class ContentSection(public val tag: String, public val subjectName: String?) : ContentBlock()
fun content(body: ContentNode.() -> Unit): ContentNode {
val block = ContentBlock()
@@ -62,22 +64,20 @@ public class Content() : ContentNode() {
return section
}
- fun findSectionByName(name: String): ContentSection? =
- sections.firstOrNull { it.label == name }
-
- fun getSectionsWithSubjects(): Map<String, List<ContentSection>> =
- sections.filter { it.subjectName != null }.groupBy { it.label }
+ fun findSectionByTag(tag: String): ContentSection? =
+ sections.firstOrNull { tag.equalsIgnoreCase(it.tag) }
public val summary: ContentNode get() = children.firstOrNull() ?: ContentEmpty
- public val description: ContentNode get() {
+ public val description: ContentNode by Delegates.lazy {
val descriptionNodes = children.drop(1)
if (descriptionNodes.isEmpty()) {
- return ContentEmpty
+ ContentEmpty
+ } else {
+ val result = ContentSection("Description", null)
+ result.children.addAll(descriptionNodes)
+ result
}
- val result = ContentSection("\$description", null)
- result.children.addAll(descriptionNodes)
- return result
}
override fun equals(other: Any?): Boolean {
@@ -93,7 +93,7 @@ public class Content() : ContentNode() {
override fun toString(): String {
if (sections.isEmpty())
return "<empty>"
- return sections.joinToString()
+ return (listOf(summary, description) + sections).joinToString()
}
val isEmpty: Boolean
diff --git a/src/Model/DocumentationNode.kt b/src/Model/DocumentationNode.kt
index 3a61b8fb..c3700069 100644
--- a/src/Model/DocumentationNode.kt
+++ b/src/Model/DocumentationNode.kt
@@ -8,13 +8,7 @@ public open class DocumentationNode(val name: String,
private val references = LinkedHashSet<DocumentationReference>()
-
- public val summary: ContentNode get() {
- val contentSection = content.summary
- if (contentSection != null)
- return contentSection
- return ContentNode.empty
- }
+ public val summary: ContentNode get() = content.summary
public val owner: DocumentationNode?
get() = references(DocumentationReference.Kind.Owner).singleOrNull()?.to
generated by cgit (git 2.46.0) at 2024-12-03 20:29:08 +0000