aboutsummaryrefslogtreecommitdiff
path: root/dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-11-10 11:46:54 +0100
committerGitHub <noreply@github.com>2023-11-10 11:46:54 +0100
commit8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch)
tree1b915207b2b9f61951ddbf0ff2e687efd053d555 /dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt
parenta44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff)
downloaddokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt')
-rw-r--r--dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt43
1 files changed, 43 insertions, 0 deletions
diff --git a/dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt b/dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt
new file mode 100644
index 00000000..b1979f60
--- /dev/null
+++ b/dokka-subprojects/plugin-base/src/test/kotlin/translators/utils.kt
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package translators
+
+import org.jetbrains.dokka.model.*
+import org.jetbrains.dokka.model.doc.Description
+import org.jetbrains.dokka.model.doc.Text
+
+fun DModule.documentationOf(className: String, functionName: String? = null): String =
+ descriptionOf(className, functionName)
+ ?.firstMemberOfType<Text>()
+ ?.body.orEmpty()
+
+fun DModule.descriptionOf(className: String, functionName: String? = null): Description? {
+ val classlike = packages.single()
+ .classlikes.single { it.name == className }
+ val target: Documentable =
+ if (functionName != null) classlike.functions.single { it.name == functionName } else classlike
+ return target.documentation.values.singleOrNull()
+ ?.firstChildOfTypeOrNull<Description>()
+}
+
+fun DModule.findPackage(packageName: String? = null) =
+ packageName?.let { packages.firstOrNull { pkg -> pkg.packageName == packageName }
+ ?: throw NoSuchElementException("No packageName with name $packageName") } ?: packages.single()
+
+fun DModule.findClasslike(packageName: String? = null, className: String? = null): DClasslike {
+ val pkg = findPackage(packageName)
+ return className?.let {
+ pkg.classlikes.firstOrNull { cls -> cls.name == className }
+ ?: throw NoSuchElementException("No classlike with name $className")
+ } ?: pkg.classlikes.single()
+}
+
+fun DModule.findFunction(packageName: String? = null, className: String, functionName: String? = null): DFunction {
+ val classlike = findClasslike(packageName, className)
+ return functionName?.let {
+ classlike.functions.firstOrNull { fn -> fn.name == functionName }
+ ?: throw NoSuchElementException("No classlike with name $functionName")
+ } ?: classlike.functions.single()
+}