aboutsummaryrefslogtreecommitdiff
path: root/core/src
diff options
context:
space:
mode:
authorSimon Ogorodnik <Simon.Ogorodnik@jetbrains.com>2017-12-05 18:25:08 +0300
committerSimon Ogorodnik <Simon.Ogorodnik@jetbrains.com>2017-12-05 18:25:08 +0300
commit214e16e07d93b3565c433ed67b78796e80f43ec5 (patch)
tree6b350d92958cdeaf3e25479f95e8ce8d33e075e0 /core/src
parent955a4f706c54a271473424c817daaeb02bea5cc5 (diff)
downloaddokka-214e16e07d93b3565c433ed67b78796e80f43ec5.tar.gz
dokka-214e16e07d93b3565c433ed67b78796e80f43ec5.tar.bz2
dokka-214e16e07d93b3565c433ed67b78796e80f43ec5.zip
Tidy around
Diffstat (limited to 'core/src')
-rw-r--r--core/src/main/kotlin/Formats/StandardFormats.kt4
-rw-r--r--core/src/main/kotlin/Locations/FoldersLocationService.kt20
-rw-r--r--core/src/main/kotlin/Locations/Location.kt (renamed from core/src/main/kotlin/Locations/LocationService.kt)45
-rw-r--r--core/src/main/kotlin/Locations/SingleFolderLocationService.kt20
-rw-r--r--core/src/main/kotlin/Utilities/DokkaModules.kt2
5 files changed, 0 insertions, 91 deletions
diff --git a/core/src/main/kotlin/Formats/StandardFormats.kt b/core/src/main/kotlin/Formats/StandardFormats.kt
index 71af1991..dd67ac97 100644
--- a/core/src/main/kotlin/Formats/StandardFormats.kt
+++ b/core/src/main/kotlin/Formats/StandardFormats.kt
@@ -47,10 +47,6 @@ class KotlinWebsiteHtmlFormatDescriptor : KotlinFormatDescriptorBase() {
override val sampleProcessingService = KotlinWebsiteSampleProcessingService::class
override val outlineServiceClass = YamlOutlineService::class
- override fun configureAnalysis(binder: Binder) {
- super.configureAnalysis(binder)
- }
-
override fun configureOutput(binder: Binder) = with(binder) {
super.configureOutput(binder)
bind<HtmlTemplateService>().toInstance(EmptyHtmlTemplateService)
diff --git a/core/src/main/kotlin/Locations/FoldersLocationService.kt b/core/src/main/kotlin/Locations/FoldersLocationService.kt
deleted file mode 100644
index ae5301e7..00000000
--- a/core/src/main/kotlin/Locations/FoldersLocationService.kt
+++ /dev/null
@@ -1,20 +0,0 @@
-package org.jetbrains.dokka
-
-import com.google.inject.Inject
-import com.google.inject.name.Named
-import java.io.File
-//
-//class FoldersLocationService @Inject constructor(@Named("outputDir") val rootFile: File, val extension: String) : FileLocationService {
-// constructor(root: String): this(File(root), "")
-//
-// override val root: Location
-// get() = FileLocation(rootFile)
-//
-// override fun withExtension(newExtension: String): FileLocationService {
-// return if (extension.isEmpty()) FoldersLocationService(rootFile, newExtension) else this
-// }
-//
-// override fun location(qualifiedName: List<String>, hasMembers: Boolean): FileLocation {
-// return FileLocation(File(rootFile, relativePathToNode(qualifiedName, hasMembers)).appendExtension(extension))
-// }
-//}
diff --git a/core/src/main/kotlin/Locations/LocationService.kt b/core/src/main/kotlin/Locations/Location.kt
index e453baca..17538ff5 100644
--- a/core/src/main/kotlin/Locations/LocationService.kt
+++ b/core/src/main/kotlin/Locations/Location.kt
@@ -10,8 +10,6 @@ interface Location {
/**
* Represents locations in the documentation in the form of [path](File).
*
- * Locations are provided by [LocationService.location] function.
- *
* $file: [File] for this location
* $path: [String] representing path of this location
*/
@@ -33,7 +31,6 @@ data class FileLocation(val file: File): Location {
}
-
fun relativePathToNode(qualifiedName: List<String>, hasMembers: Boolean): String {
val parts = qualifiedName.map { identifierToFilename(it) }.filterNot { it.isEmpty() }
return if (!hasMembers) {
@@ -46,58 +43,16 @@ fun relativePathToNode(qualifiedName: List<String>, hasMembers: Boolean): String
fun relativePathToNode(node: DocumentationNode) = relativePathToNode(node.path.map { it.name }, node.members.any())
-
-//
-///**
-// * Provides means of retrieving locations for [DocumentationNode](documentation nodes)
-// *
-// * `LocationService` determines where documentation for particular node should be generated
-// *
-// * * [FoldersLocationService] – represent packages and types as folders, members as files in those folders.
-// * * [SingleFolderLocationService] – all documentation is generated into single folder using fully qualified names
-// * for file names.
-// */
-//interface LocationService {
-// fun withExtension(newExtension: String) = this
-//
-// fun location(node: DocumentationNode): Location = location(node.path.map { it.name }, node.members.any())
-//
-// /**
-// * Calculates a location corresponding to the specified [qualifiedName].
-// * @param hasMembers if true, the node for which the location is calculated has member nodes.
-// */
-// fun location(qualifiedName: List<String>, hasMembers: Boolean): Location
-//
-// val root: Location
-//}
-//
-//
-//interface FileLocationService: LocationService {
-// override fun withExtension(newExtension: String): FileLocationService = this
-//
-// override fun location(node: DocumentationNode): FileLocation = location(node.path.map { it.name }, node.members.any())
-// override fun location(qualifiedName: List<String>, hasMembers: Boolean): FileLocation
-//}
-
fun identifierToFilename(path: String): String {
val escaped = path.replace('<', '-').replace('>', '-')
val lowercase = escaped.replace("[A-Z]".toRegex()) { matchResult -> "-" + matchResult.value.toLowerCase() }
return if (lowercase == "index") "--index--" else lowercase
}
-///**
-// * Returns relative location between two nodes. Used for relative links in documentation.
-// */
-//fun LocationService.relativePathToLocation(owner: DocumentationNode, node: DocumentationNode): String {
-// return location(owner).relativePathTo(location(node), null)
-//}
-
-
fun NodeLocationAwareGenerator.relativePathToLocation(owner: DocumentationNode, node: DocumentationNode): String {
return location(owner).relativePathTo(location(node), null)
}
-
fun NodeLocationAwareGenerator.relativeToRoot(from: Location): File {
val file = File(from.path)
return file.relativeTo(root)
diff --git a/core/src/main/kotlin/Locations/SingleFolderLocationService.kt b/core/src/main/kotlin/Locations/SingleFolderLocationService.kt
deleted file mode 100644
index 25cf6f8e..00000000
--- a/core/src/main/kotlin/Locations/SingleFolderLocationService.kt
+++ /dev/null
@@ -1,20 +0,0 @@
-package org.jetbrains.dokka
-
-import com.google.inject.Inject
-import com.google.inject.name.Named
-import java.io.File
-//
-//class SingleFolderLocationService @Inject constructor(@Named("outputDir") val rootFile: File, val extension: String) : FileLocationService {
-// constructor(root: String): this(File(root), "")
-//
-// override fun withExtension(newExtension: String): FileLocationService =
-// SingleFolderLocationService(rootFile, newExtension)
-//
-// override fun location(qualifiedName: List<String>, hasMembers: Boolean): FileLocation {
-// val filename = qualifiedName.map { identifierToFilename(it) }.joinToString("-")
-// return FileLocation(File(rootFile, filename).appendExtension(extension))
-// }
-//
-// override val root: Location
-// get() = FileLocation(rootFile)
-//} \ No newline at end of file
diff --git a/core/src/main/kotlin/Utilities/DokkaModules.kt b/core/src/main/kotlin/Utilities/DokkaModules.kt
index fcc2f692..6b5e153e 100644
--- a/core/src/main/kotlin/Utilities/DokkaModules.kt
+++ b/core/src/main/kotlin/Utilities/DokkaModules.kt
@@ -24,8 +24,6 @@ class DokkaAnalysisModule(val environment: AnalysisEnvironment,
override fun configure(binder: Binder) {
binder.bind<DokkaLogger>().toInstance(logger)
- binder.registerCategory<LanguageService>("language")
-
val coreEnvironment = environment.createCoreEnvironment()
binder.bind<KotlinCoreEnvironment>().toInstance(coreEnvironment)