small kdoc enhancements to clarify DataColumn.createX functions

Author: Jolanrensen

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/DataColumn.kt

@@ -100,6 +100,10 @@ public interface DataColumn<out T> : BaseColumn<T> {
             nullable: Boolean? = null,
         ): DataColumn<T> = createColumnGuessingType(name, values, nullable = nullable)
 
+        /**
+         * Calls [createColumnGroup], [createFrameColumn], or [createValueColumn] based on
+         * [type] without checking the actual values in [values].
+         */
         public fun <T> create(
             name: String,
             values: List<T>,
@@ -112,6 +116,10 @@ public interface DataColumn<out T> : BaseColumn<T> {
                 ColumnKind.Frame -> createFrameColumn(name, values as List<AnyFrame>).asDataColumn().cast()
             }
 
+        /**
+         * Calls [createColumnGroup], [createFrameColumn], or [createValueColumn] based on
+         * type [T] without checking the actual values in [values].
+         */
         public inline fun <reified T> create(name: String, values: List<T>, infer: Infer = Infer.None): DataColumn<T> =
             create(name, values, typeOf<T>(), infer)
 

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/columns/ColumnGroup.kt

@@ -23,6 +23,8 @@ import kotlin.reflect.KProperty
  * - [ColumnAccessor] created by [columnGroup] delegate
  * - explicit cast using [asColumnGroup]
  *
+ * Can be instantiated by [DataColumn.createColumnGroup].
+ *
  * @param T Schema marker. See [DataFrame] for details.
  */
 @HasSchema(schemaArg = 0)

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/columns/FrameColumn.kt

@@ -7,6 +7,8 @@ import org.jetbrains.kotlinx.dataframe.schema.DataFrameSchema
 /**
  * Column that stores values of type [DataFrame]
  *
+ * Can be instantiated by [DataColumn.createFrameColumn].
+ *
  * @param T schema marker of contained dataframes. See [DataFrame] for details.
  */
 public interface FrameColumn<out T> : DataColumn<DataFrame<T>> {

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/columns/ValueColumn.kt

@@ -6,6 +6,8 @@ import kotlin.reflect.KProperty
 /**
  * Column that stores values.
  *
+ * Can be instantiated by [DataColumn.createValueColumn].
+ *
  * @param T - type of values
  */
 public interface ValueColumn<out T> : DataColumn<T> {