Skip to content

Commit 669b1e8

Browse files
JolanrensenJolanrensen
committed
fixing kdocs in update and nulls
1 parent feb3206 commit 669b1e8

File tree

12 files changed

+198
-618
lines changed

12 files changed

+198
-618
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ public annotation class ColumnsSelectionDslMarker
6262
*
6363
* `df.`[select][DataFrame.select]` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
6464
*
65-
* `df.`[select][DataFrame.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
65+
* `df.`[select][DataFrame.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
6666
*
67-
* `df.`[select][DataFrame.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
67+
* `df.`[select][DataFrame.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
6868
*
6969
*
7070
*

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

Lines changed: 54 additions & 418 deletions
Large diffs are not rendered by default.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ internal interface Select {
7171
*
7272
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
7373
*
74-
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
74+
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
7575
*
76-
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
76+
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
7777
*
7878
*
7979
* #### NOTE: There's also a 'single column' variant used sometimes: [Column Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.DslSingle.WithExample].
@@ -159,9 +159,9 @@ private interface CommonSelectDocs
159159
*
160160
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
161161
*
162-
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
162+
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
163163
*
164-
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
164+
* `df.`[select][org.jetbrains.kotlinx.dataframe.api.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
165165
*
166166
*
167167
* @param [columns] The [Columns Selector][ColumnsSelector] used to select the columns of this [DataFrame].

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

Lines changed: 42 additions & 136 deletions
Large diffs are not rendered by default.

‎core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ExpressionsGivenRow.kt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ internal interface ExpressionsGivenRow {
3737
*/
3838
interface OperationArg
3939

40+
// Using <code>` notation to not create double `` when including
4041
interface SetDefaultOperationArg
4142

4243
/**
@@ -55,9 +56,9 @@ internal interface ExpressionsGivenRow {
5556
*
5657
* For example:
5758
*
58-
* `df.`operation` { name.firstName + " " + name.lastName }`
59+
* `df.`<code>`operation`</code>` { name.firstName + " " + name.lastName }`
5960
*
60-
* `df.`operation` { 2021 - age }`
61+
* `df.`<code>`operation`</code>` { 2021 - age }`
6162
*
6263
*/
6364
interface WithExample
@@ -77,9 +78,9 @@ internal interface ExpressionsGivenRow {
7778
*
7879
* For example:
7980
*
80-
* `df.`operation` { name.firstName + " from " + it }`
81+
* `df.`<code>`operation`</code>` { name.firstName + " from " + it }`
8182
*
82-
* `df.`operation` { it.uppercase() }`
83+
* `df.`<code>`operation`</code>` { it.uppercase() }`
8384
*
8485
*/
8586
interface WithExample

‎core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ExpressionsGivenRowAndColumn.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ internal interface ExpressionsGivenRowAndColumn {
1818
*/
1919
interface OperationArg
2020

21+
// Using <code>` notation to not create double `` when including
2122
interface SetDefaultOperationArg
2223

2324
/** Provide a new value for every selected cell given both its row and column using a [row-column expression][DfRowColumnExpression]. */
@@ -28,9 +29,9 @@ internal interface ExpressionsGivenRowAndColumn {
2829
*
2930
* For example:
3031
*
31-
* `df.`operation` { row, col ->`
32+
* `df.`<code>`operation`</code>` { row, col ->`
3233
*
33-
* `row.age / col.`[mean][DataColumn.mean]`(skipNA = true)`
34+
* &nbsp;&nbsp;&nbsp;&nbsp;`row.age / col.`[mean][DataColumn.mean]`(skipNA = true)`
3435
*
3536
* `}`
3637
*

‎core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/SelectingColumns.kt

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ internal interface SelectingColumnsLink
5959
*
6060
* #### For example:
6161
*
62-
* `df.`operation` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
62+
* `df.`<code>`operation`</code>` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
6363
*
64-
* `df.`operation` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
64+
* `df.`<code>`operation`</code>` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
6565
*
66-
* `df.`operation` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
66+
* `df.`<code>`operation`</code>` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
6767
*
6868
*
6969
* #### NOTE: There's also a 'single column' variant used sometimes: [Column Selection DSL][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.DslSingle.WithExample].
@@ -73,7 +73,7 @@ internal interface SelectingColumnsLink
7373
*
7474
* #### For example:
7575
*
76-
* `df.`operation`("length", "age")`
76+
* `df.`<code>`operation`</code>`("length", "age")`
7777
*
7878
* ### 3. [Column references][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.ColumnAccessors.WithExample]
7979
* Select columns using [column accessors][org.jetbrains.kotlinx.dataframe.columns.ColumnReference]
@@ -85,7 +85,7 @@ internal interface SelectingColumnsLink
8585
*
8686
* `val age by `[column][org.jetbrains.kotlinx.dataframe.api.column]`<`[Double][Double]`>()`
8787
*
88-
* `df.`operation`(length, age)`
88+
* `df.`<code>`operation`</code>`(length, age)`
8989
*
9090
* ### 4. [KProperties][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns.KProperties.WithExample]
9191
* Select columns using [KProperties][KProperty] ([KProperties API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi.KPropertiesApi]).
@@ -95,7 +95,7 @@ internal interface SelectingColumnsLink
9595
* data class Person(val length: Double, val age: Double)
9696
* ```
9797
*
98-
* `df.`operation`(Person::length, Person::age)`
98+
* `df.`<code>`operation`</code>`(Person::length, Person::age)`
9999
*
100100
*/
101101
internal interface SelectingColumns {
@@ -106,6 +106,7 @@ internal interface SelectingColumns {
106106
*/
107107
interface OperationArg
108108

109+
// Using <code>` notation to not create double `` when including
109110
interface SetDefaultOperationArg
110111

111112
/**
@@ -156,11 +157,11 @@ internal interface SelectingColumns {
156157
*
157158
* #### For example:
158159
*
159-
* `df.`operation` { length `[and][ColumnsSelectionDsl.and]` age }`
160+
* `df.`<code>`operation`</code>` { length `[and][ColumnsSelectionDsl.and]` age }`
160161
*
161-
* `df.`operation` { `[cols][ColumnsSelectionDsl.cols]`(1..5) }`
162+
* `df.`<code>`operation`</code>` { `[cols][ColumnsSelectionDsl.cols]`(1..5) }`
162163
*
163-
* `df.`operation` { `[colsOf][ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
164+
* `df.`<code>`operation`</code>` { `[colsOf][ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
164165
*
165166
*
166167
*/
@@ -216,11 +217,11 @@ internal interface SelectingColumns {
216217
*
217218
* #### For example:
218219
*
219-
* `df.`operation` { length }`
220+
* `df.`<code>`operation`</code>` { length }`
220221
*
221-
* `df.`operation` { `[col][ColumnsSelectionDsl.col]`(1) }`
222+
* `df.`<code>`operation`</code>` { `[col][ColumnsSelectionDsl.col]`(1) }`
222223
*
223-
* `df.`operation` { `[colsOf][ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>().`[first][ColumnsSelectionDsl.first]`() }`
224+
* `df.`<code>`operation`</code>` { `[colsOf][ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>().`[first][ColumnsSelectionDsl.first]`() }`
224225
*
225226
*/
226227
interface WithExample
@@ -241,7 +242,7 @@ internal interface SelectingColumns {
241242
*
242243
* #### For example:
243244
*
244-
* `df.`operation`("length", "age")`
245+
* `df.`<code>`operation`</code>`("length", "age")`
245246
*
246247
*/
247248
interface WithExample
@@ -266,7 +267,7 @@ internal interface SelectingColumns {
266267
*
267268
* `val age by `[column][column]`<`[Double][Double]`>()`
268269
*
269-
* `df.`operation`(length, age)`
270+
* `df.`<code>`operation`</code>`(length, age)`
270271
*
271272
*/
272273
interface WithExample
@@ -286,7 +287,7 @@ internal interface SelectingColumns {
286287
* data class Person(val length: Double, val age: Double)
287288
* ```
288289
*
289-
* `df.`operation`(Person::length, Person::age)`
290+
* `df.`<code>`operation`</code>`(Person::length, Person::age)`
290291
*
291292
*/
292293
interface WithExample

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ private interface SetFillNullsOperationArg
4343
* ### This Fill Nulls Overload
4444
*
4545
*/
46+
@ExcludeFromSources
4647
private interface CommonFillNullsFunctionDoc
4748

4849
/**
@@ -124,6 +125,7 @@ internal interface FillNaNs {
124125
}
125126

126127
/** {@set [SelectingColumns.OperationArg] [fillNaNs][fillNaNs]} */
128+
@ExcludeFromSources
127129
internal interface SetFillNaNsOperationArg
128130

129131
/**
@@ -133,6 +135,7 @@ internal interface SetFillNaNsOperationArg
133135
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNaNs.FillNaNsSelectingOptions]}
134136
* ### This Fill NaNs Overload
135137
*/
138+
@ExcludeFromSources
136139
private interface CommonFillNaNsFunctionDoc
137140

138141
/**
@@ -194,6 +197,7 @@ internal interface FillNA {
194197
}
195198

196199
/** {@set [SelectingColumns.OperationArg] [fillNA][fillNA]} */
200+
@ExcludeFromSources
197201
internal interface SetFillNAOperationArg
198202

199203
/**
@@ -203,6 +207,7 @@ internal interface SetFillNAOperationArg
203207
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNA.FillNASelectingOptions]}
204208
* ### This Fill NA Overload
205209
*/
210+
@ExcludeFromSources
206211
private interface CommonFillNAFunctionDoc
207212

208213
/**
@@ -240,15 +245,19 @@ public fun <T, C> DataFrame<T>.fillNA(vararg columns: ColumnReference<C>): Updat
240245
// endregion
241246

242247
/** @param columns The [Columns Selector][ColumnsSelector] used to select the columns of this [DataFrame] to drop rows in. */
248+
@ExcludeFromSources
243249
private interface DropDslParam
244250

245251
/** @param columns The [KProperties][KProperty] used to select the columns of this [DataFrame] to drop rows in. */
252+
@ExcludeFromSources
246253
private interface DropKPropertiesParam
247254

248-
/** @param columns The [Strings][String] corresponding to the names of colums in this [DataFrame] to drop rows in. */
255+
/** @param columns The [Strings][String] corresponding to the names of columns in this [DataFrame] to drop rows in. */
256+
@ExcludeFromSources
249257
private interface DropColumnNamesParam
250258

251259
/** @param columns The [Column References][ColumnReference] used to select the columns of this [DataFrame] to drop rows in. */
260+
@ExcludeFromSources
252261
private interface DropColumnAccessorsParam
253262

254263
// region dropNulls
@@ -265,6 +274,7 @@ private interface DropColumnAccessorsParam
265274
*
266275
* For more information: {@include [DocumentationUrls.Drop.DropNulls]}
267276
*/
277+
@ExcludeFromSources
268278
internal interface DropNulls {
269279

270280
/**
@@ -282,12 +292,14 @@ internal interface DropNulls {
282292
}
283293

284294
/** {@set [SelectingColumns.OperationArg] [dropNulls][dropNulls]} */
295+
@ExcludeFromSources
285296
private interface SetDropNullsOperationArg
286297

287298
/**
288299
* @include [DropNulls] {@comment Description of the dropNulls operation.}
289300
* ### This Drop Nulls Overload
290301
*/
302+
@ExcludeFromSources
291303
private interface CommonDropNullsFunctionDoc
292304

293305
/**
@@ -364,6 +376,7 @@ public fun <T> DataColumn<T?>.dropNulls(): DataColumn<T> =
364376
*
365377
* For more information: {@include [DocumentationUrls.Drop.DropNA]}
366378
*/
379+
@ExcludeFromSources
367380
internal interface DropNA {
368381

369382
/**
@@ -381,12 +394,14 @@ internal interface DropNA {
381394
}
382395

383396
/** {@set [SelectingColumns.OperationArg] [dropNA][dropNA]} */
397+
@ExcludeFromSources
384398
private interface SetDropNAOperationArg
385399

386400
/**
387401
* @include [DropNA] {@comment Description of the dropNA operation.}
388402
* ### This Drop NA Overload
389403
*/
404+
@ExcludeFromSources
390405
private interface CommonDropNAFunctionDoc
391406

392407
/**
@@ -466,6 +481,7 @@ public fun <T> DataColumn<T?>.dropNA(): DataColumn<T> =
466481
*
467482
* For more information: {@include [DocumentationUrls.Drop.DropNaNs]}
468483
*/
484+
@ExcludeFromSources
469485
internal interface DropNaNs {
470486

471487
/**
@@ -483,12 +499,14 @@ internal interface DropNaNs {
483499
}
484500

485501
/** {@set [SelectingColumns.OperationArg] [dropNaNs][dropNaNs]} */
502+
@ExcludeFromSources
486503
private interface SetDropNaNsOperationArg
487504

488505
/**
489506
* @include [DropNaNs] {@comment Description of the dropNaNs operation.}
490507
* ### This Drop NaNs Overload
491508
*/
509+
@ExcludeFromSources
492510
private interface CommonDropNaNsFunctionDoc
493511

494512
/**

0 commit comments

Comments
 (0)