replaced all documentation interfaces by (nested) type-aliases

Author: Jolanrensen

build-logic/src/main/kotlin/dfbuild.kotlinJvmCommon.gradle.kts

@@ -12,6 +12,7 @@ kotlin {
     compilerOptions {
         // can be removed once kotlin.uuid.ExperimentalUuidApi is marked "stable".
         optIn.add("kotlin.uuid.ExperimentalUuidApi")
+        freeCompilerArgs.add("-Xnested-type-aliases")
     }
 }
 

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

@@ -16,8 +16,7 @@ import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
 import kotlin.reflect.KProperty
 
 /** [Column Selection DSL][ColumnSelectionDsl] */
-internal interface ColumnSelectionDslLink
-
+internal typealias ColumnSelectionDslLink = Nothing
 public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
 
     /**
@@ -27,8 +26,7 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
      * This is a shorthand for [get][ColumnsContainer.get]`(myColumn)`.
      * @throws [IllegalArgumentException] if the column is not found.
      */
-    private interface CommonColumnReferenceInvokeDocs
-
+    private typealias CommonColumnReferenceInvokeDocs = Nothing
     /**
      * @include [CommonColumnReferenceInvokeDocs]
      * @return The [DataColumn] this [Column Reference][ColumnReference] or [-Accessor][ColumnAccessor] points to.
@@ -68,8 +66,7 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
      * This is a shorthand for [get][ColumnsContainer.get]`(MyType::myColumn)`.
      * @throws [IllegalArgumentException] if the column is not found.
      */
-    private interface CommonKPropertyInvokeDocs
-
+    private typealias CommonKPropertyInvokeDocs = Nothing
     /**
      * @include [CommonKPropertyInvokeDocs]
      * @return The [DataColumn] this [KProperty Accessor][KProperty] points to.
@@ -107,8 +104,7 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
      *
      * @throws [IllegalArgumentException] if the column is not found.
      */
-    private interface CommonKPropertyGetDocs
-
+    private typealias CommonKPropertyGetDocs = Nothing
     /**
      * @include [CommonKPropertyGetDocs]
      * @return The [DataColumn] these [KProperty Accessors][KProperty] point to.

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

@@ -20,8 +20,7 @@ import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
 import kotlin.reflect.KProperty
 
 /** [Columns Selection DSL][ColumnsSelectionDsl] */
-internal interface ColumnsSelectionDslLink
-
+internal typealias ColumnsSelectionDslLink = Nothing
 @Suppress("UNCHECKED_CAST")
 @PublishedApi
 internal fun <T> ColumnsSelectionDsl<T>.asSingleColumn(): SingleColumn<DataRow<T>> = this as SingleColumn<DataRow<T>>
@@ -167,8 +166,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
          * {@include [DslGrammarTemplate.TextDef]}
          */
         @[ExcludeFromSources ExportAsHtml]
-        public interface DefinitionsPartOfGrammar
-
+        public typealias DefinitionsPartOfGrammar = Nothing
         /**
          * {@include [DslGrammarTemplate.ColumnRef]}` `{@include [ColumnRangeColumnsSelectionDsl.Grammar.PlainDslName]}` `{@include [DslGrammarTemplate.ColumnRef]}
          *
@@ -229,8 +227,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
          * `| `{@include [WithoutNullsColumnsSelectionDsl.Grammar.PlainDslName]}**`()`**
          */
         @[ExcludeFromSources ExportAsHtml]
-        public interface PlainDslPartOfGrammar
-
+        public typealias PlainDslPartOfGrammar = Nothing
         /**
          * {@include [Indent]}\[**`\[`**\][ColumnsSelectionDsl.col]{@include [DslGrammarTemplate.IndexRef]}\[**`\]`**\][ColumnsSelectionDsl.col]
          *
@@ -297,7 +294,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
              * {@include [ColumnSetPartOfGrammar]}
              */
             @ExportAsHtml
-            public interface ForHtml
+            public typealias ForHtml = Nothing
         }
 
         /**
@@ -374,7 +371,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
              * {@include [ColumnGroupPartOfGrammar]}
              */
             @ExportAsHtml
-            public interface ForHtml
+            public typealias ForHtml = Nothing
         }
     }
 

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

@@ -114,15 +114,13 @@ public operator fun AnyRow.contains(column: KProperty<*>): Boolean = containsKey
  *
  * @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
  */
-internal interface DiffDocs
-
+internal typealias DiffDocs = Nothing
 /**
  * Calculates the difference between the results of a row expression computed on the current and previous DataRow.
  *
  * @return null for the first row; difference between expression computed for current and previous row for the following rows
  */
-internal interface DiffOrNullDocs
-
+internal typealias DiffOrNullDocs = Nothing
 /**
  * @include [DiffDocs]
  */

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

@@ -42,18 +42,16 @@ import kotlin.reflect.KProperty
 internal interface FillNulls {
 
     /** @include [Update.Grammar] {@set [UPDATE_OPERATION] [**fillNulls**][fillNulls]} */
-    interface Grammar
-
+    typealias Grammar = Nothing
     /**
      * {@comment Version of [SelectingColumns] with correctly filled in examples}
      * @include [SelectingColumns] {@include [SetFillNullsOperationArg]}
      */
-    interface FillNullsSelectingOptions
+    typealias FillNullsSelectingOptions = Nothing
 }
 
 /** {@set [SelectingColumns.OPERATION] [fillNulls][fillNulls]} */
-private interface SetFillNullsOperationArg
-
+private typealias SetFillNullsOperationArg = Nothing
 /**
  * @include [FillNulls] {@comment Description of the fillNulls operation.}
  * @include [LineBreak]
@@ -63,8 +61,7 @@ private interface SetFillNullsOperationArg
  *
  */
 @ExcludeFromSources
-private interface CommonFillNullsFunctionDoc
-
+private typealias CommonFillNullsFunctionDoc = Nothing
 /**
  * @include [CommonFillNullsFunctionDoc]
  * @include [SelectingColumns.Dsl.WithExample] {@include [SetFillNullsOperationArg]}
@@ -172,19 +169,17 @@ internal inline val Float?.isNA: Boolean get() = this == null || this.isNaN()
 internal interface FillNaNs {
 
     /** @include [Update.Grammar] {@set [Update.UPDATE_OPERATION] [fillNaNs][fillNaNs]} */
-    interface Grammar
-
+    typealias Grammar = Nothing
     /**
      * {@comment Version of [SelectingColumns] with correctly filled in examples}
      * @include [SelectingColumns] {@include [SetFillNaNsOperationArg]}
      */
-    interface FillNaNsSelectingOptions
+    typealias FillNaNsSelectingOptions = Nothing
 }
 
 /** {@set [SelectingColumns.OPERATION] [fillNaNs][fillNaNs]} */
 @ExcludeFromSources
-internal interface SetFillNaNsOperationArg
-
+internal typealias SetFillNaNsOperationArg = Nothing
 /**
  * @include [FillNaNs] {@comment Description of the fillNaNs operation.}
  * @include [LineBreak]
@@ -193,8 +188,7 @@ internal interface SetFillNaNsOperationArg
  * ### This Fill NaNs Overload
  */
 @ExcludeFromSources
-private interface CommonFillNaNsFunctionDoc
-
+private typealias CommonFillNaNsFunctionDoc = Nothing
 /**
  * @include [CommonFillNaNsFunctionDoc]
  * @include [SelectingColumns.Dsl.WithExample] {@include [SetFillNaNsOperationArg]}
@@ -247,19 +241,17 @@ public fun <T, C> DataFrame<T>.fillNaNs(vararg columns: ColumnReference<C>): Upd
 internal interface FillNA {
 
     /** @include [Update.Grammar] {@set [Update.UPDATE_OPERATION] [fillNA][fillNA]} */
-    interface Grammar
-
+    typealias Grammar = Nothing
     /**
      * {@comment Version of [SelectingColumns] with correctly filled in examples}
      * @include [SelectingColumns] {@include [SetFillNAOperationArg]}
      */
-    interface FillNASelectingOptions
+    typealias FillNASelectingOptions = Nothing
 }
 
 /** {@set [SelectingColumns.OPERATION] [fillNA][fillNA]} */
 @ExcludeFromSources
-internal interface SetFillNAOperationArg
-
+internal typealias SetFillNAOperationArg = Nothing
 /**
  * @include [FillNA] {@comment Description of the fillNA operation.}
  * @include [LineBreak]
@@ -268,8 +260,7 @@ internal interface SetFillNAOperationArg
  * ### This Fill NA Overload
  */
 @ExcludeFromSources
-private interface CommonFillNAFunctionDoc
-
+private typealias CommonFillNAFunctionDoc = Nothing
 /**
  * @include [CommonFillNAFunctionDoc]
  * @include [SelectingColumns.Dsl.WithExample] {@include [SetFillNAOperationArg]}
@@ -309,20 +300,16 @@ public fun <T, C> DataFrame<T>.fillNA(vararg columns: ColumnReference<C>): Updat
 
 /** @param columns The [Columns Selector][ColumnsSelector] used to select the columns of this [DataFrame] to drop rows in. */
 @ExcludeFromSources
-private interface DropDslParam
-
+private typealias DropDslParam = Nothing
 /** @param columns The [KProperties][KProperty] used to select the columns of this [DataFrame] to drop rows in. */
 @ExcludeFromSources
-private interface DropKPropertiesParam
-
+private typealias DropKPropertiesParam = Nothing
 /** @param columns The [Strings][String] corresponding to the names of columns in this [DataFrame] to drop rows in. */
 @ExcludeFromSources
-private interface DropColumnNamesParam
-
+private typealias DropColumnNamesParam = Nothing
 /** @param columns The [Column References][ColumnReference] used to select the columns of this [DataFrame] to drop rows in. */
 @ExcludeFromSources
-private interface DropColumnAccessorsParam
-
+private typealias DropColumnAccessorsParam = Nothing
 // region dropNulls
 
 /**
@@ -345,26 +332,23 @@ internal interface DropNulls {
      *   If `true`, rows are dropped if all selected cells are `null`.
      *   If `false`, rows are dropped if any of the selected cells is `null`.
      */
-    interface WhereAllNullParam
-
+    typealias WhereAllNullParam = Nothing
     /**
      * {@comment Version of [SelectingColumns] with correctly filled in examples}
      * @include [SelectingColumns] {@include [SetDropNullsOperationArg]}
      */
-    interface DropNullsSelectingOptions
+    typealias DropNullsSelectingOptions = Nothing
 }
 
 /** {@set [SelectingColumns.OPERATION] [dropNulls][dropNulls]} */
 @ExcludeFromSources
-private interface SetDropNullsOperationArg
-
+private typealias SetDropNullsOperationArg = Nothing
 /**
  * @include [DropNulls] {@comment Description of the dropNulls operation.}
  * ### This Drop Nulls Overload
  */
 @ExcludeFromSources
-private interface CommonDropNullsFunctionDoc
-
+private typealias CommonDropNullsFunctionDoc = Nothing
 /**
  * @include [CommonDropNullsFunctionDoc]
  * @include [SelectingColumns.Dsl.WithExample] {@include [SetDropNullsOperationArg]}
@@ -466,26 +450,23 @@ internal interface DropNA {
      *   If `true`, rows are dropped if all selected cells are [`NA`][NA].
      *   If `false`, rows are dropped if any of the selected cells is [`NA`][NA].
      */
-    interface WhereAllNAParam
-
+    typealias WhereAllNAParam = Nothing
     /**
      * {@comment Version of [SelectingColumns] with correctly filled in examples}
      * @include [SelectingColumns] {@include [SetDropNAOperationArg]}
      */
-    interface DropNASelectingOptions
+    typealias DropNASelectingOptions = Nothing
 }
 
 /** {@set [SelectingColumns.OPERATION] [dropNA][dropNA]} */
 @ExcludeFromSources
-private interface SetDropNAOperationArg
-
+private typealias SetDropNAOperationArg = Nothing
 /**
  * @include [DropNA] {@comment Description of the dropNA operation.}
  * ### This Drop NA Overload
  */
 @ExcludeFromSources
-private interface CommonDropNAFunctionDoc
-
+private typealias CommonDropNAFunctionDoc = Nothing
 /**
  * @include [CommonDropNAFunctionDoc]
  * @include [SelectingColumns.Dsl.WithExample] {@include [SetDropNAOperationArg]}
@@ -581,26 +562,23 @@ internal interface DropNaNs {
      *   If `true`, rows are dropped if all selected cells are [`NaN`][Double.isNaN].
      *   If `false`, rows are dropped if any of the selected cells is [`NaN`][Double.isNaN].
      */
-    interface WhereAllNaNParam
-
+    typealias WhereAllNaNParam = Nothing
     /**
      * {@comment Version of [SelectingColumns] with correctly filled in examples}
      * @include [SelectingColumns] {@include [SetDropNaNsOperationArg]}
      */
-    interface DropNaNsSelectingOptions
+    typealias DropNaNsSelectingOptions = Nothing
 }
 
 /** {@set [SelectingColumns.OPERATION] [dropNaNs][dropNaNs]} */
 @ExcludeFromSources
-private interface SetDropNaNsOperationArg
-
+private typealias SetDropNaNsOperationArg = Nothing
 /**
  * @include [DropNaNs] {@comment Description of the dropNaNs operation.}
  * ### This Drop NaNs Overload
  */
 @ExcludeFromSources
-private interface CommonDropNaNsFunctionDoc
-
+private typealias CommonDropNaNsFunctionDoc = Nothing
 /**
  * @include [CommonDropNaNsFunctionDoc]
  * @include [SelectingColumns.Dsl.WithExample] {@include [SetDropNaNsOperationArg]}

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

@@ -178,8 +178,7 @@ public typealias AddExpression<T, R> = Selector<AddDataRow<T>, R>
  * For example, use `prev().newValue()` to access the new column value from the previous row.
  */
 @ExcludeFromSources
-internal interface AddExpressionDocs
-
+internal typealias AddExpressionDocs = Nothing
 /**
  * Creates a new column using an [AddExpression] and
  * adds a new column to the end of this [DataFrame] (at the top level).