Merge pull request Kotlin#613 from Kotlin/kdoc-fixes

KDoc fixes for IntelliJ 2024.X
fb64 · Apr 16, 2024 · 8990376 · 8990376
2 parents 195a305 + 175773b
commit 8990376
Show file tree

Hide file tree

Showing 78 changed files with 5,456 additions and 7,602 deletions.
diff --git a/core/build.gradle.kts b/core/build.gradle.kts
@@ -185,7 +185,6 @@ val installGitPreCommitHook by tasks.creating(Copy::class) {
     } else {
         logger.lifecycle("'.git/hooks' directory not found. Skipping installation of pre-commit hook.")
     }
-
 }
 tasks.named("assemble") {
     dependsOn(installGitPreCommitHook)

diff --git a/...erated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt b/...erated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/Nulls.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/Nulls.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/all.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/all.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/allExcept.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/allExcept.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/and.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/and.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/col.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/col.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroup.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroup.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroups.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroups.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/cols.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/cols.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsAtAnyDepth.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsAtAnyDepth.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsInGroups.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsInGroups.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOf.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOf.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOfKind.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOfKind.kt
diff --git a/...enerated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnNameFilters.kt b/...enerated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnNameFilters.kt
diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnRange.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnRange.kt
@@ -7,6 +7,7 @@ import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
 import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
 import org.jetbrains.kotlinx.dataframe.documentation.AccessApiLink
 import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
+import org.jetbrains.kotlinx.dataframe.documentation.ExcludeFromSources
 import org.jetbrains.kotlinx.dataframe.impl.columns.addPath
 import org.jetbrains.kotlinx.dataframe.impl.columns.createColumnSet
 import kotlin.reflect.KProperty
@@ -30,10 +31,10 @@ public interface ColumnRangeColumnsSelectionDsl {
      * &nbsp;&nbsp;&nbsp;&nbsp;
      *
      *  ### Definitions:
-     *  `column: `[ColumnAccessor][org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor]` | `[String][String]
+     *  `column: `[`ColumnAccessor`][org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor]`  |  `[`String`][String]
      *
      * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-     * `| `[KProperty][kotlin.reflect.KProperty]`<*> | `[ColumnPath][org.jetbrains.kotlinx.dataframe.columns.ColumnPath]
+     * `| `[`KProperty`][kotlin.reflect.KProperty]`<*> | `[`ColumnPath`][org.jetbrains.kotlinx.dataframe.columns.ColumnPath]
      *
      * &nbsp;&nbsp;&nbsp;&nbsp;
      *
@@ -42,7 +43,7 @@ public interface ColumnRangeColumnsSelectionDsl {
      *  
      * &nbsp;&nbsp;&nbsp;&nbsp;
      *
-     *  [column][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef] [**..**][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.rangeTo] [column][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]
+     *  [`column`][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]` `[**`..`**][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.rangeTo]` `[`column`][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]
      *
      *
      *
@@ -61,51 +62,24 @@ public interface ColumnRangeColumnsSelectionDsl {
      */
     public interface Grammar {
 
-        /** [**..**][ColumnsSelectionDsl.rangeTo] */
+        /** [**`..`**][ColumnsSelectionDsl.rangeTo] */
         public interface PlainDslName
     }
 
-    /**
-     * ## Range of Columns
-     * Creates a [ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
-     *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
-     * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
-     *
-     * ### Check out: [Grammar]
-     *
-     * #### For example:
-     *
-     * `df.`[select][DataFrame.select]` { `` }`
-     *
-     * @param [endInclusive] The last column in the subset.
-     * @receiver The first column in the subset.
-     * @return A [ColumnSet] containing all columns from [this] to [endInclusive].
-     * @throws [IllegalArgumentException] if the columns have different parents or the end column is before the
-     *   start column.
-     * @see [ColumnsSelectionDsl.allBefore]
-     * @see [ColumnsSelectionDsl.allAfter]
-     * @see [ColumnsSelectionDsl.allFrom]
-     * @see [ColumnsSelectionDsl.allUpTo]
-     */
-    private interface CommonRangeOfColumnsDocs {
-
-        /** Examples key */
-        interface Example
-    }
+
 
     /**
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `"fromColumn"[`..`][String.rangeTo]"toColumn"` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`"fromColumn"`[`..`][String.rangeTo]`"toColumn"`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -125,14 +99,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `"fromColumn"[`..`][String.rangeTo]Type::toColumn` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`"fromColumn"`[`..`][String.rangeTo]`Type::toColumn`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -152,14 +126,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `"fromColumn"[`..`][String.rangeTo]toColumn` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`"fromColumn"`[`..`][String.rangeTo]`toColumn`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -179,14 +153,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `Type::fromColumn[`..`][KProperty.rangeTo]"toColumn"` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`Type::fromColumn`[`..`][KProperty.rangeTo]`"toColumn"`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -206,14 +180,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `Type::fromColumn[`..`][KProperty.rangeTo]Type::toColumn` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`Type::fromColumn`[`..`][KProperty.rangeTo]`Type::toColumn`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -233,14 +207,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `Type::fromColumn[`..`][KProperty.rangeTo]toColumn` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`Type::fromColumn`[`..`][KProperty.rangeTo]`toColumn`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -260,14 +234,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `fromColumn[`..`][ColumnReference.rangeTo]"toColumn"` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`fromColumn`[`..`][ColumnReference.rangeTo]`"toColumn"`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -287,14 +261,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `fromColumn[`..`][ColumnReference.rangeTo]Type::toColumn` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`fromColumn`[`..`][ColumnReference.rangeTo]`Type::toColumn`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.
@@ -314,14 +288,14 @@ public interface ColumnRangeColumnsSelectionDsl {
      * ## Range of Columns
      * Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
      *
-     * Columns inside of column groups are also supported (as long as they share the same direct parent),
+     * Columns inside column groups are also supported (as long as they share the same direct parent),
      * as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
      *
      * ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
      *
      * #### For example:
      *
-     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `fromColumn[`..`][ColumnReference.rangeTo]toColumn` }`
+     * `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]`  {  `<code>`fromColumn`[`..`][ColumnReference.rangeTo]`toColumn`</code>` }`
      *
      * @param [endInclusive] The last column in the subset.
      * @receiver The first column in the subset.

diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/distinct.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/distinct.kt
@@ -66,7 +66,7 @@ public interface DistinctColumnsSelectionDsl {
      * &nbsp;&nbsp;&nbsp;&nbsp;
      *
      *  ### Definitions:
-     *  `columnSet: `[ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]`<*>`
+     *  `columnSet: `[`ColumnSet`][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]`<*>`
      *
      *
      *
@@ -77,9 +77,9 @@ public interface DistinctColumnsSelectionDsl {
      *  
      * &nbsp;&nbsp;&nbsp;&nbsp;
      *
-     *  [columnSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetDef]
+     *  [`columnSet`][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetDef]
      *
-     *  &nbsp;&nbsp;&nbsp;&nbsp;.[**distinct**][org.jetbrains.kotlinx.dataframe.api.DistinctColumnsSelectionDsl.distinct]**`()`**
+     *  &nbsp;&nbsp;&nbsp;&nbsp;__`.`__[**`distinct`**][org.jetbrains.kotlinx.dataframe.api.DistinctColumnsSelectionDsl.distinct]**`()`**
      *
      *
      *
@@ -97,7 +97,7 @@ public interface DistinctColumnsSelectionDsl {
      */
     public interface Grammar {
 
-        /** .[**distinct**][ColumnsSelectionDsl.distinct] */
+        /** __`.`__[**`distinct`**][ColumnsSelectionDsl.distinct] */
         public interface ColumnSetName
     }
 
@@ -114,7 +114,7 @@ public interface DistinctColumnsSelectionDsl {
      * #### For Example:
      * `df.`[select][DataFrame.select]` { (`[colsOf][SingleColumn.colsOf]`<`[Int][Int]`>() `[and][ColumnsSelectionDsl.and]` age).`[distinct][ColumnSet.distinct]`() }`
      *
-     * `df.`[select][DataFrame.select]` { `[colsAtAnyDepth][ColumnsSelectionDsl.colsAtAnyDepth]`().`[nameStartsWith][ColumnsSelectionDsl.nameStartsWith]`("order").`[distinct][ColumnSet.distinct]`() }`
+     * `df.`[select][DataFrame.select]`  {  `[colsAtAnyDepth][ColumnsSelectionDsl.colsAtAnyDepth]`().`[nameStartsWith][ColumnsSelectionDsl.nameStartsWith]`("order").`[distinct][ColumnSet.distinct]`() }`
      *
      * @return A new [ColumnSet] containing only distinct columns (by path).
      * @see ColumnsSelectionDsl.named