aboutsummaryrefslogtreecommitdiff
path: root/dokka-gradle-plugin
diff options
context:
space:
mode:
Diffstat (limited to 'dokka-gradle-plugin')
-rw-r--r--dokka-gradle-plugin/build.gradle68
-rw-r--r--dokka-gradle-plugin/settings.gradle2
-rw-r--r--dokka-gradle-plugin/src/main/kotlin/logger.kt18
-rw-r--r--dokka-gradle-plugin/src/main/kotlin/main.kt190
-rw-r--r--dokka-gradle-plugin/src/main/resources/META-INF/gradle-plugins/org.jetbrains.dokka.properties1
5 files changed, 0 insertions, 279 deletions
diff --git a/dokka-gradle-plugin/build.gradle b/dokka-gradle-plugin/build.gradle
deleted file mode 100644
index 76bf4e4d..00000000
--- a/dokka-gradle-plugin/build.gradle
+++ /dev/null
@@ -1,68 +0,0 @@
-group 'org.jetbrains.dokka'
-version dokka_version
-
-buildscript {
- dependencies {
- classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
- classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.4'
- }
-}
-
-apply plugin: 'java'
-apply plugin: 'kotlin'
-apply plugin: 'maven-publish'
-apply plugin: 'com.jfrog.bintray'
-
-sourceCompatibility = 1.6
-
-dependencies {
- testCompile group: 'junit', name: 'junit', version: '4.12'
- compile project(':core')
-
- compile gradleApi()
- compile localGroovy()
-}
-
-sourceSets {
- main.java.srcDirs += 'src/main/kotlin'
-}
-
-task sourceJar(type: Jar) {
- from sourceSets.main.allSource
-}
-
-task wrapper(type: Wrapper) {
- gradleVersion = '2.5'
- distributionUrl = "https://services.gradle.org/distributions/gradle-$gradleVersion-all.zip"
-}
-
-publishing {
- publications {
- mavenJava(MavenPublication) {
- from components.java
-
- artifact sourceJar {
- classifier "sources"
- }
- }
- }
-}
-
-bintray {
- user = System.getenv('BINTRAY_USER')
- key = System.getenv('BINTRAY_KEY')
-
- pkg {
- repo = dokka_eap.toBoolean() ? 'kotlin-eap' : 'dokka'
- name = 'dokka'
- userOrg = 'kotlin'
- desc = 'Dokka, the Kotlin documentation tool'
- vcsUrl = 'https://github.com/kotlin/dokka.git'
- licenses = ['Apache-2.0']
- version {
- name = dokka_version
- }
- }
-
- publications = ['mavenJava']
-}
diff --git a/dokka-gradle-plugin/settings.gradle b/dokka-gradle-plugin/settings.gradle
deleted file mode 100644
index 1faee6f7..00000000
--- a/dokka-gradle-plugin/settings.gradle
+++ /dev/null
@@ -1,2 +0,0 @@
-rootProject.name = 'dokka-gradle-plugin'
-
diff --git a/dokka-gradle-plugin/src/main/kotlin/logger.kt b/dokka-gradle-plugin/src/main/kotlin/logger.kt
deleted file mode 100644
index 715c1f04..00000000
--- a/dokka-gradle-plugin/src/main/kotlin/logger.kt
+++ /dev/null
@@ -1,18 +0,0 @@
-package org.jetbrains.dokka.gradle
-
-import org.gradle.api.logging.Logger
-import org.jetbrains.dokka.DokkaLogger
-
-class DokkaGradleLogger(val logger: Logger) : DokkaLogger {
- override fun error(message: String) {
- logger.error(message)
- }
-
- override fun info(message: String) {
- logger.info(message)
- }
-
- override fun warn(message: String) {
- logger.warn(message)
- }
-} \ No newline at end of file
diff --git a/dokka-gradle-plugin/src/main/kotlin/main.kt b/dokka-gradle-plugin/src/main/kotlin/main.kt
deleted file mode 100644
index 49c3b8ba..00000000
--- a/dokka-gradle-plugin/src/main/kotlin/main.kt
+++ /dev/null
@@ -1,190 +0,0 @@
-package org.jetbrains.dokka.gradle
-
-import groovy.lang.Closure
-import org.gradle.api.DefaultTask
-import org.gradle.api.Plugin
-import org.gradle.api.Project
-import org.gradle.api.file.FileCollection
-import org.gradle.api.plugins.JavaBasePlugin
-import org.gradle.api.plugins.JavaPluginConvention
-import org.gradle.api.tasks.*
-import org.jetbrains.dokka.DocumentationOptions
-import org.jetbrains.dokka.DokkaGenerator
-import org.jetbrains.dokka.SourceLinkDefinition
-import java.io.File
-import java.io.Serializable
-import java.util.*
-
-open class DokkaPlugin : Plugin<Project> {
- override fun apply(project: Project) {
- project.tasks.create("dokka", DokkaTask::class.java).apply {
- moduleName = project.name
- outputDirectory = File(project.buildDir, "dokka").absolutePath
- }
- }
-}
-
-open class DokkaTask : DefaultTask() {
- init {
- group = JavaBasePlugin.DOCUMENTATION_GROUP
- description = "Generates dokka documentation for Kotlin"
- }
-
- @Input
- var moduleName: String = ""
- @Input
- var outputFormat: String = "html"
- var outputDirectory: String = ""
- @Input
- var processConfigurations: List<Any?> = arrayListOf("compile")
- @Input
- var includes: List<Any?> = arrayListOf()
- @Input
- var linkMappings: ArrayList<LinkMapping> = arrayListOf()
- @Input
- var samples: List<Any?> = arrayListOf()
- @Input
- var jdkVersion: Int = 6
- @Input
- var sourceDirs: Iterable<File> = emptyList()
-
- protected open val sdkProvider: SdkProvider? = null
-
- fun linkMapping(closure: Closure<Any?>) {
- val mapping = LinkMapping()
- closure.delegate = mapping
- closure.call()
-
- if (mapping.dir.isEmpty()) {
- throw IllegalArgumentException("Link mapping should have dir")
- }
- if (mapping.url.isEmpty()) {
- throw IllegalArgumentException("Link mapping should have url")
- }
-
- linkMappings.add(mapping)
- }
-
- @TaskAction
- fun generate() {
- val project = project
- val sdkProvider = sdkProvider
- val sourceDirectories = getSourceDirectories()
- val allConfigurations = project.configurations
-
- val classpath =
- if (sdkProvider != null && sdkProvider.isValid) sdkProvider.classpath else emptyList<File>() +
- processConfigurations
- .map { allConfigurations?.getByName(it.toString()) ?: throw IllegalArgumentException("No configuration $it found") }
- .flatMap { it }
-
- if (sourceDirectories.isEmpty()) {
- logger.warn("No source directories found: skipping dokka generation")
- return
- }
-
- DokkaGenerator(
- DokkaGradleLogger(logger),
- classpath.map { it.absolutePath },
- sourceDirectories.map { it.absolutePath },
- samples.filterNotNull().map { project.file(it).absolutePath },
- includes.filterNotNull().map { project.file(it).absolutePath },
- moduleName,
- DocumentationOptions(outputDirectory, outputFormat,
- sourceLinks = linkMappings.map { SourceLinkDefinition(project.file(it.dir).absolutePath, it.url, it.suffix) },
- jdkVersion = jdkVersion)
- ).generate()
- }
-
- fun getSourceDirectories(): Collection<File> {
- val provider = sdkProvider
- val sourceDirs = if (sourceDirs.any()) {
- logger.info("Dokka: Taking source directories provided by the user")
- sourceDirs.toSet()
- } else if (provider != null && provider.isValid) {
- logger.info("Dokka: Taking source directories from ${provider.name} sdk provider")
- provider.sourceDirs
- } else {
- logger.info("Dokka: Taking source directories from default java plugin")
- val javaPluginConvention = project.convention.getPlugin(JavaPluginConvention::class.java)
- val sourceSets = javaPluginConvention.sourceSets?.findByName(SourceSet.MAIN_SOURCE_SET_NAME)
- sourceSets?.allSource?.srcDirs
- }
-
- return sourceDirs?.filter { it.exists() } ?: emptyList()
- }
-
- @InputFiles
- @SkipWhenEmpty
- fun getInputFiles(): FileCollection =
- project.files(getSourceDirectories().map { project.fileTree(it) }) +
- project.files(includes) +
- project.files(samples.map { project.fileTree(it) })
-
- @OutputDirectory
- fun getOutputDirectoryAsFile(): File = project.file(outputDirectory)
-}
-
-open class LinkMapping : Serializable {
- var dir: String = ""
- var url: String = ""
- var suffix: String? = null
-
- override fun equals(other: Any?): Boolean {
- if (this === other) return true
- if (other?.javaClass != javaClass) return false
-
- other as LinkMapping
-
- if (dir != other.dir) return false
- if (url != other.url) return false
- if (suffix != other.suffix) return false
-
- return true
- }
-
- override fun hashCode(): Int {
- var result = dir.hashCode()
- result = 31 * result + url.hashCode()
- result = 31 * result + (suffix?.hashCode() ?: 0)
- return result
- }
-
- companion object {
- const val serialVersionUID: Long = -8133501684312445981L
- }
-}
-
-/**
- * A provider for SDKs that can be used if a project uses classes that live outside the JDK or uses a
- * different method to determine the source directories.
- *
- * For example an Android library project configures its sources through the Android extension instead
- * of the basic java convention. Also it has its custom classes located in the SDK installation directory.
- */
-interface SdkProvider {
- /**
- * The name of this provider. Only used for logging purposes.
- */
- val name: String
-
- /**
- * Checks whether this provider has everything it needs to provide the source directories.
- */
- val isValid: Boolean
-
- /**
- * Provides additional classpath files where Dokka should search for external classes.
- * The file list is injected **after** JDK Jars and **before** project dependencies.
- *
- * This is only called if [isValid] returns `true`.
- */
- val classpath: List<File>
-
- /**
- * Provides a list of directories where Dokka should search for source files.
- *
- * This is only called if [isValid] returns `true`.
- */
- val sourceDirs: Set<File>?
-}
diff --git a/dokka-gradle-plugin/src/main/resources/META-INF/gradle-plugins/org.jetbrains.dokka.properties b/dokka-gradle-plugin/src/main/resources/META-INF/gradle-plugins/org.jetbrains.dokka.properties
deleted file mode 100644
index b42cfe9f..00000000
--- a/dokka-gradle-plugin/src/main/resources/META-INF/gradle-plugins/org.jetbrains.dokka.properties
+++ /dev/null
@@ -1 +0,0 @@
-implementation-class=org.jetbrains.dokka.gradle.DokkaPlugin \ No newline at end of file