Skip to content

Commit b880f9c

Browse files
authored
Merge pull request #806 from Kotlin/kdoc-processing-guide
Adding KDoc preprocessing guide
2 parents a55d18b + 2a0a553 commit b880f9c

24 files changed

+691
-0
lines changed

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ has the best support for Kotlin, compiler plugins, Gradle, and [Kotlin Notebook]
9696
* We recommend using the [Ktlint plugin](https://plugins.jetbrains.com/plugin/15057-ktlint) for [IntelliJ IDEA](https://www.jetbrains.com/idea/download/).
9797
It is able to read the `.editorconfig` file and apply the same formatting rules as [Ktlint](https://pinterest.github.io/ktlint/latest/) in the CI.
9898

99+
* Check out the [KDoc Preprocessor guide](KDOC_PREPROCESSING.md) to understand how to work with the KDoc preprocessor.
100+
99101
## Building
100102

101103
This library is built with Gradle.

KDOC_PREPROCESSING.md

+686
Large diffs are not rendered by default.

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

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
1818
import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
1919
import org.jetbrains.kotlinx.dataframe.documentation.DocumentationUrls
2020
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
21+
import org.jetbrains.kotlinx.dataframe.documentation.ExcludeFromSources
2122
import org.jetbrains.kotlinx.dataframe.documentation.Indent
2223
import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
2324
import org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns
@@ -48,12 +49,14 @@ internal interface Select {
4849
}
4950

5051
/** {@set [SelectingColumns.OperationArg] [select][select]} */
52+
@ExcludeFromSources
5153
private interface SetSelectOperationArg
5254

5355
/**
5456
* {@include [Select]}
5557
* ### This Select Overload
5658
*/
59+
@ExcludeFromSources
5760
private interface CommonSelectDocs
5861

5962
/**

docs/imgs/arg1.png

19.4 KB
Loading

docs/imgs/arg2.png

13.8 KB
Loading

docs/imgs/comment1.png

8.02 KB
Loading

docs/imgs/comment2.png

3.79 KB
Loading

docs/imgs/csdsl1.png

60.7 KB
Loading

docs/imgs/csdsl2.png

53.5 KB
Loading

docs/imgs/dslgrammar.png

30.3 KB
Loading

docs/imgs/example.png

3.76 KB
Loading

docs/imgs/excludeFromSources1.png

18.1 KB
Loading

docs/imgs/excludeFromSources2.png

12.6 KB
Loading

docs/imgs/firstdslgrammar.png

39.4 KB
Loading

docs/imgs/include1.png

16.8 KB
Loading

docs/imgs/include2.png

13.3 KB
Loading

docs/imgs/kprops1.png

11.2 KB
Loading

docs/imgs/nonegrammar1.png

34.1 KB
Loading

docs/imgs/nonegrammar2.png

18.6 KB
Loading

docs/imgs/sample1.png

12.6 KB
Loading

docs/imgs/sample2.png

10.5 KB
Loading

docs/imgs/selectingColumns.png

79.8 KB
Loading

docs/imgs/selectop.png

25.9 KB
Loading

docs/imgs/selectop2.png

67.8 KB
Loading

0 commit comments

Comments
 (0)