fix: update KDocs for consistent camel case, remove backticks

Author: AndreiKingsley

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt

@@ -36,7 +36,7 @@ public annotation class ColumnsSelectionDslMarker
 
 /**
  * ## Columns Selection DSL
- * {@include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample]}
+ * {@include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample]}
  * {@set [SelectingColumns.OPERATION] [select][DataFrame.select]}
  *
  * @comment This interface be safely cast to [SingleColumn] across the library because it's always

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/Nulls.kt

@@ -17,7 +17,7 @@ import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
 import org.jetbrains.kotlinx.dataframe.documentation.DocumentationUrls
 import org.jetbrains.kotlinx.dataframe.documentation.ExcludeFromSources
 import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
-import org.jetbrains.kotlinx.dataframe.documentation.`NA`
+import org.jetbrains.kotlinx.dataframe.documentation.NA
 import org.jetbrains.kotlinx.dataframe.documentation.`NaN`
 import org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns
 import org.jetbrains.kotlinx.dataframe.get
@@ -67,7 +67,7 @@ private typealias CommonFillNullsFunctionDoc = Nothing
 
 /**
  * @include [CommonFillNullsFunctionDoc]
- * @include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample] {@include [SetFillNullsOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetFillNullsOperationArg]}
  * @include [Update.DslParam]
  */
 @Interpretable("FillNulls0")
@@ -76,7 +76,7 @@ public fun <T, C> DataFrame<T>.fillNulls(columns: ColumnsSelector<T, C?>): Updat
 
 /**
  * @include [CommonFillNullsFunctionDoc]
- * @include [SelectingColumns.ColumnNamesAPI.ColumnNamesApiWithExample] {@include [SetFillNullsOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample] {@include [SetFillNullsOperationArg]}
  * @include [Update.ColumnNamesParam]
  */
 public fun <T> DataFrame<T>.fillNulls(vararg columns: String): Update<T, Any?> = fillNulls { columns.toColumnSet() }
@@ -112,7 +112,7 @@ internal inline val Any?.isNaN: Boolean get() = (this is Double && isNaN()) || (
  *
  * Overload of `isNA` with contract support.
  *
- * @see `NA`
+ * @see NA
  */
 @JvmName("isNaWithContract")
 @Suppress("NOTHING_TO_INLINE")
@@ -125,7 +125,7 @@ internal inline fun <T : Any?> T.isNA(): Boolean {
 /**
  * Is `true` if [this] is considered NA.
  * "NA", in DataFrame, roughly means `null` or `NaN`.
- * @see `NA`
+ * @see NA
  */
 internal inline val Any?.isNA: Boolean
     get() = when (this) {
@@ -141,19 +141,19 @@ internal inline val AnyCol.canHaveNaN: Boolean get() = typeClass.let { it == Dou
 
 /**
  * Is `true` when [this] column can have [`NA`] values.
- * @see `NA`
+ * @see NA
  */
 internal inline val AnyCol.canHaveNA: Boolean get() = hasNulls() || canHaveNaN || kind() != ColumnKind.Value
 
 /**
  * Is `true` when [this] is `null` or [Double.NaN].
- * @see `NA`
+ * @see NA
  */
 internal inline val Double?.isNA: Boolean get() = this == null || this.isNaN()
 
 /**
  * Is `true` when [this] is `null` or [Float.NaN].
- * @see `NA`
+ * @see NA
  */
 internal inline val Float?.isNA: Boolean get() = this == null || this.isNaN()
 
@@ -197,7 +197,7 @@ private typealias CommonFillNaNsFunctionDoc = Nothing
 
 /**
  * @include [CommonFillNaNsFunctionDoc]
- * @include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample] {@include [SetFillNaNsOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetFillNaNsOperationArg]}
  * @include [Update.DslParam]
  */
 @Interpretable("FillNaNs0")
@@ -206,7 +206,7 @@ public fun <T, C> DataFrame<T>.fillNaNs(columns: ColumnsSelector<T, C>): Update<
 
 /**
  * @include [CommonFillNaNsFunctionDoc]
- * @include [SelectingColumns.ColumnNamesAPI.ColumnNamesApiWithExample] {@include [SetFillNaNsOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample] {@include [SetFillNaNsOperationArg]}
  * @include [Update.ColumnNamesParam]
  */
 public fun <T> DataFrame<T>.fillNaNs(vararg columns: String): Update<T, Any?> = fillNaNs { columns.toColumnSet() }
@@ -272,7 +272,7 @@ private typealias CommonFillNAFunctionDoc = Nothing
 
 /**
  * @include [CommonFillNAFunctionDoc]
- * @include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample] {@include [SetFillNAOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetFillNAOperationArg]}
  * @include [Update.DslParam]
  */
 @Interpretable("FillNulls0") // fillNA changes schema same as fillNulls
@@ -281,7 +281,7 @@ public fun <T, C> DataFrame<T>.fillNA(columns: ColumnsSelector<T, C?>): Update<T
 
 /**
  * @include [CommonFillNAFunctionDoc]
- * @include [SelectingColumns.ColumnNamesAPI.ColumnNamesApiWithExample] {@include [SetFillNAOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample] {@include [SetFillNAOperationArg]}
  * @include [Update.ColumnNamesParam]
  */
 public fun <T> DataFrame<T>.fillNA(vararg columns: String): Update<T, Any?> = fillNA { columns.toColumnSet() }
@@ -366,7 +366,7 @@ private typealias CommonDropNullsFunctionDoc = Nothing
 
 /**
  * @include [CommonDropNullsFunctionDoc]
- * @include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample] {@include [SetDropNullsOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetDropNullsOperationArg]}
  * `df.`[dropNulls][dropNulls]`(whereAllNull = true) { `[colsOf][colsOf]`<`[Double][Double]`>() }`
  * @include [DropNulls.WhereAllNullParam]
  * @include [DropDslParam]
@@ -487,7 +487,7 @@ private typealias CommonDropNAFunctionDoc = Nothing
 
 /**
  * @include [CommonDropNAFunctionDoc]
- * @include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample] {@include [SetDropNAOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetDropNAOperationArg]}
  * `df.`[dropNA][dropNA]`(whereAllNA = true) { `[colsOf][colsOf]`<`[Double][Double]`>() }`
  * @include [DropNA.WhereAllNAParam]
  * @include [DropDslParam]
@@ -517,7 +517,7 @@ public fun <T> DataFrame<T>.dropNA(vararg columns: KProperty<*>, whereAllNA: Boo
 
 /**
  * @include [CommonDropNAFunctionDoc]
- * @include [SelectingColumns.ColumnNamesAPI.ColumnNamesApiWithExample] {@include [SetDropNAOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample] {@include [SetDropNAOperationArg]}
  * `df.`[dropNA][dropNA]`("length", whereAllNA = true)`
  * @include [DropNA.WhereAllNAParam]
  * @include [DropColumnNamesParam]
@@ -602,7 +602,7 @@ private typealias CommonDropNaNsFunctionDoc = Nothing
 
 /**
  * @include [CommonDropNaNsFunctionDoc]
- * @include [SelectingColumns.ColumnsSelectionDSL.ColumnsSelectionDSLWithExample] {@include [SetDropNaNsOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetDropNaNsOperationArg]}
  * `df.`[dropNaNs][dropNaNs]`(whereAllNaN = true) { `[colsOf][colsOf]`<`[Double][Double]`>() }`
  * @include [DropNaNs.WhereAllNaNParam]
  * @include [DropDslParam]

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/allExcept.kt

@@ -17,7 +17,7 @@ import org.jetbrains.kotlinx.dataframe.columns.ColumnWithPath
 import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
 import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
 import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
-import org.jetbrains.kotlinx.dataframe.documentation.AccessAPIs.ExtensionPropertiesApiLink
+import org.jetbrains.kotlinx.dataframe.documentation.AccessApis.ExtensionPropertiesApiLink
 import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
 import org.jetbrains.kotlinx.dataframe.documentation.ExcludeFromSources
 import org.jetbrains.kotlinx.dataframe.documentation.Indent

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/associate.kt

@@ -3,7 +3,7 @@ package org.jetbrains.kotlinx.dataframe.api
 import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.DataRow
 import org.jetbrains.kotlinx.dataframe.RowExpression
-import org.jetbrains.kotlinx.dataframe.documentation.AccessAPIs
+import org.jetbrains.kotlinx.dataframe.documentation.AccessApis
 
 // region DataFrame
 
@@ -13,7 +13,7 @@ import org.jetbrains.kotlinx.dataframe.documentation.AccessAPIs
  *
  * The [transform] is a [RowExpression] — a lambda that receives each [DataRow]
  * both as `this` and `it` and is expected to return a key, allowing you to compute keys directly from row values.
- * You can also use [extension properties][AccessAPIs.`Extension Properties API`] for concise and type-safe access.
+ * You can also use [extension properties][AccessApis.ExtensionPropertiesApi] for concise and type-safe access.
  *
  * If multiple rows produce the same key, the last row for that key is stored,
  * consistent with Kotlin's [kotlin.collections.associateBy] behavior.
@@ -39,7 +39,7 @@ public inline fun <T, V> DataFrame<T>.associateBy(transform: RowExpression<T, V>
  *
  * The [transform] is a [RowExpression] — a lambda that receives each [DataRow]
  * both as `this` and `it` and is expected to return a pair, allowing you to generate [Pair]s of keys and values from row contents.
- * You can also use [extension properties][AccessAPIs.`Extension Properties API`] for concise and type-safe access.
+ * You can also use [extension properties][AccessApis.ExtensionPropertiesApi] for concise and type-safe access.
  *
  * If multiple rows produce the same key, the last value for that key is stored,
  * consistent with Kotlin's [kotlin.collections.associate] behavior.

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroups.kt

@@ -11,7 +11,7 @@ import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
 import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
 import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
 import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
-import org.jetbrains.kotlinx.dataframe.documentation.AccessAPIs
+import org.jetbrains.kotlinx.dataframe.documentation.AccessApis
 import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
 import org.jetbrains.kotlinx.dataframe.documentation.Indent
 import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
@@ -67,7 +67,7 @@ public interface ColGroupsColumnsSelectionDsl {
      * Creates a subset of columns from [this\] that are [ColumnGroups][ColumnGroup].
      *
      * You can optionally use a [filter\] to only include certain columns.
-     * [colGroups] can be called using any of the supported [APIs][AccessAPIs] (+ [ColumnPath]).
+     * [colGroups] can be called using any of the supported [APIs][AccessApis] (+ [ColumnPath]).
      *
      * This function operates solely on columns at the top-level.
      *

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOfKind.kt

@@ -10,7 +10,7 @@ import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
 import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
 import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
 import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
-import org.jetbrains.kotlinx.dataframe.documentation.AccessAPIs
+import org.jetbrains.kotlinx.dataframe.documentation.AccessApis
 import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
 import org.jetbrains.kotlinx.dataframe.documentation.Indent
 import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
@@ -71,7 +71,7 @@ public interface ColsOfKindColumnsSelectionDsl {
      * Creates a subset of columns from [this\] that are of the given kind(s).
      *
      * You can optionally use a [filter\] to only include certain columns.
-     * [colsOfKind] can be called using any of the supported [APIs][AccessAPIs] (+ [ColumnPath]).
+     * [colsOfKind] can be called using any of the supported [APIs][AccessApis] (+ [ColumnPath]).
      *
      * This function operates solely on columns at the top-level.
      *

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/convert.kt

@@ -228,7 +228,7 @@ private typealias CommonConvertDocs = Nothing
 
 /**
  * @include [CommonConvertDocs]
- * @include [SelectingColumns.ColumnsSelectionDSL] {@include [SetConvertOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl] {@include [SetConvertOperationArg]}
  * ### Examples:
  * ```kotlin
  * df.convert { columnA and columnB }.with { it.toString().lowercase() }
@@ -246,7 +246,7 @@ public fun <T, C> DataFrame<T>.convert(vararg columns: KProperty<C>): Convert<T,
 
 /**
  * @include [CommonConvertDocs]
- * @include [SelectingColumns.ColumnNamesAPI] {@include [SetConvertOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi] {@include [SetConvertOperationArg]}
  * ### Example:
  * ```kotlin
  * df.convert("person", "position").toStr()

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt

@@ -138,7 +138,7 @@ public fun <T> DataFrame<T>.corr(): DataFrame<T> =
 
 /**
  * {@include [CommonCorrDocs]}
- * @include [SelectingColumns.ColumnsSelectionDSL] {@include [SetCorrOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl] {@include [SetCorrOperationArg]}
  *
  * The function is available for numeric- and [Boolean] columns.
  * [Boolean] values are converted into 1 for true and 0 for false.
@@ -162,7 +162,7 @@ public fun <T, C> DataFrame<T>.corr(columns: ColumnsSelector<T, C>): Corr<T, C>
 
 /**
  * {@include [CommonCorrDocs]}
- * @include [SelectingColumns.ColumnNamesAPI] {@include [SetCorrOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi] {@include [SetCorrOperationArg]}
  *
  * The function is available for numeric- and [Boolean] columns.
  * [Boolean] values are converted into 1 for true and 0 for false.
@@ -219,7 +219,7 @@ private typealias CommonCorrWithDocs = Nothing
 
 /**
  * {@include [CommonCorrWithDocs]}
- * @include [SelectingColumns.ColumnsSelectionDSL] {@include [SetCorrOperationArg]}
+ * @include [SelectingColumns.ColumnsSelectionDsl] {@include [SetCorrOperationArg]}
  *
  * ### Examples
  * ```kotlin
@@ -238,7 +238,7 @@ public fun <T, C, R> Corr<T, C>.with(otherColumns: ColumnsSelector<T, R>): DataF
 
 /**
  * {@include [CommonCorrWithDocs]}
- * @include [SelectingColumns.ColumnNamesAPI] {@include [SetCorrOperationArg]}
+ * @include [SelectingColumns.ColumnNamesApi] {@include [SetCorrOperationArg]}
  *
  * ### Examples
  * ```kotlin

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/countDistinct.kt

@@ -50,7 +50,7 @@ internal typealias CountDistinctDocs = Nothing
 
 /**
  * {@include [CountDistinctDocs]}
- * {@include [SelectingColumns.ColumnsSelectionDSL]}
+ * {@include [SelectingColumns.ColumnsSelectionDsl]}
  *
  * #### Example
  *
@@ -69,7 +69,7 @@ public fun <T, C> DataFrame<T>.countDistinct(columns: ColumnsSelector<T, C>): In
 
 /**
  * {@include [CountDistinctDocs]}
- * {@include [SelectingColumns.ColumnNamesAPI]}
+ * {@include [SelectingColumns.ColumnNamesApi]}
  *
  * #### Example
  *

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/describe.kt

@@ -125,6 +125,7 @@ public fun <T> DataFrame<T>.describe(): DataFrame<ColumnDescription> =
 
 /**
  * @include [DescribeWithSelection]
+ * @include [SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample] {@include [SetDescribeOperationArg]}
  *
  * @param [columns] The [Columns Selector][ColumnsSelector] that specifies which
  * columns of this [DataFrame] should be described.
@@ -134,6 +135,7 @@ public fun <T> DataFrame<T>.describe(columns: ColumnsSelector<T, *>): DataFrame<
 
 /**
  * @include [DescribeWithSelection]
+ * @include [SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample] {@include [SetDescribeOperationArg]}
  *
  * @param [columns] The [Column Names][String] that specifies which
  * columns of this [DataFrame] should be described.