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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
package org.jetbrains.dokka
import java.io.File
public open class HtmlFormatService(locationService: LocationService,
signatureGenerator: LanguageService,
val templateService: HtmlTemplateService = HtmlTemplateService.default())
: StructuredFormatService(locationService, signatureGenerator, "html"), OutlineFormatService {
override public fun formatText(text: String): String {
return text.htmlEscape()
}
override fun formatSymbol(text: String): String {
return "<span class=\"symbol\">${formatText(text)}</span>"
}
override fun formatKeyword(text: String): String {
return "<span class=\"keyword\">${formatText(text)}</span>"
}
override fun formatIdentifier(text: String, kind: IdentifierKind): String {
return "<span class=\"identifier\">${formatText(text)}</span>"
}
override fun appendBlockCode(to: StringBuilder, line: String, language: String) {
to.append("<pre><code>")
to.append(line)
to.append("</code></pre>")
}
override fun appendHeader(to: StringBuilder, text: String, level: Int) {
to.appendln("<h$level>${text}</h$level>")
}
override fun appendParagraph(to: StringBuilder, text: String) {
to.appendln("<p>${text}</p>")
}
override fun appendLine(to: StringBuilder, text: String) {
to.appendln("${text}<br/>")
}
override fun appendLine(to: StringBuilder) {
to.appendln("<br/>")
}
override fun appendAnchor(to: StringBuilder, anchor: String) {
to.appendln("<a name=\"${anchor.htmlEscape()}\"></a>")
}
override fun appendTable(to: StringBuilder, body: () -> Unit) {
to.appendln("<table>")
body()
to.appendln("</table>")
}
override fun appendTableHeader(to: StringBuilder, body: () -> Unit) {
to.appendln("<thead>")
body()
to.appendln("</thead>")
}
override fun appendTableBody(to: StringBuilder, body: () -> Unit) {
to.appendln("<tbody>")
body()
to.appendln("</tbody>")
}
override fun appendTableRow(to: StringBuilder, body: () -> Unit) {
to.appendln("<tr>")
body()
to.appendln("</tr>")
}
override fun appendTableCell(to: StringBuilder, body: () -> Unit) {
to.appendln("<td>")
body()
to.appendln("</td>")
}
override fun formatLink(text: String, href: String): String {
return "<a href=\"${href}\">${text}</a>"
}
override fun formatStrong(text: String): String {
return "<strong>${text}</strong>"
}
override fun formatEmphasis(text: String): String {
return "<emph>${text}</emph>"
}
override fun formatStrikethrough(text: String): String {
return "<s>${text}</s>"
}
override fun formatCode(code: String): String {
return "<code>${code}</code>"
}
override fun formatUnorderedList(text: String): String = "<ul>${text}</ul>"
override fun formatOrderedList(text: String): String = "<ol>${text}</ol>"
override fun formatListItem(text: String, kind: ListKind): String {
return "<li>${text}</li>"
}
override fun formatBreadcrumbs(items: Iterable<FormatLink>): String {
return items.map { formatLink(it) }.joinToString(" / ")
}
override fun appendNodes(location: Location, to: StringBuilder, nodes: Iterable<DocumentationNode>) {
templateService.appendHeader(to, getPageTitle(nodes))
super<StructuredFormatService>.appendNodes(location, to, nodes)
templateService.appendFooter(to)
}
override fun appendOutline(location: Location, to: StringBuilder, nodes: Iterable<DocumentationNode>) {
templateService.appendHeader(to, "Module Contents")
super<OutlineFormatService>.appendOutline(location, to, nodes)
templateService.appendFooter(to)
}
override fun getOutlineFileName(location: Location): File {
return File("${location.path}-outline.html")
}
override fun appendOutlineHeader(location: Location, node: DocumentationNode, to: StringBuilder) {
val link = ContentNodeDirectLink(node)
link.append(languageService.render(node, LanguageService.RenderMode.FULL))
val signature = formatText(location, link)
to.appendln("<a href=\"${location.path}\">${signature}</a><br/>")
}
override fun appendOutlineLevel(to: StringBuilder, body: () -> Unit) {
to.appendln("<ul>")
body()
to.appendln("</ul>")
}
override fun formatNonBreakingSpace(): String = " "
}
fun getPageTitle(nodes: Iterable<DocumentationNode>): String? {
val breakdownByLocation = nodes.groupBy { node -> formatPageTitle(node) }
return breakdownByLocation.keySet().singleOrNull()
}
fun formatPageTitle(node: DocumentationNode): String {
val path = node.path
if (path.size() == 1) {
return path.first().name
}
val qualifiedName = path.drop(1).map { it.name }.filter { it.length() > 0 }.join(".")
if (qualifiedName.length() == 0 && path.size() == 2) {
return path.first().name + " / root package"
}
return path.first().name + " / " + qualifiedName
}
|
