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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
package org.jetbrains.dokka
public abstract class ContentNode
public object ContentEmpty : ContentNode()
public open class ContentBlock() : ContentNode() {
val children = arrayListOf<ContentNode>()
fun append(node : ContentNode) {
children.add(node)
}
fun isEmpty() = children.isEmpty()
override fun equals(other: Any?): Boolean =
other is ContentBlock && javaClass == other.javaClass && children == other.children
override fun hashCode(): Int =
children.hashCode()
}
enum class IdentifierKind {
TypeName,
ParameterName,
AnnotationName,
Other
}
public data class ContentText(val text: String) : ContentNode()
public data class ContentKeyword(val text: String) : ContentNode()
public data class ContentIdentifier(val text: String, val kind: IdentifierKind = IdentifierKind.Other) : ContentNode()
public data class ContentSymbol(val text: String) : ContentNode()
public data class ContentEntity(val text: String) : ContentNode()
public object ContentNonBreakingSpace: ContentNode()
public class ContentParagraph() : ContentBlock()
public class ContentEmphasis() : ContentBlock()
public class ContentStrong() : ContentBlock()
public class ContentStrikethrough() : ContentBlock()
public class ContentCode() : ContentBlock()
public class ContentBlockCode(val language: String = "") : ContentBlock()
public abstract class ContentNodeLink() : ContentBlock() {
abstract val node: DocumentationNode?
}
public class ContentNodeDirectLink(override val node: DocumentationNode): ContentNodeLink() {
override fun equals(other: Any?): Boolean =
super.equals(other) && other is ContentNodeDirectLink && node.name == other.node.name
override fun hashCode(): Int =
children.hashCode() * 31 + node.name.hashCode()
}
public class ContentNodeLazyLink(val linkText: String, val lazyNode: () -> DocumentationNode?): ContentNodeLink() {
override val node: DocumentationNode? get() = lazyNode()
override fun equals(other: Any?): Boolean =
super.equals(other) && other is ContentNodeLazyLink && linkText == other.linkText
override fun hashCode(): Int =
children.hashCode() * 31 + linkText.hashCode()
}
public class ContentExternalLink(val href : String) : ContentBlock() {
override fun equals(other: Any?): Boolean =
super.equals(other) && other is ContentExternalLink && href == other.href
override fun hashCode(): Int =
children.hashCode() * 31 + href.hashCode()
}
public class ContentUnorderedList() : ContentBlock()
public class ContentOrderedList() : ContentBlock()
public class ContentListItem() : ContentBlock()
public class ContentHeading(val level: Int) : ContentBlock()
public class ContentSection(public val tag: String, public val subjectName: String?) : ContentBlock() {
override fun equals(other: Any?): Boolean =
super.equals(other) && other is ContentSection && tag == other.tag && subjectName == other.subjectName
override fun hashCode(): Int =
children.hashCode() * 31 * 31 + tag.hashCode() * 31 + (subjectName?.hashCode() ?: 0)
}
public object ContentTags {
val Description = "Description"
val SeeAlso = "See Also"
}
fun content(body: ContentBlock.() -> Unit): ContentBlock {
val block = ContentBlock()
block.body()
return block
}
fun ContentBlock.text(value: String) = append(ContentText(value))
fun ContentBlock.keyword(value: String) = append(ContentKeyword(value))
fun ContentBlock.symbol(value: String) = append(ContentSymbol(value))
fun ContentBlock.identifier(value: String, kind: IdentifierKind = IdentifierKind.Other) = append(ContentIdentifier(value, kind))
fun ContentBlock.nbsp() = append(ContentNonBreakingSpace)
fun ContentBlock.strong(body: ContentBlock.() -> Unit) {
val strong = ContentStrong()
strong.body()
append(strong)
}
fun ContentBlock.code(body: ContentBlock.() -> Unit) {
val code = ContentCode()
code.body()
append(code)
}
fun ContentBlock.link(to: DocumentationNode, body: ContentBlock.() -> Unit) {
val block = ContentNodeDirectLink(to)
block.body()
append(block)
}
public open class Content(): ContentBlock() {
public open val sections: List<ContentSection> get() = emptyList()
public open val summary: ContentNode get() = ContentEmpty
public open val description: ContentNode get() = ContentEmpty
fun findSectionByTag(tag: String): ContentSection? =
sections.firstOrNull { tag.equals(it.tag, ignoreCase = true) }
companion object {
val Empty = Content()
}
}
public open class MutableContent() : Content() {
private val sectionList = arrayListOf<ContentSection>()
public override val sections: List<ContentSection>
get() = sectionList
fun addSection(tag: String?, subjectName: String?): ContentSection {
val section = ContentSection(tag ?: "", subjectName)
sectionList.add(section)
return section
}
public override val summary: ContentNode get() = children.firstOrNull() ?: ContentEmpty
public override val description: ContentNode by lazy {
val descriptionNodes = children.drop(1)
if (descriptionNodes.isEmpty()) {
ContentEmpty
} else {
val result = ContentSection(ContentTags.Description, null)
result.children.addAll(descriptionNodes)
result
}
}
override fun equals(other: Any?): Boolean {
if (other !is Content)
return false
return sections == other.sections && children == other.children
}
override fun hashCode(): Int {
return sections.map { it.hashCode() }.sum()
}
override fun toString(): String {
if (sections.isEmpty())
return "<empty>"
return (listOf(summary, description) + sections).joinToString()
}
val isEmpty: Boolean
get() = sections.none()
}
fun javadocSectionDisplayName(sectionName: String?): String? =
when(sectionName) {
"param" -> "Parameters"
"throws", "exception" -> "Exceptions"
else -> sectionName?.capitalize()
}
|
