aboutsummaryrefslogtreecommitdiff
path: root/plugins/mathjax/src/main
diff options
context:
space:
mode:
authorJacob Wysko <jacob@wysko.org>2022-02-21 10:30:59 -0500
committerGitHub <noreply@github.com>2022-02-21 18:30:59 +0300
commitf54597c754c9be6afb4ea374dc959dcc9fd551ce (patch)
tree8342c5d14a6f7641eabe2361c2fe5fed899053cd /plugins/mathjax/src/main
parentf5b7797255576e5f1c230e2ca3fcb5f4e602387c (diff)
downloaddokka-f54597c754c9be6afb4ea374dc959dcc9fd551ce.tar.gz
dokka-f54597c754c9be6afb4ea374dc959dcc9fd551ce.tar.bz2
dokka-f54597c754c9be6afb4ea374dc959dcc9fd551ce.zip
Fix MathJax rendering bug (#2342)
* Fix MathJax rendering bug (#2175) Fix a bug where using the `@usesMathJax` custom tag would cause the documentation to fail to render.
Diffstat (limited to 'plugins/mathjax/src/main')
-rw-r--r--plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt18
1 files changed, 18 insertions, 0 deletions
diff --git a/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt b/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt
index 6a00a3da..89c13202 100644
--- a/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt
+++ b/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt
@@ -16,6 +16,12 @@ class MathjaxPlugin : DokkaPlugin() {
val transformer by extending {
CoreExtensions.pageTransformer with MathjaxTransformer
}
+
+ val mathjaxTagContentProvider by extending {
+ plugin<DokkaBase>().customTagContentProvider with MathjaxTagContentProvider order {
+ before(plugin<DokkaBase>().sinceKotlinTagContentProvider)
+ }
+ }
}
private const val ANNOTATION = "usesMathJax"
@@ -34,3 +40,15 @@ object MathjaxTransformer : PageTransformer {
.orEmpty()
.any { (it as? CustomTagWrapper)?.name == ANNOTATION }
}
+
+object MathjaxTagContentProvider : CustomTagContentProvider {
+
+ override fun isApplicable(customTag: CustomTagWrapper) = customTag.name == ANNOTATION
+
+ override fun DocumentableContentBuilder.contentForDescription(
+ sourceSet: DokkaConfiguration.DokkaSourceSet,
+ customTag: CustomTagWrapper
+ ) {
+ comment(customTag.root, sourceSets = setOf(sourceSet))
+ }
+} \ No newline at end of file