From 649287b689f52a117cc7bdf7725817d4575e441f Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Fri, 20 Mar 2015 16:07:21 +0100 Subject: [PATCH] remove KDoc support in Kotlin Gradle plugin --- .../tools/kotlin-gradle-plugin-core/pom.xml | 5 -- .../jetbrains/kotlin/gradle/tasks/Tasks.kt | 63 ------------------- libraries/tools/kotlin-gradle-plugin/pom.xml | 6 -- .../kotlin/gradle/plugin/KotlinPlugin.kt | 18 ------ .../kotlin/gradle/tasks/TasksProvider.kt | 7 --- .../gradle/BasicKotlinGradlePluginIT.kt | 8 --- .../testProject/kdocProject/build.gradle | 40 ------------ .../com/google/common/base/annotations.xml | 11 ---- .../kdocProject/src/main/kotlin/helloWorld.kt | 15 ----- 9 files changed, 173 deletions(-) delete mode 100644 libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/build.gradle delete mode 100644 libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/externalAnnotations/com/google/common/base/annotations.xml delete mode 100644 libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/src/main/kotlin/helloWorld.kt diff --git a/libraries/tools/kotlin-gradle-plugin-core/pom.xml b/libraries/tools/kotlin-gradle-plugin-core/pom.xml index feab21cc14c..8636d5d7c2a 100644 --- a/libraries/tools/kotlin-gradle-plugin-core/pom.xml +++ b/libraries/tools/kotlin-gradle-plugin-core/pom.xml @@ -52,11 +52,6 @@ kotlin-jdk-annotations ${project.version} - - org.jetbrains.kotlin - kdoc - ${project.version} - org.jetbrains.kotlin kotlin-stdlib diff --git a/libraries/tools/kotlin-gradle-plugin-core/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/Tasks.kt b/libraries/tools/kotlin-gradle-plugin-core/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/Tasks.kt index 7808697de49..f4216a08c85 100644 --- a/libraries/tools/kotlin-gradle-plugin-core/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/Tasks.kt +++ b/libraries/tools/kotlin-gradle-plugin-core/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/Tasks.kt @@ -284,69 +284,6 @@ public open class Kotlin2JsCompile() : AbstractKotlinCompile throw GradleException("Failed to generate kdoc. See log for more details") - ExitCode.INTERNAL_ERROR -> throw GradleException("Internal generation error. See log for more details") - } - - } -} - private fun ExtraPropertiesExtension.getOrNull(id: String): T? { try { @suppress("UNCHECKED_CAST") diff --git a/libraries/tools/kotlin-gradle-plugin/pom.xml b/libraries/tools/kotlin-gradle-plugin/pom.xml index 35b74e84c00..9252c989dd8 100644 --- a/libraries/tools/kotlin-gradle-plugin/pom.xml +++ b/libraries/tools/kotlin-gradle-plugin/pom.xml @@ -37,12 +37,6 @@ 2.2 provided - - org.jetbrains.kotlin - kdoc - ${project.version} - test - org.jetbrains.kotlin kotlin-gradle-plugin-core diff --git a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPlugin.kt b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPlugin.kt index bc462afbd93..5d3f5da4ba1 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPlugin.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPlugin.kt @@ -247,7 +247,6 @@ abstract class AbstractKotlinPlugin @Inject constructor(val scriptHandler: Scrip project.getPlugins().apply(javaClass()) configureSourceSetDefaults(project as ProjectInternal, javaBasePlugin, javaPluginConvention) - configureKDoc(project, javaPluginConvention) val gradleUtils = GradleUtils(scriptHandler, project) project.getExtensions().add(DEFAULT_ANNOTATIONS, gradleUtils.resolveKotlinPluginDependency("kotlin-jdk-annotations")) @@ -262,23 +261,6 @@ abstract class AbstractKotlinPlugin @Inject constructor(val scriptHandler: Scrip } }) } - - open protected fun configureKDoc(project: Project, javaPluginConvention: JavaPluginConvention) { - val mainSourceSet = javaPluginConvention.getSourceSets()?.findByName(SourceSet.MAIN_SOURCE_SET_NAME) as HasConvention? - - if (mainSourceSet != null) { - - val kdoc = tasksProvider.createKDocTask(project, KDOC_TASK_NAME) - - kdoc.setDescription("Generates KDoc API documentation for the main source code.") - kdoc.setGroup(JavaBasePlugin.DOCUMENTATION_GROUP) - kdoc.setSource(mainSourceSet.getConvention().getExtensionsAsDynamicObject().getProperty("kotlin")) - } - - project.getTasks().withType(tasksProvider.kDocTaskClass) { it!!.setProperty("destinationDir", File(javaPluginConvention.getDocsDir(), "kdoc")) } - } - - public val KDOC_TASK_NAME: String = "kdoc" } diff --git a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/TasksProvider.kt b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/TasksProvider.kt index 26aeff3dbc1..a739f60ec0c 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/TasksProvider.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/TasksProvider.kt @@ -19,9 +19,6 @@ public open class KotlinTasksProvider(val tasksLoader: ClassLoader) { val kotlinJSCompileTaskClass: Class = tasksLoader.loadClass("org.jetbrains.kotlin.gradle.tasks.Kotlin2JsCompile") as Class - val kDocTaskClass: Class = - tasksLoader.loadClass("org.jetbrains.kotlin.gradle.tasks.KDoc") as Class - val kotlinJVMOptionsClass: Class = tasksLoader.loadClass("org.jetbrains.kotlin.cli.common.arguments.K2JVMCompilerArguments") as Class @@ -33,8 +30,4 @@ public open class KotlinTasksProvider(val tasksLoader: ClassLoader) { public fun createKotlinJSTask(project: Project, name: String): AbstractCompile { return project.getTasks().create(name, kotlinJSCompileTaskClass) } - - public fun createKDocTask(project: Project, name: String): SourceTask { - return project.getTasks().create(name, kDocTaskClass) - } } diff --git a/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/BasicKotlinGradlePluginIT.kt b/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/BasicKotlinGradlePluginIT.kt index 02855e22d77..f4eba9f4a71 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/BasicKotlinGradlePluginIT.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/BasicKotlinGradlePluginIT.kt @@ -66,14 +66,6 @@ class SimpleKotlinGradleIT : BaseGradleIT() { } } - Test fun testSimpleKDoc() { - Project("kdocProject", "1.6").build("kdoc") { - assertSuccessful() - assertReportExists("build/docs/kdoc/demo/MyClass.html") - assertContains(":kdoc", "Generating kdoc to") - } - } - Test fun testKotlinExtraJavaSrc() { Project("additionalJavaSrc", "1.6").build("build") { assertSuccessful() diff --git a/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/build.gradle b/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/build.gradle deleted file mode 100644 index a5193474c83..00000000000 --- a/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/build.gradle +++ /dev/null @@ -1,40 +0,0 @@ -buildscript { - repositories { - mavenCentral() - maven { - url 'file://' + pathToKotlinPlugin - } - } - dependencies { - classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:0.1-SNAPSHOT' - } -} - - - -apply plugin: "kotlin" - -repositories { - maven { - url 'file://' + pathToKotlinPlugin - } - mavenCentral() -} - -dependencies { - testCompile 'org.testng:testng:6.8' - compile 'org.jetbrains.kotlin:kotlin-stdlib:0.1-SNAPSHOT' -} - -test { - useTestNG() -} - -compileKotlin { - kotlinOptions.annotations = "externalAnnotations" -} - - -task wrapper(type: Wrapper) { - gradleVersion="1.4" -} \ No newline at end of file diff --git a/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/externalAnnotations/com/google/common/base/annotations.xml b/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/externalAnnotations/com/google/common/base/annotations.xml deleted file mode 100644 index fd541a7e6e5..00000000000 --- a/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/externalAnnotations/com/google/common/base/annotations.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/src/main/kotlin/helloWorld.kt b/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/src/main/kotlin/helloWorld.kt deleted file mode 100644 index a844b9fe15d..00000000000 --- a/libraries/tools/kotlin-gradle-plugin/src/test/resources/testProject/kdocProject/src/main/kotlin/helloWorld.kt +++ /dev/null @@ -1,15 +0,0 @@ -package demo - -/** - * This is **bold** - * - * New paragraph using newlines. - * - * We can also support wiki links notation - * for example [[List]] and [[Collection]] and [[java.util.Collection.size()]] will - * generate hypertext links to classes - */ -public class MyClass() { - val i: Int = 0 -} -