aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src
diff options
context:
space:
mode:
authorPaweł Marks <pmarks@virtuslab.com>2020-02-17 15:05:03 +0100
committerPaweł Marks <Kordyjan@users.noreply.github.com>2020-02-18 13:28:23 +0100
commit6a4eda715f59106530f5f6078ff2c93e49079ac6 (patch)
treeed0fcd48ac8e7e562e4befe845116848a04037fe /plugins/base/src
parent4dafa915b87f6cc0dc9d47029d61563ed1977c67 (diff)
downloaddokka-6a4eda715f59106530f5f6078ff2c93e49079ac6.tar.gz
dokka-6a4eda715f59106530f5f6078ff2c93e49079ac6.tar.bz2
dokka-6a4eda715f59106530f5f6078ff2c93e49079ac6.zip
Translators moved to separate packages
also typo fixed and unnecessary dependencies removed
Diffstat (limited to 'plugins/base/src')
-rw-r--r--plugins/base/src/main/kotlin/DokkaBase.kt8
-rw-r--r--plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt2
-rw-r--r--plugins/base/src/main/kotlin/transformers/pages/merger/PageNodeMerger.kt2
-rw-r--r--plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentationTranslator.kt (renamed from plugins/base/src/main/kotlin/transformers/descriptors/DefaultDescriptorToDocumentationTranslator.kt)5
-rw-r--r--plugins/base/src/main/kotlin/translators/documentables/DefaultDocumentablesToPageTranslator.kt (renamed from plugins/base/src/main/kotlin/transformers/documentables/DefaultDocumentablesToPageTranslator.kt)4
-rw-r--r--plugins/base/src/main/kotlin/translators/documentables/PageBuilder.kt (renamed from plugins/base/src/main/kotlin/transformers/documentables/PageBuilder.kt)2
-rw-r--r--plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt (renamed from plugins/base/src/main/kotlin/transformers/documentables/PageContentBuilder.kt)2
7 files changed, 10 insertions, 15 deletions
diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
index fd842dc0..e7cd61a8 100644
--- a/plugins/base/src/main/kotlin/DokkaBase.kt
+++ b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -6,9 +6,8 @@ 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.transformers.descriptors.DefaultDescriptorToDocumentationTranslator
import org.jetbrains.dokka.base.transformers.documentables.DefaultDocumentableMerger
-import org.jetbrains.dokka.base.transformers.documentables.DefaultDocumentablesToPageTranslator
+import org.jetbrains.dokka.base.translators.documentables.DefaultDocumentablesToPageTranslator
import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConverter
import org.jetbrains.dokka.base.transformers.pages.merger.FallbackPageMergerStrategy
@@ -16,12 +15,13 @@ import org.jetbrains.dokka.base.transformers.pages.merger.PageMergerStrategy
import org.jetbrains.dokka.base.transformers.pages.merger.PageNodeMerger
import org.jetbrains.dokka.base.transformers.pages.merger.SameMethodNamePageMergerStrategy
import org.jetbrains.dokka.base.transformers.psi.DefaultPsiToDocumentationTranslator
+import org.jetbrains.dokka.base.translators.descriptors.DefaultDescriptorToDocumentationTranslator
import org.jetbrains.dokka.plugability.DokkaPlugin
class DokkaBase : DokkaPlugin() {
val pageMergerStrategy by extensionPoint<PageMergerStrategy>()
val commentsToContentConverter by extensionPoint<CommentsToContentConverter>()
- val locationproviderFactory by extensionPoint<LocationProviderFactory>()
+ val locationProviderFactory by extensionPoint<LocationProviderFactory>()
val outputWriter by extensionPoint<OutputWriter>()
val descriptorToDocumentationTranslator by extending(isFallback = true) {
@@ -65,7 +65,7 @@ class DokkaBase : DokkaPlugin() {
}
val locationProvider by extending(isFallback = true) {
- locationproviderFactory providing ::DefaultLocationProviderFactory
+ locationProviderFactory providing ::DefaultLocationProviderFactory
}
val fileWriter by extending(isFallback = true) {
diff --git a/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt b/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt
index 951545d2..75034bda 100644
--- a/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt
+++ b/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt
@@ -117,7 +117,7 @@ abstract class DefaultRenderer<T>(
val newRoot = preprocessors.fold(root) { acc, t -> t(acc) }
locationProvider =
- context.plugin<DokkaBase>().querySingle { locationproviderFactory }.getLocationProvider(newRoot)
+ context.plugin<DokkaBase>().querySingle { locationProviderFactory }.getLocationProvider(newRoot)
root.children<ModulePageNode>().forEach { renderPackageList(it) }
diff --git a/plugins/base/src/main/kotlin/transformers/pages/merger/PageNodeMerger.kt b/plugins/base/src/main/kotlin/transformers/pages/merger/PageNodeMerger.kt
index 5ecf8d9b..96cd126c 100644
--- a/plugins/base/src/main/kotlin/transformers/pages/merger/PageNodeMerger.kt
+++ b/plugins/base/src/main/kotlin/transformers/pages/merger/PageNodeMerger.kt
@@ -25,5 +25,5 @@ private fun <T> Iterable<T>.assertSingle(path: List<String>): T = try {
single()
} catch (e: Exception) {
val renderedPath = path.joinToString(separator = "/")
- throw IllegalStateException("Page merger is missconfigured. Error for $renderedPath: ${e.message}")
+ throw IllegalStateException("Page merger is misconfigured. Error for $renderedPath: ${e.message}")
} \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/transformers/descriptors/DefaultDescriptorToDocumentationTranslator.kt b/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentationTranslator.kt
index 1358cef1..bb572034 100644
--- a/plugins/base/src/main/kotlin/transformers/descriptors/DefaultDescriptorToDocumentationTranslator.kt
+++ b/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentationTranslator.kt
@@ -1,11 +1,10 @@
-package org.jetbrains.dokka.base.transformers.descriptors
+package org.jetbrains.dokka.base.translators.descriptors
import org.jetbrains.dokka.analysis.DokkaResolutionFacade
import org.jetbrains.dokka.links.Callable
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.links.withClass
import org.jetbrains.dokka.model.*
-import org.jetbrains.dokka.model.ClassKind
import org.jetbrains.dokka.model.Enum
import org.jetbrains.dokka.model.Function
import org.jetbrains.dokka.model.Property
@@ -17,12 +16,10 @@ import org.jetbrains.dokka.transformers.descriptors.DescriptorToDocumentationTra
import org.jetbrains.kotlin.descriptors.*
import org.jetbrains.kotlin.descriptors.impl.DeclarationDescriptorVisitorEmptyBodies
import org.jetbrains.kotlin.idea.kdoc.findKDoc
-import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameSafe
import org.jetbrains.kotlin.resolve.descriptorUtil.getAllSuperclassesWithoutAny
import org.jetbrains.kotlin.resolve.descriptorUtil.getSuperInterfaces
import org.jetbrains.kotlin.resolve.scopes.DescriptorKindFilter
import org.jetbrains.kotlin.resolve.scopes.MemberScope
-import org.jetbrains.kotlin.types.KotlinType
import kotlin.reflect.KClass
class DefaultDescriptorToDocumentationTranslator(
diff --git a/plugins/base/src/main/kotlin/transformers/documentables/DefaultDocumentablesToPageTranslator.kt b/plugins/base/src/main/kotlin/translators/documentables/DefaultDocumentablesToPageTranslator.kt
index d28791ab..ee3ae995 100644
--- a/plugins/base/src/main/kotlin/transformers/documentables/DefaultDocumentablesToPageTranslator.kt
+++ b/plugins/base/src/main/kotlin/translators/documentables/DefaultDocumentablesToPageTranslator.kt
@@ -1,10 +1,8 @@
-package org.jetbrains.dokka.base.transformers.documentables
+package org.jetbrains.dokka.base.translators.documentables
-import org.jetbrains.dokka.CoreExtensions
import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
import org.jetbrains.dokka.model.Module
import org.jetbrains.dokka.pages.ModulePageNode
-import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.transformers.documentation.DocumentablesToPageTranslator
import org.jetbrains.dokka.utilities.DokkaLogger
diff --git a/plugins/base/src/main/kotlin/transformers/documentables/PageBuilder.kt b/plugins/base/src/main/kotlin/translators/documentables/PageBuilder.kt
index 29f39c73..82419a77 100644
--- a/plugins/base/src/main/kotlin/transformers/documentables/PageBuilder.kt
+++ b/plugins/base/src/main/kotlin/translators/documentables/PageBuilder.kt
@@ -1,4 +1,4 @@
-package org.jetbrains.dokka.base.transformers.documentables
+package org.jetbrains.dokka.base.translators.documentables
import org.jetbrains.dokka.model.*
import org.jetbrains.dokka.model.Enum
diff --git a/plugins/base/src/main/kotlin/transformers/documentables/PageContentBuilder.kt b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
index 6ce883b1..48456910 100644
--- a/plugins/base/src/main/kotlin/transformers/documentables/PageContentBuilder.kt
+++ b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
@@ -1,4 +1,4 @@
-package org.jetbrains.dokka.base.transformers.documentables
+package org.jetbrains.dokka.base.translators.documentables
import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
import org.jetbrains.dokka.links.DRI