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
|
package org.jetbrains.dokka
import com.intellij.psi.PsiJavaFile
import com.intellij.psi.PsiClass
import org.jetbrains.dokka.DocumentationNode.Kind
import com.intellij.psi.PsiMethod
import com.intellij.psi.javadoc.PsiDocComment
import com.intellij.psi.PsiType
import com.intellij.psi.PsiParameter
import com.intellij.psi.PsiNamedElement
import com.intellij.psi.PsiDocCommentOwner
import com.intellij.psi.PsiClassType
import com.intellij.psi.PsiPrimitiveType
import com.intellij.psi.PsiModifierListOwner
import com.intellij.psi.PsiModifier
import com.intellij.psi.PsiArrayType
import com.intellij.psi.PsiTypeParameter
import com.intellij.psi.javadoc.PsiDocTag
import com.intellij.psi.javadoc.PsiDocTagValue
public class JavaDocumentationBuilder() {
fun appendFile(file: PsiJavaFile, module: DocumentationModule) {
val packageNode = module.findOrCreatePackageNode(file.getPackageName())
packageNode.appendChildren(file.getClasses()) { build() }
}
fun parseDocumentation(docComment: PsiDocComment?): Content {
if (docComment == null) return Content.Empty
val result = Content()
docComment.getDescriptionElements().dropWhile { it.getText().trim().isEmpty() }.forEach {
val text = if (result.isEmpty()) it.getText().trimLeading() else it.getText()
result.append(ContentText(text))
}
docComment.getTags().forEach { tag ->
val subjectName = tag.getSubjectName()
val section = result.addSection(javadocSectionDisplayName(tag.getName()), subjectName)
tag.getDataElements().forEach {
if (it !is PsiDocTagValue || tag.getSubjectName() == null) {
section.append(ContentText(it.getText()))
}
}
}
return result
}
fun PsiDocTag.getSubjectName(): String? {
if (getName() == "param" || getName() == "throws" || getName() == "exception") {
return getValueElement()?.getText()
}
return null
}
fun DocumentationNode(element: PsiNamedElement,
kind: Kind,
name: String = element.getName() ?: "<anonymous>"): DocumentationNode {
val docComment = if (element is PsiDocCommentOwner) parseDocumentation(element.getDocComment()) else Content.Empty
val node = DocumentationNode(name, docComment, kind)
if (element is PsiModifierListOwner) {
node.appendModifiers(element)
}
return node
}
fun DocumentationNode.appendChildren<T>(elements: Array<T>,
kind: DocumentationReference.Kind = DocumentationReference.Kind.Member,
buildFn: T.() -> DocumentationNode) {
elements.forEach {
append(it.buildFn(), kind)
}
}
fun DocumentationNode.appendMembers<T>(elements: Array<T>, buildFn: T.() -> DocumentationNode) =
appendChildren(elements, DocumentationReference.Kind.Member, buildFn)
fun DocumentationNode.appendDetails<T>(elements: Array<T>, buildFn: T.() -> DocumentationNode) =
appendChildren(elements, DocumentationReference.Kind.Detail, buildFn)
fun PsiClass.build(): DocumentationNode {
val kind = when {
isInterface() -> DocumentationNode.Kind.Interface
isEnum() -> DocumentationNode.Kind.Enum
isAnnotationType() -> DocumentationNode.Kind.AnnotationClass
else -> DocumentationNode.Kind.Class
}
val node = DocumentationNode(this, kind)
getExtendsListTypes().forEach { node.appendType(it, Kind.Supertype) }
getImplementsListTypes().forEach { node.appendType(it, Kind.Supertype) }
node.appendDetails(getTypeParameters()) { build() }
node.appendMembers(getMethods()) { build() }
node.appendMembers(getInnerClasses()) { build() }
return node
}
fun PsiMethod.build(): DocumentationNode {
val node = DocumentationNode(this,
if (isConstructor()) Kind.Constructor else Kind.Function,
if (isConstructor()) "<init>" else getName())
if (!isConstructor()) {
node.appendType(getReturnType())
}
node.appendDetails(getParameterList().getParameters()) { build() }
node.appendDetails(getTypeParameters()) { build() }
return node
}
fun PsiParameter.build(): DocumentationNode {
val node = DocumentationNode(this, Kind.Parameter)
node.appendType(getType())
return node
}
fun PsiTypeParameter.build(): DocumentationNode {
val node = DocumentationNode(this, Kind.TypeParameter)
getExtendsListTypes().forEach { node.appendType(it, Kind.UpperBound) }
getImplementsListTypes().forEach { node.appendType(it, Kind.UpperBound) }
return node
}
fun DocumentationNode.appendModifiers(element: PsiModifierListOwner) {
val modifierList = element.getModifierList()
if (modifierList == null) {
return
}
PsiModifier.MODIFIERS.forEach {
if (modifierList.hasExplicitModifier(it)) {
val modifierNode = DocumentationNode(it, Content.Empty, Kind.Modifier)
append(modifierNode, DocumentationReference.Kind.Detail)
}
}
}
fun DocumentationNode.appendType(psiType: PsiType?, kind: DocumentationNode.Kind = DocumentationNode.Kind.Type) {
if (psiType == null) {
return
}
append(psiType.build(kind), DocumentationReference.Kind.Detail)
}
fun PsiType.build(kind: DocumentationNode.Kind = DocumentationNode.Kind.Type): DocumentationNode {
val name = mapTypeName(this)
val node = DocumentationNode(name, Content.Empty, kind)
if (this is PsiClassType) {
node.appendDetails(getParameters()) { build(Kind.TypeParameter) }
}
return node
}
private fun mapTypeName(psiType: PsiType): String = when (psiType) {
PsiType.VOID -> "Unit"
is PsiPrimitiveType -> psiType.getCanonicalText().capitalize()
is PsiClassType -> psiType.getClassName()
is PsiArrayType -> "Array<${mapTypeName(psiType.getComponentType())}>"
else -> psiType.getCanonicalText()
}
}
|
