Skip to content

Commit 1b95b2e

Browse files
committed
cleaned up KDocs in documentation folder, adding/removing exclusions where needed
1 parent 5aa204e commit 1b95b2e

57 files changed

Lines changed: 908 additions & 356 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ public annotation class ColumnsSelectionDslMarker
3636

3737
/**
3838
* ## Columns Selection DSL
39+
*
40+
*
41+
*
42+
*
3943
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
4044
*
4145
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,

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

Lines changed: 77 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,18 @@ internal interface FillNulls {
8686
typealias Grammar = Nothing
8787

8888
/**
89+
*
90+
*
8991
*
9092
* ## Selecting Columns
9193
*
9294
* Selecting columns for various [DataFrame][org.jetbrains.kotlinx.dataframe.DataFrame] operations
9395
* can be done in the following ways:
9496
* ### 1. [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample]
97+
*
98+
*
99+
*
100+
*
95101
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
96102
*
97103
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -118,8 +124,12 @@ internal interface FillNulls {
118124
*
119125
* > There's also a 'single column' variant used sometimes: [Column Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnSelectionDsl.ColumnsSelectionDslWithExample].
120126
* ### 2. [Column names][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample]
127+
*
128+
*
129+
*
130+
*
121131
* Select single or multiple columns using their names as [String]s.
122-
* ([String API][`StringAPI`]).
132+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
123133
*
124134
* #### For example:
125135
*
@@ -150,6 +160,10 @@ private typealias SetFillNullsOperationArg = Nothing
150160
*
151161
* ### This Fill Nulls Overload
152162
*
163+
*
164+
*
165+
*
166+
*
153167
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
154168
*
155169
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -197,8 +211,12 @@ public fun <T, C> DataFrame<T>.fillNulls(columns: ColumnsSelector<T, C?>): Updat
197211
*
198212
* ### This Fill Nulls Overload
199213
*
214+
*
215+
*
216+
*
217+
*
200218
* Select single or multiple columns using their names as [String]s.
201-
* ([String API][`StringAPI`]).
219+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
202220
*
203221
* #### For example:
204222
*
@@ -375,12 +393,18 @@ internal interface FillNaNs {
375393
typealias Grammar = Nothing
376394

377395
/**
396+
*
397+
*
378398
*
379399
* ## Selecting Columns
380400
*
381401
* Selecting columns for various [DataFrame][org.jetbrains.kotlinx.dataframe.DataFrame] operations
382402
* can be done in the following ways:
383403
* ### 1. [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample]
404+
*
405+
*
406+
*
407+
*
384408
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
385409
*
386410
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -407,8 +431,12 @@ internal interface FillNaNs {
407431
*
408432
* > There's also a 'single column' variant used sometimes: [Column Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnSelectionDsl.ColumnsSelectionDslWithExample].
409433
* ### 2. [Column names][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample]
434+
*
435+
*
436+
*
437+
*
410438
* Select single or multiple columns using their names as [String]s.
411-
* ([String API][`StringAPI`]).
439+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
412440
*
413441
* #### For example:
414442
*
@@ -436,6 +464,10 @@ internal interface FillNaNs {
436464
* for all the selecting options.
437465
*
438466
* ### This Fill NaNs Overload
467+
*
468+
*
469+
*
470+
*
439471
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
440472
*
441473
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -482,8 +514,12 @@ public fun <T, C> DataFrame<T>.fillNaNs(columns: ColumnsSelector<T, C>): Update<
482514
* for all the selecting options.
483515
*
484516
* ### This Fill NaNs Overload
517+
*
518+
*
519+
*
520+
*
485521
* Select single or multiple columns using their names as [String]s.
486-
* ([String API][`StringAPI`]).
522+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
487523
*
488524
* #### For example:
489525
*
@@ -603,12 +639,18 @@ internal interface FillNA {
603639
typealias Grammar = Nothing
604640

605641
/**
642+
*
643+
*
606644
*
607645
* ## Selecting Columns
608646
*
609647
* Selecting columns for various [DataFrame][org.jetbrains.kotlinx.dataframe.DataFrame] operations
610648
* can be done in the following ways:
611649
* ### 1. [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample]
650+
*
651+
*
652+
*
653+
*
612654
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
613655
*
614656
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -635,8 +677,12 @@ internal interface FillNA {
635677
*
636678
* > There's also a 'single column' variant used sometimes: [Column Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnSelectionDsl.ColumnsSelectionDslWithExample].
637679
* ### 2. [Column names][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample]
680+
*
681+
*
682+
*
683+
*
638684
* Select single or multiple columns using their names as [String]s.
639-
* ([String API][`StringAPI`]).
685+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
640686
*
641687
* #### For example:
642688
*
@@ -664,6 +710,10 @@ internal interface FillNA {
664710
* for all the selecting options.
665711
*
666712
* ### This Fill NA Overload
713+
*
714+
*
715+
*
716+
*
667717
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
668718
*
669719
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -710,8 +760,12 @@ public fun <T, C> DataFrame<T>.fillNA(columns: ColumnsSelector<T, C?>): Update<T
710760
* for all the selecting options.
711761
*
712762
* ### This Fill NA Overload
763+
*
764+
*
765+
*
766+
*
713767
* Select single or multiple columns using their names as [String]s.
714-
* ([String API][`StringAPI`]).
768+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
715769
*
716770
* #### For example:
717771
*
@@ -786,6 +840,10 @@ public fun <T, C> DataFrame<T>.fillNA(vararg columns: ColumnReference<C>): Updat
786840
*
787841
* For more information: [See `dropNulls` on the documentation website.](https://kotlin.github.io/dataframe/drop.html#dropnulls)
788842
* ### This Drop Nulls Overload
843+
*
844+
*
845+
*
846+
*
789847
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
790848
*
791849
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -950,6 +1008,10 @@ public fun <T> DataColumn<T?>.dropNulls(): DataColumn<T> =
9501008
*
9511009
* For more information: [See `dropNA` on the documentation website.](https://kotlin.github.io/dataframe/drop.html#dropna)
9521010
* ### This Drop NA Overload
1011+
*
1012+
*
1013+
*
1014+
*
9531015
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
9541016
*
9551017
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -1025,8 +1087,12 @@ public fun <T> DataFrame<T>.dropNA(vararg columns: KProperty<*>, whereAllNA: Boo
10251087
*
10261088
* For more information: [See `dropNA` on the documentation website.](https://kotlin.github.io/dataframe/drop.html#dropna)
10271089
* ### This Drop NA Overload
1090+
*
1091+
*
1092+
*
1093+
*
10281094
* Select single or multiple columns using their names as [String]s.
1029-
* ([String API][`StringAPI`]).
1095+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
10301096
*
10311097
* #### For example:
10321098
*
@@ -1112,6 +1178,10 @@ public fun <T> DataColumn<T?>.dropNA(): DataColumn<T> =
11121178
*
11131179
* For more information: [See `dropNaNs` on the documentation website.](https://kotlin.github.io/dataframe/drop.html#dropnans)
11141180
* ### This Drop NaNs Overload
1181+
*
1182+
*
1183+
*
1184+
*
11151185
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
11161186
*
11171187
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,8 @@ public inline fun <reified R, T> DataFrame<T>.add(
246246
* For more information: [See `add` on the documentation website.](https://kotlin.github.io/dataframe/add.html).
247247
*
248248
* Returns a new [DataFrame] with the new column inserted at the given [path].
249+
*
250+
*
249251
* If the specified path is partially or fully missing — that is, if any segment of the path
250252
* does not correspond to an existing column or column group — all missing parts will be created automatically.
251253
*

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ public fun <T> DataColumn<T>.any(predicate: Predicate<T>): Boolean = values.any(
3030
/**
3131
* Returns `true` if at least one row in this [DataFrame] satisfies the given [predicate].
3232
*
33+
*
34+
*
3335
* The [predicate] is a [RowFilter][org.jetbrains.kotlinx.dataframe.RowFilter] — a lambda that receives each [DataRow][org.jetbrains.kotlinx.dataframe.DataRow] as both `this` and `it`
3436
* and is expected to return a [Boolean] value.
3537
*

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

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ internal typealias SeeAlsoParse = Nothing
105105
*
106106
* Check out [Grammar].
107107
*
108+
*
109+
*
108110
* This can include [column groups][org.jetbrains.kotlinx.dataframe.columns.ColumnGroup] and nested columns.
109111
*
110112
* See [Selecting Columns][ConvertSelectingOptions].
@@ -117,12 +119,18 @@ internal typealias SeeAlsoParse = Nothing
117119
internal interface ConvertDocs {
118120

119121
/**
122+
*
123+
*
120124
*
121125
* ## Selecting Columns
122126
*
123127
* Selecting columns for various [DataFrame][org.jetbrains.kotlinx.dataframe.DataFrame] operations
124128
* can be done in the following ways:
125129
* ### 1. [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnsSelectionDsl.ColumnsSelectionDslWithExample]
130+
*
131+
*
132+
*
133+
*
126134
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
127135
*
128136
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -149,8 +157,12 @@ internal interface ConvertDocs {
149157
*
150158
* > There's also a 'single column' variant used sometimes: [Column Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnSelectionDsl.ColumnsSelectionDslWithExample].
151159
* ### 2. [Column names][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnNamesApi.ColumnNamesApiWithExample]
160+
*
161+
*
162+
*
163+
*
152164
* Select single or multiple columns using their names as [String]s.
153-
* ([String API][`StringAPI`]).
165+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
154166
*
155167
* #### For example:
156168
*
@@ -283,6 +295,8 @@ internal interface ConvertDocs {
283295
*
284296
* Check out [Grammar][org.jetbrains.kotlinx.dataframe.api.ConvertDocs.Grammar].
285297
*
298+
*
299+
*
286300
* This can include [column groups][org.jetbrains.kotlinx.dataframe.columns.ColumnGroup] and nested columns.
287301
*
288302
* See [Selecting Columns][org.jetbrains.kotlinx.dataframe.api.ConvertDocs.ConvertSelectingOptions].
@@ -292,6 +306,8 @@ internal interface ConvertDocs {
292306
* See also [parse][org.jetbrains.kotlinx.dataframe.api.parse] — a specialized form of the [convert][org.jetbrains.kotlinx.dataframe.api.convert] operation that parses [String] columns
293307
* into other types without requiring explicit type specification.
294308
* ### This Convert Overload
309+
*
310+
*
295311
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
296312
*
297313
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
@@ -344,6 +360,8 @@ public fun <T, C> DataFrame<T>.convert(vararg columns: KProperty<C>): Convert<T,
344360
*
345361
* Check out [Grammar][org.jetbrains.kotlinx.dataframe.api.ConvertDocs.Grammar].
346362
*
363+
*
364+
*
347365
* This can include [column groups][org.jetbrains.kotlinx.dataframe.columns.ColumnGroup] and nested columns.
348366
*
349367
* See [Selecting Columns][org.jetbrains.kotlinx.dataframe.api.ConvertDocs.ConvertSelectingOptions].
@@ -353,8 +371,10 @@ public fun <T, C> DataFrame<T>.convert(vararg columns: KProperty<C>): Convert<T,
353371
* See also [parse][org.jetbrains.kotlinx.dataframe.api.parse] — a specialized form of the [convert][org.jetbrains.kotlinx.dataframe.api.convert] operation that parses [String] columns
354372
* into other types without requiring explicit type specification.
355373
* ### This Convert Overload
374+
*
375+
*
356376
* Select single or multiple columns using their names as [String]s.
357-
* ([String API][`StringAPI`]).
377+
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApis.StringApi]).
358378
* ### Example:
359379
* ```kotlin
360380
* df.convert("person", "position").toStr()

0 commit comments

Comments
 (0)