Merge pull request #580 from Kotlin/docProcessor-0.3.0

Doc processor 0.3.2

Author: Jolanrensen

build.gradle.kts

@@ -166,7 +166,7 @@ kotlinPublications {
 
     localRepositories {
         maven {
-            url = project.file(File(buildDir, "maven")).toURI()
+            url = project.file(layout.buildDirectory.dir("maven")).toURI()
         }
     }
 }

core/build.gradle.kts

@@ -85,7 +85,7 @@ val compileSamplesKotlin = tasks.named<KotlinCompile>("compileSamplesKotlin") {
         libraries.from(it.libraries)
     }
     source(sourceSets["test"].kotlin)
-    destinationDirectory.set(file("$buildDir/classes/testWithOutputs/kotlin"))
+    destinationDirectory.set(layout.buildDirectory.dir("classes/testWithOutputs/kotlin"))
 }
 
 tasks.withType<KspTask> {
@@ -101,8 +101,8 @@ tasks.named("lintKotlinSamples") {
 }
 
 val clearTestResults by tasks.creating(Delete::class) {
-    delete(File(buildDir, "dataframes"))
-    delete(File(buildDir, "korroOutputLines"))
+    delete(layout.buildDirectory.dir("dataframes"))
+    delete(layout.buildDirectory.dir("korroOutputLines"))
 }
 
 val samplesTest = tasks.register<Test>("samplesTest") {
@@ -121,8 +121,8 @@ val samplesTest = tasks.register<Test>("samplesTest") {
 
     ignoreFailures = true
 
-    testClassesDirs = fileTree("$buildDir/classes/testWithOutputs/kotlin")
-    classpath = files("$buildDir/classes/testWithOutputs/kotlin") + configurations["samplesRuntimeClasspath"] + sourceSets["main"].runtimeClasspath
+    testClassesDirs = fileTree("${layout.buildDirectory.get().asFile.path}/classes/testWithOutputs/kotlin")
+    classpath = files("${layout.buildDirectory.get().asFile.path}/classes/testWithOutputs/kotlin") + configurations["samplesRuntimeClasspath"] + sourceSets["main"].runtimeClasspath
 }
 
 val clearSamplesOutputs by tasks.creating {
@@ -199,15 +199,6 @@ val processKDocsMain by creatingProcessDocTask(
         .filterNot { pathOf("build", "generated") in it.path }, // Exclude generated sources
 ) {
     target = file(generatedSourcesFolderName)
-    processors = listOf(
-        INCLUDE_DOC_PROCESSOR,
-        INCLUDE_FILE_DOC_PROCESSOR,
-        ARG_DOC_PROCESSOR,
-        COMMENT_DOC_PROCESSOR,
-        SAMPLE_DOC_PROCESSOR,
-//        REMOVE_ESCAPE_CHARS_PROCESSOR, TODO enable when doc preprocessor hits 0.3.0
-    )
-
     arguments += ARG_DOC_PROCESSOR_LOG_NOT_FOUND to false
 
     task {
@@ -276,7 +267,7 @@ korro {
         include("src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/*.kt")
     }
 
-    outputs = fileTree(project.buildDir) {
+    outputs = fileTree(project.layout.buildDirectory) {
         include("korroOutputLines/*")
     }
 

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/JsonPath.kt

@@ -5,7 +5,7 @@ import java.io.Serializable
 
 /**
  * Simplistic JSON path implementation.
- * Supports just keys (in bracket notation), double quotes, arrays and wildcards.
+ * Supports just keys (in bracket notation), double quotes, arrays, and wildcards.
  *
  * Examples:
  * `$["store"]["book"][*]["author"]`

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/TypeConversions.kt

@@ -154,10 +154,10 @@ public fun <T> ColumnGroup<T>.asDataFrame(): DataFrame<T> = this
 /**
  * ## As ColumnGroup
  *
- * Creates a [ColumnAccessor][ColumnAccessor]`<`[DataRow][DataRow]`<`[C][C\]`>>` from [this][this\].
+ * Creates a [ColumnAccessor][ColumnAccessor]`<`[DataRow][DataRow]`<`[C][C]`>>` from [this][this].
  * This is especially useful when you want to use [ColumnGroup] functions in the [ColumnsSelectionDsl] but your column
  * type is not recognized as a [ColumnGroup].
- * If you're not sure whether a column is recognized as [ColumnGroup] or not, you can always call [asColumnGroup][asColumnGroup\]
+ * If you're not sure whether a column is recognized as [ColumnGroup] or not, you can always call [asColumnGroup][asColumnGroup]
  * and it will return the same type if it is already a [ColumnGroup].
  *
  * NOTE: This does not check whether the column is actually a [ColumnGroup] or not. It just casts it.
@@ -166,9 +166,9 @@ public fun <T> ColumnGroup<T>.asDataFrame(): DataFrame<T> = this
  *
  * `df.`[select][DataFrame.select]` { `[first][ColumnsSelectionDsl.first]`().`[asColumnGroup][SingleColumn.asColumnGroup]`().`[firstCol][ColumnsSelectionDsl.firstCol]`() }`
  *
- * @receiver The column reference to cast to a [SingleColumn]`<`[DataRow][DataRow]`<`[C][C\]`>>`.
- * @param [C\] The type of the (group) column.
- * @return A [SingleColumn]`<`[DataRow][DataRow]`<`[C][C\]`>>`.
+ * @receiver The column reference to cast to a [SingleColumn]`<`[DataRow][DataRow]`<`[C][C]`>>`.
+ * @param [C] The type of the (group) column.
+ * @return A [SingleColumn]`<`[DataRow][DataRow]`<`[C][C]`>>`.
  */
 private interface SingleColumnAsColumnGroupDocs
 
@@ -280,7 +280,7 @@ public enum class Infer {
     Type;
 
     /**
-     * @param [infer\] [An enum][Infer] that indicates how [DataColumn.type] should be calculated.
+     * @param [infer] [An enum][Infer] that indicates how [DataColumn.type] should be calculated.
      * Either [None], [Nulls], or [Type].
      */
     internal interface ParamDoc