src/Formats/MarkdownFormatService.kt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

package org.jetbrains.dokka

public class MarkdownFormatService(val locationService: LocationService,
                                   val signatureGenerator: SignatureGenerator) : FormatService {
    override val extension: String = "md"
    override fun format(node: DocumentationNode, to: StringBuilder) {
        with (to) {
            appendln(node.path.map { "[${it.name}](${locationService.relativeLocation(node, it, extension)})" }.joinToString(" / "))
            appendln()
            appendln("# ${node.name}")
            appendln("```")
            appendln(signatureGenerator.render(node))
            appendln("```")
            appendln(node.doc.summary)
            appendln()
            for (section in node.doc.sections) {
                append("### ")
                appendln(section.label)
                appendln(section.text)
            }

            appendln("### Members")
            appendln("| Name | Signature | Summary |")
            appendln("|------|-----------|---------|")
            for (member in node.members.sortBy { it.name }) {
                val relativePath = locationService.relativeLocation(node, member, extension)
                append("|[${member.name}](${relativePath})")
                append("|${signatureGenerator.render(member)}")
                append("|${member.doc.summary} ")
                appendln("|")
            }
        }
    }
}