Skip to content

Commit 6adaa75

Browse files
JolanrensenJolanrensen
committed
Replaced all bodiless documentation interfaces with "free" Nothing-type-aliases in :dataframe-csv
1 parent b60905c commit 6adaa75

File tree

6 files changed

+47
-47
lines changed

6 files changed

+47
-47
lines changed

‎dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/CommonReadDelimDocs.kt‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ internal interface CommonReadDelimDocs {
6060
* @set [FUNCTION_NAME] readCsv
6161
* @set [OLD_FUNCTION_NAME] readCSV
6262
*/
63-
interface CsvDocs
63+
typealias CsvDocs = Nothing
6464

6565
/**
6666
* @include [CommonReadDelimDocs]
@@ -70,7 +70,7 @@ internal interface CommonReadDelimDocs {
7070
* @set [FUNCTION_NAME] readTsv
7171
* @set [OLD_FUNCTION_NAME] readTSV
7272
*/
73-
interface TsvDocs
73+
typealias TsvDocs = Nothing
7474

7575
/**
7676
* @include [CommonReadDelimDocs]
@@ -80,7 +80,7 @@ internal interface CommonReadDelimDocs {
8080
* @set [FUNCTION_NAME] readDelim
8181
* @set [OLD_FUNCTION_NAME] readDelim{@comment cannot differentiate between old and new}
8282
*/
83-
interface DelimDocs
83+
typealias DelimDocs = Nothing
8484

8585
/**
8686
* @include [DelimParams.HEADER]
@@ -98,35 +98,35 @@ internal interface CommonReadDelimDocs {
9898
* @include [DelimParams.TRIM_INSIDE_QUOTED]
9999
* @include [DelimParams.PARSE_PARALLEL]
100100
*/
101-
interface CommonReadParams
101+
typealias CommonReadParams = Nothing
102102

103103
// something like "File" or "File/URL"
104-
interface DATA_TITLE
104+
typealias DATA_TITLE = Nothing
105105

106106
// something like "file" or "file or url"
107-
interface DATA
107+
typealias DATA = Nothing
108108

109109
// Like "CSV" or "TSV", capitalized
110-
interface FILE_TYPE_TITLE
110+
typealias FILE_TYPE_TITLE = Nothing
111111

112112
// Like "CSV" or "TSV"
113-
interface FILE_TYPE
113+
typealias FILE_TYPE = Nothing
114114

115115
// like "csv" or "txt"
116-
interface FILE_EXTENSION
116+
typealias FILE_EXTENSION = Nothing
117117

118118
// Function name, like "readCsv"
119-
interface FUNCTION_NAME
119+
typealias FUNCTION_NAME = Nothing
120120

121121
// Old function name, like "readCSV"
122-
interface OLD_FUNCTION_NAME
122+
typealias OLD_FUNCTION_NAME = Nothing
123123

124124
// A link to the main function, set by ReadDelim itself
125-
interface FUNCTION_LINK
125+
typealias FUNCTION_LINK = Nothing
126126

127127
// A link to the str function, set by ReadDelim itself
128-
interface STR_FUNCTION_LINK
128+
typealias STR_FUNCTION_LINK = Nothing
129129

130130
// A link to the old function, set by ReadDelim itself
131-
interface OLD_FUNCTION_LINK
131+
typealias OLD_FUNCTION_LINK = Nothing
132132
}

‎dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/CommonWriteDelimDocs.kt‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ internal interface CommonWriteDelimDocs {
4444
* @set [FUNCTION_NAME] writeCsv
4545
* @set [TO_STR_FUNCTION_NAME] toCsvStr
4646
*/
47-
interface CsvDocs
47+
typealias CsvDocs = Nothing
4848

4949
/**
5050
* @include [CommonWriteDelimDocs]
@@ -54,7 +54,7 @@ internal interface CommonWriteDelimDocs {
5454
* @set [FUNCTION_NAME] writeTsv
5555
* @set [TO_STR_FUNCTION_NAME] toTsvStr
5656
*/
57-
interface TsvDocs
57+
typealias TsvDocs = Nothing
5858

5959
/**
6060
* @include [CommonWriteDelimDocs]
@@ -64,7 +64,7 @@ internal interface CommonWriteDelimDocs {
6464
* @set [FUNCTION_NAME] writeDelim
6565
* @set [TO_STR_FUNCTION_NAME] toDelimStr
6666
*/
67-
interface DelimDocs
67+
typealias DelimDocs = Nothing
6868

6969
/**
7070
* @include [DelimParams.INCLUDE_HEADER]
@@ -75,35 +75,35 @@ internal interface CommonWriteDelimDocs {
7575
* @include [DelimParams.HEADER_COMMENTS]
7676
* @include [DelimParams.RECORD_SEPARATOR]
7777
*/
78-
interface CommonWriteParams
78+
typealias CommonWriteParams = Nothing
7979

8080
// something like "Write" or "Convert"
81-
interface WRITE_OR_CONVERT
81+
typealias WRITE_OR_CONVERT = Nothing
8282

8383
// Like "CSV" or "TSV", capitalized
84-
interface FILE_TYPE_TITLE
84+
typealias FILE_TYPE_TITLE = Nothing
8585

8686
// something like "File" or "String"
87-
interface DATA_TITLE
87+
typealias DATA_TITLE = Nothing
8888

8989
// something like "file" or "text"
90-
interface DATA
90+
typealias DATA = Nothing
9191

9292
// Like "CSV" or "TSV"
93-
interface FILE_TYPE
93+
typealias FILE_TYPE = Nothing
9494

9595
// like "csv" or "txt"
96-
interface FILE_EXTENSION
96+
typealias FILE_EXTENSION = Nothing
9797

9898
// Function name, like "readCsv"
99-
interface FUNCTION_NAME
99+
typealias FUNCTION_NAME = Nothing
100100

101101
// Function name, like "toCsvStr"
102-
interface TO_STR_FUNCTION_NAME
102+
typealias TO_STR_FUNCTION_NAME = Nothing
103103

104104
// A link to the main function, set by WriteDelim itself
105-
interface FUNCTION_LINK
105+
typealias FUNCTION_LINK = Nothing
106106

107107
// A link to the str function, set by WriteDelim itself
108-
interface TO_STR_FUNCTION_LINK
108+
typealias TO_STR_FUNCTION_LINK = Nothing
109109
}

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,40 +22,40 @@ internal object DelimParams {
2222
* @param path The file path to read.
2323
* Can also be compressed as `.gz` or `.zip`, see [Compression][Compression].
2424
*/
25-
interface PATH_READ
25+
typealias PATH_READ = Nothing
2626

2727
/**
2828
* @param file The file to read.
2929
* Can also be compressed as `.gz` or `.zip`, see [Compression][Compression].
3030
*/
31-
interface FILE_READ
31+
typealias FILE_READ = Nothing
3232

3333
/**
3434
* @param url The URL from which to fetch the data.
3535
* Can also be compressed as `.gz` or `.zip`, see [Compression][Compression].
3636
*/
37-
interface URL_READ
37+
typealias URL_READ = Nothing
3838

3939
/**
4040
* @param fileOrUrl The file path or URL to read the data from.
4141
* Can also be compressed as `.gz` or `.zip`, see [Compression][Compression].
4242
*/
43-
interface FILE_OR_URL_READ
43+
typealias FILE_OR_URL_READ = Nothing
4444

4545
/** @param inputStream Represents the file to read. */
46-
interface INPUT_STREAM_READ
46+
typealias INPUT_STREAM_READ = Nothing
4747

4848
/** @param text The raw data to read in the form of a [String]. */
49-
interface TEXT_READ
49+
typealias TEXT_READ = Nothing
5050

5151
/** @param file The file to write to. */
52-
interface FILE_WRITE
52+
typealias FILE_WRITE = Nothing
5353

5454
/** @param path The path pointing to a file to write to. */
55-
interface PATH_WRITE
55+
typealias PATH_WRITE = Nothing
5656

5757
/** @param writer The [Appendable] to write to. */
58-
interface WRITER_WRITE
58+
typealias WRITER_WRITE = Nothing
5959

6060
/**
6161
* @param delimiter The field delimiter character. Default: ','.

‎dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/DocumentationUrls.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ package org.jetbrains.kotlinx.dataframe.documentationCsv
55
internal interface DocumentationUrls {
66

77
/** [Deephaven CSV](https://github.com/deephaven/deephaven-csv) */
8-
interface Deephaven
8+
typealias Deephaven = Nothing
99

1010
/** [Apache Commons CSV](https://commons.apache.org/proper/commons-csv/) */
11-
interface ApacheCsv
11+
typealias ApacheCsv = Nothing
1212
}

‎dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/utils.kt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,31 @@ import kotlin.annotation.AnnotationTarget.VALUE_PARAMETER
2020
*
2121
*/
2222
@ExcludeFromSources
23-
internal interface LineBreak
23+
internal typealias LineBreak = Nothing
2424

2525
/**   */
2626
@ExcludeFromSources
27-
internal interface QuarterIndent
27+
internal typealias QuarterIndent = Nothing
2828

2929
/**    */
3030
@ExcludeFromSources
31-
internal interface HalfIndent
31+
internal typealias HalfIndent = Nothing
3232

3333
/**      */
3434
@ExcludeFromSources
35-
internal interface Indent
35+
internal typealias Indent = Nothing
3636

3737
/**          */
3838
@ExcludeFromSources
39-
internal interface DoubleIndent
39+
internal typealias DoubleIndent = Nothing
4040

4141
/**              */
4242
@ExcludeFromSources
43-
internal interface TripleIndent
43+
internal typealias TripleIndent = Nothing
4444

4545
/**                  */
4646
@ExcludeFromSources
47-
internal interface QuadrupleIndent
47+
internal typealias QuadrupleIndent = Nothing
4848

4949
/**
5050
* Any `Documentable` annotated with this annotation will be excluded from the generated sources by

‎dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/util.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import org.jetbrains.kotlinx.dataframe.documentationCsv.ExcludeFromSources
66

77
/** [\["", "NA", "N/A", "null", "NULL", "None", "none", "NIL", "nil"\]][DEFAULT_DELIM_NULL_STRINGS] */
88
@ExcludeFromSources
9-
internal interface DefaultNullStringsContentLink
9+
internal typealias DefaultNullStringsContentLink = Nothing
1010

1111
/**
1212
* Default strings that are considered null when reading CSV / TSV / delim files:

0 commit comments

Comments
 (0)