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.util.*
public open class DocumentationNode(val name: String,
content: Content,
val kind: DocumentationNode.Kind) {
private val references = LinkedHashSet<DocumentationReference>()
var content: Content = content
private set
public val summary: ContentNode get() = content.summary
public val owner: DocumentationNode?
get() = references(DocumentationReference.Kind.Owner).singleOrNull()?.to
public val details: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Detail).map { it.to }
public val members: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Member).map { it.to }
public val inheritedMembers: List<DocumentationNode>
get() = references(DocumentationReference.Kind.InheritedMember).map { it.to }
public val extensions: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Extension).map { it.to }
public val inheritors: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Inheritor).map { it.to }
public val overrides: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Override).map { it.to }
public val links: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Link).map { it.to }
public val hiddenLinks: List<DocumentationNode>
get() = references(DocumentationReference.Kind.HiddenLink).map { it.to }
public val annotations: List<DocumentationNode>
get() = references(DocumentationReference.Kind.Annotation).map { it.to }
public val deprecation: DocumentationNode?
get() = references(DocumentationReference.Kind.Deprecation).singleOrNull()?.to
// TODO: Should we allow node mutation? Model merge will copy by ref, so references are transparent, which could nice
public fun addReferenceTo(to: DocumentationNode, kind: DocumentationReference.Kind) {
references.add(DocumentationReference(this, to, kind))
}
public fun addAllReferencesFrom(other: DocumentationNode) {
references.addAll(other.references)
}
public fun updateContent(body: MutableContent.() -> Unit) {
if (content !is MutableContent) {
content = MutableContent()
}
(content as MutableContent).body()
}
public fun details(kind: DocumentationNode.Kind): List<DocumentationNode> = details.filter { it.kind == kind }
public fun members(kind: DocumentationNode.Kind): List<DocumentationNode> = members.filter { it.kind == kind }
public fun inheritedMembers(kind: DocumentationNode.Kind): List<DocumentationNode> = inheritedMembers.filter { it.kind == kind }
public fun links(kind: DocumentationNode.Kind): List<DocumentationNode> = links.filter { it.kind == kind }
public fun detail(kind: DocumentationNode.Kind): DocumentationNode = details.filter { it.kind == kind }.single()
public fun member(kind: DocumentationNode.Kind): DocumentationNode = members.filter { it.kind == kind }.single()
public fun link(kind: DocumentationNode.Kind): DocumentationNode = links.filter { it.kind == kind }.single()
public fun references(kind: DocumentationReference.Kind): List<DocumentationReference> = references.filter { it.kind == kind }
public fun allReferences(): Set<DocumentationReference> = references
public override fun toString(): String {
return "$kind:$name"
}
public enum class Kind {
Unknown,
Package,
Class,
Interface,
Enum,
AnnotationClass,
EnumItem,
Object,
Constructor,
Function,
Property,
CompanionObjectProperty,
CompanionObjectFunction,
Parameter,
Receiver,
TypeParameter,
Type,
Supertype,
UpperBound,
LowerBound,
Exception,
Modifier,
NullabilityModifier,
Module,
ExternalClass,
Annotation,
Value,
SourceUrl,
SourcePosition,
/**
* A note which is rendered once on a page documenting a group of overloaded functions.
* Needs to be generated equally on all overloads.
*/
OverloadGroupNote
}
}
public class DocumentationModule(name: String, content: Content = Content.Empty)
: DocumentationNode(name, content, DocumentationNode.Kind.Module) {
}
val DocumentationNode.path: List<DocumentationNode>
get() {
val parent = owner
if (parent == null)
return listOf(this)
return parent.path + this
}
fun DocumentationNode.findOrCreatePackageNode(packageName: String, packageContent: Map<String, Content>): DocumentationNode {
val existingNode = members(DocumentationNode.Kind.Package).firstOrNull { it.name == packageName }
if (existingNode != null) {
return existingNode
}
val newNode = DocumentationNode(packageName,
packageContent.getOrElse(packageName) { Content.Empty },
DocumentationNode.Kind.Package)
append(newNode, DocumentationReference.Kind.Member)
return newNode
}
fun DocumentationNode.append(child: DocumentationNode, kind: DocumentationReference.Kind) {
addReferenceTo(child, kind)
when (kind) {
DocumentationReference.Kind.Detail -> child.addReferenceTo(this, DocumentationReference.Kind.Owner)
DocumentationReference.Kind.Member -> child.addReferenceTo(this, DocumentationReference.Kind.Owner)
DocumentationReference.Kind.Owner -> child.addReferenceTo(this, DocumentationReference.Kind.Member)
else -> { /* Do not add any links back for other types */ }
}
}
fun DocumentationNode.appendTextNode(text: String,
kind: DocumentationNode.Kind,
refKind: DocumentationReference.Kind = DocumentationReference.Kind.Detail) {
append(DocumentationNode(text, Content.Empty, kind), refKind)
}
fun DocumentationNode.qualifiedName() = path.drop(1).map { it.name }.filter { it.length > 0 }.joinToString(".")
|
