aboutsummaryrefslogtreecommitdiff
path: root/plugins/base
diff options
context:
space:
mode:
authorPaweł Marks <pmarks@virtuslab.com>2020-02-27 18:21:06 +0100
committerPaweł Marks <Kordyjan@users.noreply.github.com>2020-03-04 14:28:14 +0100
commit33d67aae63986687f0eff9228cfc9f9d5da6d61e (patch)
tree2a675cd95e764494ee31b4d729ac8b3e12700cdc /plugins/base
parentded94108b225686bc77ec1626798ded06a6db0c1 (diff)
downloaddokka-33d67aae63986687f0eff9228cfc9f9d5da6d61e.tar.gz
dokka-33d67aae63986687f0eff9228cfc9f9d5da6d61e.tar.bz2
dokka-33d67aae63986687f0eff9228cfc9f9d5da6d61e.zip
Signature provider moved to base
Diffstat (limited to 'plugins/base')
-rw-r--r--plugins/base/src/main/kotlin/DokkaBase.kt2
-rw-r--r--plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt (renamed from plugins/base/src/main/kotlin/providers/KotlinSignatureProvider.kt)2
-rw-r--r--plugins/base/src/main/kotlin/signatures/SignatureProvider.kt8
3 files changed, 11 insertions, 1 deletions
diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
index 03875320..78a51559 100644
--- a/plugins/base/src/main/kotlin/DokkaBase.kt
+++ b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -6,6 +6,7 @@ import org.jetbrains.dokka.base.renderers.OutputWriter
import org.jetbrains.dokka.base.renderers.html.HtmlRenderer
import org.jetbrains.dokka.base.resolvers.DefaultLocationProviderFactory
import org.jetbrains.dokka.base.resolvers.LocationProviderFactory
+import org.jetbrains.dokka.base.signatures.SignatureProvider
import org.jetbrains.dokka.base.transformers.documentables.DefaultDocumentableMerger
import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConverter
@@ -21,6 +22,7 @@ import org.jetbrains.dokka.plugability.DokkaPlugin
class DokkaBase : DokkaPlugin() {
val pageMergerStrategy by extensionPoint<PageMergerStrategy>()
val commentsToContentConverter by extensionPoint<CommentsToContentConverter>()
+ val signatureProvider by extensionPoint<SignatureProvider>()
val locationProviderFactory by extensionPoint<LocationProviderFactory>()
val outputWriter by extensionPoint<OutputWriter>()
diff --git a/plugins/base/src/main/kotlin/providers/KotlinSignatureProvider.kt b/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt
index efee39fd..6eddca0d 100644
--- a/plugins/base/src/main/kotlin/providers/KotlinSignatureProvider.kt
+++ b/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt
@@ -1,4 +1,4 @@
-package org.jetbrains.dokka.base.providers
+package org.jetbrains.dokka.base.signatures
import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
diff --git a/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt b/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt
new file mode 100644
index 00000000..738f405a
--- /dev/null
+++ b/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt
@@ -0,0 +1,8 @@
+package org.jetbrains.dokka.base.signatures
+
+import org.jetbrains.dokka.model.Documentable
+import org.jetbrains.dokka.pages.ContentNode
+
+interface SignatureProvider {
+ fun signature(documentable: Documentable): List<ContentNode>
+} \ No newline at end of file