Skip to content

Commit 61e01c8

Browse files
committed
updated plugin, fixes newlines and links in @include
1 parent 8ed0907 commit 61e01c8

File tree

5 files changed

+25
-24
lines changed

5 files changed

+25
-24
lines changed

core/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ plugins {
1818
id("org.jetbrains.kotlinx.kover")
1919
id("org.jmailen.kotlinter")
2020
id("org.jetbrains.kotlinx.dataframe")
21-
id("com.github.jolanrensen.docProcessorGradlePlugin") version "v0.0.22"
21+
id("com.github.jolanrensen.docProcessorGradlePlugin") version "v0.0.24"
2222
// id("nl.jolanrensen.docProcessor") version "1.0-SNAPSHOT"
2323
}
2424

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

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,6 @@ public fun <T, C> DataFrame<T>.update(columns: ColumnsSelector<T, C>): Update<T,
149149
*
150150
* `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`("length", "age")`
151151
*
152-
*
153152
* ## Optional
154153
* Combine `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(...).`[with][org.jetbrains.kotlinx.dataframe.api.Update.with]` { ... }`
155154
* into `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(...) { ... }`
@@ -178,7 +177,6 @@ public fun <T> DataFrame<T>.update(vararg columns: String): Update<T, Any?> = up
178177
*
179178
* `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(Person::length, Person::age)`
180179
*
181-
*
182180
* ## Optional
183181
* Combine `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(...).`[with][org.jetbrains.kotlinx.dataframe.api.Update.with]` { ... }`
184182
* into `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(...) { ... }`
@@ -209,7 +207,6 @@ public fun <T, C> DataFrame<T>.update(vararg columns: KProperty<C>): Update<T, C
209207
*
210208
* `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(length, age)`
211209
*
212-
*
213210
* ## Optional
214211
* Combine `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(...).`[with][org.jetbrains.kotlinx.dataframe.api.Update.with]` { ... }`
215212
* into `df.`[update][org.jetbrains.kotlinx.dataframe.api.update]`(...) { ... }`
@@ -228,7 +225,6 @@ public fun <T, C> DataFrame<T>.update(columns: Iterable<ColumnReference<C>>): Up
228225

229226
/**
230227
* ## Where
231-
*
232228
* Filter or find rows to operate on after [selecting columns][org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns] using a
233229
* [row value filter][org.jetbrains.kotlinx.dataframe.RowValueFilter].
234230
*
@@ -269,7 +265,7 @@ private interface CommonUpdateAtFunctionDoc {
269265
* ## At
270266
* Only update the columns at certain given [row indices][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]:
271267
*
272-
* Either a [Collection][Collection]< [Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
268+
* Either a [Collection][Collection]<[Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
273269
*
274270
* For example:
275271
*
@@ -281,15 +277,15 @@ private interface CommonUpdateAtFunctionDoc {
281277
*
282278
* Provide a [Collection]<[Int]> of row indices to update.
283279
*
284-
* @param rowIndices The indices of the rows to update. Either a [Collection][Collection]< [Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
280+
* @param rowIndices The indices of the rows to update. Either a [Collection][Collection]<[Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
285281
*/
286282
public fun <T, C> Update<T, C>.at(rowIndices: Collection<Int>): Update<T, C> = where { index in rowIndices }
287283

288284
/**
289285
* ## At
290286
* Only update the columns at certain given [row indices][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]:
291287
*
292-
* Either a [Collection][Collection]< [Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
288+
* Either a [Collection][Collection]<[Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
293289
*
294290
* For example:
295291
*
@@ -301,15 +297,15 @@ public fun <T, C> Update<T, C>.at(rowIndices: Collection<Int>): Update<T, C> = w
301297
*
302298
* Provide a `vararg` of [Ints][Int] of row indices to update.
303299
*
304-
* @param rowIndices The indices of the rows to update. Either a [Collection][Collection]< [Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
300+
* @param rowIndices The indices of the rows to update. Either a [Collection][Collection]<[Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
305301
*/
306302
public fun <T, C> Update<T, C>.at(vararg rowIndices: Int): Update<T, C> = at(rowIndices.toSet())
307303

308304
/**
309305
* ## At
310306
* Only update the columns at certain given [row indices][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]:
311307
*
312-
* Either a [Collection][Collection]< [Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
308+
* Either a [Collection][Collection]<[Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
313309
*
314310
* For example:
315311
*
@@ -321,13 +317,12 @@ public fun <T, C> Update<T, C>.at(vararg rowIndices: Int): Update<T, C> = at(row
321317
*
322318
* Provide an [IntRange] of row indices to update.
323319
*
324-
* @param rowRange The indices of the rows to update. Either a [Collection][Collection]< [Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
320+
* @param rowRange The indices of the rows to update. Either a [Collection][Collection]<[Int][Int]>, an [IntRange][IntRange], or just `vararg` indices.
325321
*/
326322
public fun <T, C> Update<T, C>.at(rowRange: IntRange): Update<T, C> = where { index in rowRange }
327323

328324
/**
329325
* ## Per Row Col
330-
*
331326
* Provide a new value for every selected cell given both its row and column using a [row-column expression][org.jetbrains.kotlinx.dataframe.RowColumnExpression].
332327
*
333328
* For example:
@@ -360,7 +355,6 @@ public typealias UpdateExpression<T, C, R> = AddDataRow<T>.(C) -> R
360355

361356
/**
362357
* ## With
363-
*
364358
* Provide a new value for every selected cell given its row and its previous value using a
365359
* [row value expression][org.jetbrains.kotlinx.dataframe.RowValueExpression].
366360
*
@@ -373,7 +367,6 @@ public typealias UpdateExpression<T, C, R> = AddDataRow<T>.(C) -> R
373367
*
374368
*
375369
* ## Note
376-
*
377370
* [update with][org.jetbrains.kotlinx.dataframe.api.Update.with]- and [add][org.jetbrains.kotlinx.dataframe.api.add]-like expressions use [AddDataRow][org.jetbrains.kotlinx.dataframe.api.AddDataRow] instead of [DataRow][org.jetbrains.kotlinx.dataframe.DataRow] as the DSL's receiver type.
378371
* This is an extension to [RowValueExpression][org.jetbrains.kotlinx.dataframe.RowValueExpression] and
379372
* [RowExpression][org.jetbrains.kotlinx.dataframe.RowExpression] that provides access to
@@ -396,7 +389,6 @@ private interface SeeAlsoWith
396389
*
397390
* Updates selected [column group][ColumnGroup] as a [DataFrame] with the given [expression].
398391
*
399-
*
400392
* Provide a new value for every selected data frame using a [dataframe expression][org.jetbrains.kotlinx.dataframe.DataFrameExpression].
401393
*
402394
* For example:
@@ -535,7 +527,6 @@ public fun <T, C> Update<T, C>.perCol(values: AnyRow): DataFrame<T> = perCol(val
535527
* - [Update with][org.jetbrains.kotlinx.dataframe.api.Update.with] to provide a new value for every selected cell giving its row.
536528
* - [Update per row col][org.jetbrains.kotlinx.dataframe.api.Update.perRowCol] to provide a new value for every selected cell giving its row and column.
537529
* ## This Per Col Overload
538-
*
539530
* Provide a new value for every selected cell given its column using a [column expression][org.jetbrains.kotlinx.dataframe.ColumnExpression].
540531
*
541532
* For example:
@@ -626,7 +617,6 @@ public fun <T, C> Update<T, C?>.notNull(expression: UpdateExpression<T, C, C>):
626617
* Select columns using [column accessors][org.jetbrains.kotlinx.dataframe.columns.ColumnReference]
627618
* ([Column Accessors API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi.ColumnAccessorsApi]).
628619
*
629-
*
630620
* Provide a new value for every selected cell given its row and its previous value using a
631621
* [row value expression][org.jetbrains.kotlinx.dataframe.RowValueExpression].
632622
*
@@ -664,7 +654,6 @@ public fun <T, C> DataFrame<T>.update(
664654
*
665655
* Select columns using [KProperties][KProperty] ([KProperties API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi.KPropertiesApi]).
666656
*
667-
*
668657
* Provide a new value for every selected cell given its row and its previous value using a
669658
* [row value expression][org.jetbrains.kotlinx.dataframe.RowValueExpression].
670659
*
@@ -703,7 +692,6 @@ public fun <T, C> DataFrame<T>.update(
703692
* Select columns using their [column names][String]
704693
* ([String API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi.StringApi]).
705694
*
706-
*
707695
* Provide a new value for every selected cell given its row and its previous value using a
708696
* [row value expression][org.jetbrains.kotlinx.dataframe.RowValueExpression].
709697
*
@@ -742,7 +730,6 @@ private interface CommonSpecificWithDocSecondArg
742730

743731
/**
744732
* ## With Null
745-
*
746733
* Specific version of [with][org.jetbrains.kotlinx.dataframe.api.with] that simply sets the value of each selected row to `null`.
747734
*
748735
* For example:
@@ -753,7 +740,6 @@ public fun <T, C> Update<T, C>.withNull(): DataFrame<T> = with { null }
753740

754741
/**
755742
* ## With Zero
756-
*
757743
* Specific version of [with][org.jetbrains.kotlinx.dataframe.api.with] that simply sets the value of each selected row to `0`.
758744
*
759745
* For example:
@@ -764,7 +750,6 @@ public fun <T, C> Update<T, C>.withZero(): DataFrame<T> = updateWithValuePerColu
764750

765751
/**
766752
* ## With Value
767-
*
768753
* Specific version of [with][org.jetbrains.kotlinx.dataframe.api.with] that simply sets the value of each selected row to [value].
769754
*
770755
* For example:

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@ package org.jetbrains.kotlinx.dataframe.documentation
22

33
import org.jetbrains.kotlinx.dataframe.DataFrame
44
import org.jetbrains.kotlinx.dataframe.DataRow
5-
import org.jetbrains.kotlinx.dataframe.api.*
5+
import org.jetbrains.kotlinx.dataframe.api.AddDataRow
6+
import org.jetbrains.kotlinx.dataframe.api.Convert
7+
import org.jetbrains.kotlinx.dataframe.api.Update
8+
import org.jetbrains.kotlinx.dataframe.api.add
9+
import org.jetbrains.kotlinx.dataframe.api.insert
10+
import org.jetbrains.kotlinx.dataframe.api.map
11+
import org.jetbrains.kotlinx.dataframe.api.notNull
12+
import org.jetbrains.kotlinx.dataframe.api.with
613
import org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.AddDataRowNote
714
import org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowExpressionLink
815
import org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpressionLink

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ExpressionsGivenRow.kt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@ package org.jetbrains.kotlinx.dataframe.documentation
22

33
import org.jetbrains.kotlinx.dataframe.DataFrame
44
import org.jetbrains.kotlinx.dataframe.DataRow
5-
import org.jetbrains.kotlinx.dataframe.api.*
5+
import org.jetbrains.kotlinx.dataframe.api.AddDataRow
6+
import org.jetbrains.kotlinx.dataframe.api.Convert
7+
import org.jetbrains.kotlinx.dataframe.api.Update
8+
import org.jetbrains.kotlinx.dataframe.api.add
9+
import org.jetbrains.kotlinx.dataframe.api.insert
10+
import org.jetbrains.kotlinx.dataframe.api.map
11+
import org.jetbrains.kotlinx.dataframe.api.notNull
12+
import org.jetbrains.kotlinx.dataframe.api.with
613
import org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.AddDataRowNote
714
import org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowExpressionLink
815
import org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpressionLink
@@ -23,6 +30,7 @@ import org.jetbrains.kotlinx.dataframe.RowValueExpression as DfRowValueExpressio
2330
* (using [RowValueExpression][DfRowValueExpression]).
2431
*
2532
* Note:
33+
*
2634
* @include [AddDataRowNote]
2735
*
2836
* A Row Expression is similar to a {@include [RowConditionLink]} but that expects a [Boolean] as result.

examples/idea-examples/movies/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ application.mainClass.set("org.jetbrains.kotlinx.dataframe.examples.movies.Movie
1616

1717
dependencies {
1818
implementation(project(":core"))
19+
implementation(project(":dataframe-openapi"))
1920
}
2021

2122
tasks.withType<KotlinCompile> {

0 commit comments

Comments
 (0)