Skip to content

KDoc fixes for IntelliJ 2024.X #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Apr 16, 2024
Merged

KDoc fixes for IntelliJ 2024.X #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5adda19
fixing several ` ` kdoc issues
Jolanrensen Mar 1, 2024
5cf0391
fixup! fixing several ` ` kdoc issues
Jolanrensen Mar 4, 2024
feb3206
fixup! fixup! fixing several ` ` kdoc issues
Jolanrensen Mar 6, 2024
669b1e8
fixing kdocs in update and nulls
Jolanrensen Mar 7, 2024
c49796d
Merge branch 'refs/heads/master' into kdoc-fixes
Jolanrensen Mar 18, 2024
d3ef255
Fixing ` ` in allExcept
Jolanrensen Mar 18, 2024
c00efab
Fixing ` ` in and.kt
Jolanrensen Mar 18, 2024
0a388b7
Fixing ` ` in col and colGroup
Jolanrensen Mar 19, 2024
39c9c3b
Merge branch 'refs/heads/master' into kdoc-fixes
Jolanrensen Mar 26, 2024
51c422f
fixed and kdocs
Jolanrensen Mar 26, 2024
3ad0ceb
many kdocs space and code-span fixes across all functions
Jolanrensen Mar 27, 2024
b40340f
minimal kdoc fixes for colsAtAnyDepth.kt
Jolanrensen Apr 3, 2024
01b96e5
bumped docProcessor to 0.3.5
Jolanrensen Apr 12, 2024
1fd3cd5
Merge branch 'refs/heads/master' into kdoc-fixes
Jolanrensen Apr 16, 2024
175773b
Merge remote-tracking branch 'origin/kdoc-fixes' into kdoc-fixes
Jolanrensen Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@ val installGitPreCommitHook by tasks.creating(Copy::class) {
} else {
logger.lifecycle("'.git/hooks' directory not found. Skipping installation of pre-commit hook.")
}

}
tasks.named("assemble") {
dependsOn(installGitPreCommitHook)
Expand Down
323 changes: 140 additions & 183 deletions ...erated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
View file
Open in desktop

Large diffs are not rendered by default.

490 changes: 63 additions & 427 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/Nulls.kt
View file
Open in desktop

Large diffs are not rendered by default.

5,061 changes: 1,702 additions & 3,359 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/all.kt
View file
Open in desktop

Large diffs are not rendered by default.

918 changes: 468 additions & 450 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/allExcept.kt
View file
Open in desktop

Large diffs are not rendered by default.

218 changes: 109 additions & 109 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/and.kt
View file
Open in desktop

Large diffs are not rendered by default.

249 changes: 124 additions & 125 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/col.kt
View file
Open in desktop

Large diffs are not rendered by default.

268 changes: 134 additions & 134 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroup.kt
View file
Open in desktop

Large diffs are not rendered by default.

62 changes: 31 additions & 31 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colGroups.kt
View file
Open in desktop

Large diffs are not rendered by default.

1,628 changes: 814 additions & 814 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/cols.kt
View file
Open in desktop

Large diffs are not rendered by default.

122 changes: 61 additions & 61 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsAtAnyDepth.kt
View file
Open in desktop

Large diffs are not rendered by default.

74 changes: 37 additions & 37 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsInGroups.kt
View file
Open in desktop

Large diffs are not rendered by default.

108 changes: 54 additions & 54 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOf.kt
View file
Open in desktop

Large diffs are not rendered by default.

60 changes: 30 additions & 30 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOfKind.kt
View file
Open in desktop

Large diffs are not rendered by default.

152 changes: 75 additions & 77 deletions ...enerated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnNameFilters.kt
View file
Open in desktop

Large diffs are not rendered by default.

74 changes: 24 additions & 50 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnRange.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
import org.jetbrains.kotlinx.dataframe.documentation.AccessApiLink
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
import org.jetbrains.kotlinx.dataframe.documentation.ExcludeFromSources
import org.jetbrains.kotlinx.dataframe.impl.columns.addPath
import org.jetbrains.kotlinx.dataframe.impl.columns.createColumnSet
import kotlin.reflect.KProperty
Expand All @@ -30,10 +31,10 @@ public interface ColumnRangeColumnsSelectionDsl {
*     
*
* ### Definitions:
* `column: `[ColumnAccessor][org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor]` | `[String][String]
* `column: `[`ColumnAccessor`][org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor]` | `[`String`][String]
*
*            
* `| `[KProperty][kotlin.reflect.KProperty]`<*> | `[ColumnPath][org.jetbrains.kotlinx.dataframe.columns.ColumnPath]
* `| `[`KProperty`][kotlin.reflect.KProperty]`<*> | `[`ColumnPath`][org.jetbrains.kotlinx.dataframe.columns.ColumnPath]
*
* &nbsp;&nbsp;&nbsp;&nbsp;
*
Expand All @@ -42,7 +43,7 @@ public interface ColumnRangeColumnsSelectionDsl {
*
* &nbsp;&nbsp;&nbsp;&nbsp;
*
* [column][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef] [**..**][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.rangeTo] [column][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]
* [`column`][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]` `[**`..`**][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.rangeTo]` `[`column`][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]
*
*
*
Expand All @@ -61,51 +62,24 @@ public interface ColumnRangeColumnsSelectionDsl {
*/
public interface Grammar {

/** [**..**][ColumnsSelectionDsl.rangeTo] */
/** [**`..`**][ColumnsSelectionDsl.rangeTo] */
public interface PlainDslName
}

/**
* ## Range of Columns
* Creates a [ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar]
*
* #### For example:
*
* `df.`[select][DataFrame.select]` { `` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
* @return A [ColumnSet] containing all columns from [this] to [endInclusive].
* @throws [IllegalArgumentException] if the columns have different parents or the end column is before the
* start column.
* @see [ColumnsSelectionDsl.allBefore]
* @see [ColumnsSelectionDsl.allAfter]
* @see [ColumnsSelectionDsl.allFrom]
* @see [ColumnsSelectionDsl.allUpTo]
*/
private interface CommonRangeOfColumnsDocs {

/** Examples key */
interface Example
}


/**
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `"fromColumn"[`..`][String.rangeTo]"toColumn"` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`"fromColumn"`[`..`][String.rangeTo]`"toColumn"`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -125,14 +99,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `"fromColumn"[`..`][String.rangeTo]Type::toColumn` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`"fromColumn"`[`..`][String.rangeTo]`Type::toColumn`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -152,14 +126,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `"fromColumn"[`..`][String.rangeTo]toColumn` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`"fromColumn"`[`..`][String.rangeTo]`toColumn`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -179,14 +153,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `Type::fromColumn[`..`][KProperty.rangeTo]"toColumn"` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`Type::fromColumn`[`..`][KProperty.rangeTo]`"toColumn"`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -206,14 +180,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `Type::fromColumn[`..`][KProperty.rangeTo]Type::toColumn` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`Type::fromColumn`[`..`][KProperty.rangeTo]`Type::toColumn`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -233,14 +207,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `Type::fromColumn[`..`][KProperty.rangeTo]toColumn` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`Type::fromColumn`[`..`][KProperty.rangeTo]`toColumn`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -260,14 +234,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `fromColumn[`..`][ColumnReference.rangeTo]"toColumn"` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`fromColumn`[`..`][ColumnReference.rangeTo]`"toColumn"`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -287,14 +261,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `fromColumn[`..`][ColumnReference.rangeTo]Type::toColumn` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`fromColumn`[`..`][ColumnReference.rangeTo]`Type::toColumn`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand All @@ -314,14 +288,14 @@ public interface ColumnRangeColumnsSelectionDsl {
* ## Range of Columns
* Creates a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet] containing all columns from [this] up to (and including) [endInclusive].
*
* Columns inside of column groups are also supported (as long as they share the same direct parent),
* Columns inside column groups are also supported (as long as they share the same direct parent),
* as well as any combination of [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi].
*
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.ColumnRangeColumnsSelectionDsl.Grammar]
*
* #### For example:
*
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `fromColumn[`..`][ColumnReference.rangeTo]toColumn` }`
* `df.`[select][org.jetbrains.kotlinx.dataframe.DataFrame.select]` { `<code>`fromColumn`[`..`][ColumnReference.rangeTo]`toColumn`</code>` }`
*
* @param [endInclusive] The last column in the subset.
* @receiver The first column in the subset.
Expand Down
10 changes: 5 additions & 5 deletions core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/distinct.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public interface DistinctColumnsSelectionDsl {
* &nbsp;&nbsp;&nbsp;&nbsp;
*
* ### Definitions:
* `columnSet: `[ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]`<*>`
* `columnSet: `[`ColumnSet`][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]`<*>`
*
*
*
Expand All @@ -77,9 +77,9 @@ public interface DistinctColumnsSelectionDsl {
*
* &nbsp;&nbsp;&nbsp;&nbsp;
*
* [columnSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetDef]
* [`columnSet`][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetDef]
*
* &nbsp;&nbsp;&nbsp;&nbsp;.[**distinct**][org.jetbrains.kotlinx.dataframe.api.DistinctColumnsSelectionDsl.distinct]**`()`**
* &nbsp;&nbsp;&nbsp;&nbsp;__`.`__[**`distinct`**][org.jetbrains.kotlinx.dataframe.api.DistinctColumnsSelectionDsl.distinct]**`()`**
*
*
*
Expand All @@ -97,7 +97,7 @@ public interface DistinctColumnsSelectionDsl {
*/
public interface Grammar {

/** .[**distinct**][ColumnsSelectionDsl.distinct] */
/** __`.`__[**`distinct`**][ColumnsSelectionDsl.distinct] */
public interface ColumnSetName
}

Expand All @@ -114,7 +114,7 @@ public interface DistinctColumnsSelectionDsl {
* #### For Example:
* `df.`[select][DataFrame.select]` { (`[colsOf][SingleColumn.colsOf]`<`[Int][Int]`>() `[and][ColumnsSelectionDsl.and]` age).`[distinct][ColumnSet.distinct]`() }`
*
* `df.`[select][DataFrame.select]` { `[colsAtAnyDepth][ColumnsSelectionDsl.colsAtAnyDepth]`().`[nameStartsWith][ColumnsSelectionDsl.nameStartsWith]`("order").`[distinct][ColumnSet.distinct]`() }`
* `df.`[select][DataFrame.select]` { `[colsAtAnyDepth][ColumnsSelectionDsl.colsAtAnyDepth]`().`[nameStartsWith][ColumnsSelectionDsl.nameStartsWith]`("order").`[distinct][ColumnSet.distinct]`() }`
*
* @return A new [ColumnSet] containing only distinct columns (by path).
* @see ColumnsSelectionDsl.named
Expand Down
Loading