blob: 6e26377eea1c09cab381b17cb943fb5c709b86d4 (
plain)
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
|
@file:Suppress("FunctionName")
package org.jetbrains.dokka.base.transformers.documentables
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.analysis.KotlinAnalysis
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentation.Classifier
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentationFragment
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentationParsingContext
import org.jetbrains.dokka.base.parsers.moduleAndPackage.parseModuleAndPackageDocumentation
import org.jetbrains.dokka.base.parsers.moduleAndPackage.parseModuleAndPackageDocumentationFragments
import org.jetbrains.dokka.model.DModule
import org.jetbrains.dokka.model.DPackage
import org.jetbrains.dokka.model.SourceSetDependent
import org.jetbrains.dokka.model.doc.*
import org.jetbrains.dokka.model.doc.Deprecated
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.utilities.associateWithNotNull
internal interface ModuleAndPackageDocumentationReader {
operator fun get(module: DModule): SourceSetDependent<DocumentationNode>
operator fun get(pkg: DPackage): SourceSetDependent<DocumentationNode>
}
internal fun ModuleAndPackageDocumentationReader(
context: DokkaContext, kotlinAnalysis: KotlinAnalysis? = null
): ModuleAndPackageDocumentationReader = ContextModuleAndPackageDocumentationReader(context, kotlinAnalysis)
private class ContextModuleAndPackageDocumentationReader(
private val context: DokkaContext,
private val kotlinAnalysis: KotlinAnalysis?
) : ModuleAndPackageDocumentationReader {
private val documentationFragments: SourceSetDependent<List<ModuleAndPackageDocumentationFragment>> =
context.configuration.sourceSets.associateWith { sourceSet ->
sourceSet.includes.flatMap { include -> parseModuleAndPackageDocumentationFragments(include) }
}
private fun findDocumentationNodes(
sourceSets: Set<DokkaConfiguration.DokkaSourceSet>,
predicate: (ModuleAndPackageDocumentationFragment) -> Boolean
): SourceSetDependent<DocumentationNode> {
return sourceSets.associateWithNotNull { sourceSet ->
val fragments = documentationFragments[sourceSet].orEmpty().filter(predicate)
val resolutionFacade = kotlinAnalysis?.get(sourceSet)?.facade
val documentations = fragments.map { fragment ->
parseModuleAndPackageDocumentation(
context = ModuleAndPackageDocumentationParsingContext(context.logger, resolutionFacade),
fragment = fragment
)
}
when (documentations.size) {
0 -> null
1 -> documentations.single().documentation
else -> DocumentationNode(documentations.flatMap { it.documentation.children }
.mergeDocumentationNodes())
}
}
}
private val ModuleAndPackageDocumentationFragment.canonicalPackageName: String
get() {
check(classifier == Classifier.Package)
if (name == "[root]") return ""
return name
}
override fun get(module: DModule): SourceSetDependent<DocumentationNode> {
return findDocumentationNodes(module.sourceSets) { fragment ->
fragment.classifier == Classifier.Module && (fragment.name == module.name)
}
}
override fun get(pkg: DPackage): SourceSetDependent<DocumentationNode> {
return findDocumentationNodes(pkg.sourceSets) { fragment ->
fragment.classifier == Classifier.Package && fragment.canonicalPackageName == pkg.dri.packageName
}
}
private fun List<TagWrapper>.mergeDocumentationNodes(): List<TagWrapper> =
groupBy { it::class }.values.map {
it.reduce { acc, tagWrapper ->
val newRoot = CustomDocTag(
acc.children + tagWrapper.children,
name = (tagWrapper as? NamedTagWrapper)?.name.orEmpty()
)
when (acc) {
is See -> acc.copy(newRoot)
is Param -> acc.copy(newRoot)
is Throws -> acc.copy(newRoot)
is Sample -> acc.copy(newRoot)
is Property -> acc.copy(newRoot)
is CustomTagWrapper -> acc.copy(newRoot)
is Description -> acc.copy(newRoot)
is Author -> acc.copy(newRoot)
is Version -> acc.copy(newRoot)
is Since -> acc.copy(newRoot)
is Return -> acc.copy(newRoot)
is Receiver -> acc.copy(newRoot)
is Constructor -> acc.copy(newRoot)
is Deprecated -> acc.copy(newRoot)
is org.jetbrains.dokka.model.doc.Suppress -> acc.copy(newRoot)
}
}
}
}
|
