Skip to content

Commit 564f433

Browse files
committed
updating doc processor to 0.3.2, fixing \ detection
1 parent 2082645 commit 564f433

File tree

11 files changed

+24
-24
lines changed

11 files changed

+24
-24
lines changed

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/annotations/ImportDataSchema.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public annotation class JsonOptions(
6666
* will be created.
6767
*
6868
* Example:
69-
* `["""\$["store"]["book"][*]["author"]"""]`
69+
* `["""$["store"]["book"][*]["author"]"""]`
7070
*/
7171
public val keyValuePaths: Array<String> = [],
7272
)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import java.io.Serializable
55

66
/**
77
* Simplistic JSON path implementation.
8-
* Supports just keys (in bracket notation), double quotes, arrays and wildcards.
8+
* Supports just keys (in bracket notation), double quotes, arrays, and wildcards.
99
*
1010
* Examples:
11-
* `[*]["author"]`
11+
* `$["store"]["book"][*]["author"]`
1212
*
13-
* `` will match ``
13+
* `$[1]` will match `$[*]`
1414
*/
1515
@JvmInline
1616
public value class JsonPath(@Language("jsonpath") public val path: String = "$") : Serializable {

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ public fun <T> ColumnGroup<T>.asDataFrame(): DataFrame<T> = this
154154
/**
155155
* ## As ColumnGroup
156156
*
157-
* Creates a [ColumnAccessor][ColumnAccessor]`<`[DataRow][DataRow]`<`[C][C\]`>>` from [this][this\].
157+
* Creates a [ColumnAccessor][ColumnAccessor]`<`[DataRow][DataRow]`<`[C][C]`>>` from [this][this].
158158
* This is especially useful when you want to use [ColumnGroup] functions in the [ColumnsSelectionDsl] but your column
159159
* type is not recognized as a [ColumnGroup].
160-
* If you're not sure whether a column is recognized as [ColumnGroup] or not, you can always call [asColumnGroup][asColumnGroup\]
160+
* If you're not sure whether a column is recognized as [ColumnGroup] or not, you can always call [asColumnGroup][asColumnGroup]
161161
* and it will return the same type if it is already a [ColumnGroup].
162162
*
163163
* NOTE: This does not check whether the column is actually a [ColumnGroup] or not. It just casts it.
@@ -166,9 +166,9 @@ public fun <T> ColumnGroup<T>.asDataFrame(): DataFrame<T> = this
166166
*
167167
* `df.`[select][DataFrame.select]` { `[first][ColumnsSelectionDsl.first]`().`[asColumnGroup][SingleColumn.asColumnGroup]`().`[firstCol][ColumnsSelectionDsl.firstCol]`() }`
168168
*
169-
* @receiver The column reference to cast to a [SingleColumn]`<`[DataRow][DataRow]`<`[C][C\]`>>`.
170-
* @param [C\] The type of the (group) column.
171-
* @return A [SingleColumn]`<`[DataRow][DataRow]`<`[C][C\]`>>`.
169+
* @receiver The column reference to cast to a [SingleColumn]`<`[DataRow][DataRow]`<`[C][C]`>>`.
170+
* @param [C] The type of the (group) column.
171+
* @return A [SingleColumn]`<`[DataRow][DataRow]`<`[C][C]`>>`.
172172
*/
173173
private interface SingleColumnAsColumnGroupDocs
174174

@@ -280,7 +280,7 @@ public enum class Infer {
280280
Type;
281281

282282
/**
283-
* @param [infer\] [An enum][Infer] that indicates how [DataColumn.type] should be calculated.
283+
* @param [infer] [An enum][Infer] that indicates how [DataColumn.type] should be calculated.
284284
* Either [None], [Nulls], or [Type].
285285
*/
286286
internal interface ParamDoc

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ public interface ColColumnsSelectionDsl {
194194
/* Optional note */
195195
interface Note
196196

197-
/** @param [C\] The type of the column. */
197+
/** @param [C] The type of the column. */
198198
interface ColumnTypeParam
199199
}
200200

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ public interface ColGroupColumnsSelectionDsl {
197197
/* Optional note */
198198
interface Note
199199

200-
/** @param [C\] The type of the column group. */
200+
/** @param [C] The type of the column group. */
201201
interface ColumnGroupTypeParam
202202
}
203203

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,10 @@ public interface ColsOfColumnsSelectionDsl {
179179
*/
180180
private interface CommonColsOfDocs {
181181

182-
/** @return A [ColumnSet] containing the columns of given type that were included by [filter\]. */
182+
/** @return A [ColumnSet] containing the columns of given type that were included by [filter]. */
183183
interface Return
184184

185-
/** @param [filter\] an optional filter function that takes a column of type [C\] and returns `true` if the column should be included. */
185+
/** @param [filter] an optional filter function that takes a column of type [C] and returns `true` if the column should be included. */
186186
interface FilterParam
187187
}
188188

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ public interface FrameColColumnsSelectionDsl {
195195
/* Optional note */
196196
interface Note
197197

198-
/** @param [C\] The type of the frame column. */
198+
/** @param [C] The type of the frame column. */
199199
interface FrameColumnTypeParam
200200
}
201201

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,16 +181,16 @@ public data class Update<T, C>(
181181
*/
182182
public interface UpdateSelectingOptions
183183

184-
/** @param [columns\] The [Columns Selector][ColumnsSelector] used to select the columns of this [DataFrame] to update. */
184+
/** @param [columns] The [Columns Selector][ColumnsSelector] used to select the columns of this [DataFrame] to update. */
185185
internal interface DslParam
186186

187-
/** @param [columns\] The [Column References][ColumnReference] of this [DataFrame] to update. */
187+
/** @param [columns] The [Column References][ColumnReference] of this [DataFrame] to update. */
188188
internal interface ColumnAccessorsParam
189189

190-
/** @param [columns\] The [KProperties][KProperty] corresponding to columns of this [DataFrame] to update. */
190+
/** @param [columns] The [KProperties][KProperty] corresponding to columns of this [DataFrame] to update. */
191191
internal interface KPropertiesParam
192192

193-
/** @param [columns\] The [Strings][String] corresponding to the names of columns belonging to this [DataFrame] to update. */
193+
/** @param [columns] The [Strings][String] corresponding to the names of columns belonging to this [DataFrame] to update. */
194194
internal interface ColumnNamesParam
195195
}
196196

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ public interface ValueColColumnsSelectionDsl {
195195
/* Optional note */
196196
interface Note
197197

198-
/** @param [C\] The type of the value column. */
198+
/** @param [C] The type of the value column. */
199199
interface ValueColumnTypeParam
200200
}
201201

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import java.io.Serializable
55

66
/**
77
* Simplistic JSON path implementation.
8-
* Supports just keys (in bracket notation), double quotes, arrays and wildcards.
8+
* Supports just keys (in bracket notation), double quotes, arrays, and wildcards.
99
*
1010
* Examples:
11-
* `$["store"]["book"][*]["author"]`
11+
* `\$["store"]["book"][*]["author"]`
1212
*
13-
* `$[1]` will match `$[*]`
13+
* `\$[1]` will match `\$[*]`
1414
*/
1515
@JvmInline
1616
public value class JsonPath(@Language("jsonpath") public val path: String = "$") : Serializable {

0 commit comments

Comments
 (0)