Skip to content

Commit 9e91046

Browse files
committed
fixed kdocs
1 parent 6055995 commit 9e91046

File tree

1 file changed

+16
-4
lines changed
  • dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation

1 file changed

+16
-4
lines changed

dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DelimParams.kt

+16-4
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,28 @@ import org.jetbrains.kotlinx.dataframe.io.QuoteMode
1818
@Suppress("ktlint:standard:class-naming", "ClassName", "KDocUnresolvedReference")
1919
internal object DelimParams {
2020

21-
/** @param path The file path to read. Can also be compressed as `.gz` or `.zip`, see [Compression]. */
21+
/**
22+
* @param path The file path to read.
23+
* Can also be compressed as `.gz` or `.zip`, see [Compression][org.jetbrains.kotlinx.dataframe.io.Compression].
24+
*/
2225
interface PATH_READ
2326

24-
/** @param file The file to read. Can also be compressed as `.gz` or `.zip`, see [Compression]. */
27+
/**
28+
* @param file The file to read.
29+
* Can also be compressed as `.gz` or `.zip`, see [Compression][org.jetbrains.kotlinx.dataframe.io.Compression].
30+
*/
2531
interface FILE_READ
2632

27-
/** @param url The URL from which to fetch the data. Can also be compressed as `.gz` or `.zip`, see [Compression]. */
33+
/**
34+
* @param url The URL from which to fetch the data.
35+
* Can also be compressed as `.gz` or `.zip`, see [Compression][org.jetbrains.kotlinx.dataframe.io.Compression].
36+
*/
2837
interface URL_READ
2938

30-
/** @param fileOrUrl The file path or URL to read the data from. Can also be compressed as `.gz` or `.zip`, see [Compression]. */
39+
/**
40+
* @param fileOrUrl The file path or URL to read the data from.
41+
* Can also be compressed as `.gz` or `.zip`, see [Compression][org.jetbrains.kotlinx.dataframe.io.Compression].
42+
*/
3143
interface FILE_OR_URL_READ
3244

3345
/** @param inputStream Represents the file to read. */

0 commit comments

Comments
 (0)