aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/test
diff options
context:
space:
mode:
authorsebastian.sellmair <sebastian.sellmair@jetbrains.com>2020-06-22 12:15:50 +0200
committerSebastian Sellmair <34319766+sellmair@users.noreply.github.com>2020-06-22 12:55:58 +0200
commitf6530934d36fbb977c2b7c4eb3669a8f581dd9f5 (patch)
tree9e9501347db191fdfebb235d400e20169076222c /plugins/base/src/test
parent442a4651880ec2018728f64028c627776d000e9a (diff)
downloaddokka-f6530934d36fbb977c2b7c4eb3669a8f581dd9f5.tar.gz
dokka-f6530934d36fbb977c2b7c4eb3669a8f581dd9f5.tar.bz2
dokka-f6530934d36fbb977c2b7c4eb3669a8f581dd9f5.zip
Prevent ReportUndocumentedTransformer.kt from reporting "componentN" functions fromd data classes
Diffstat (limited to 'plugins/base/src/test')
-rw-r--r--plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt29
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt b/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt
index 5be60109..fac1e060 100644
--- a/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt
@@ -150,6 +150,35 @@ class ReportUndocumentedTransformerTest : AbstractCoreTest() {
}
}
+ @Test
+ fun `data class component functions do not get reported`() {
+ val configuration = dokkaConfiguration {
+ passes {
+ pass {
+ reportUndocumented = true
+ sourceRoots = listOf("src/main/kotlin")
+ }
+ }
+ }
+
+ testInline(
+ """
+ |/src/main/kotlin/Test.kt
+ |package sample
+ |
+ |/** Documented */
+ |data class X(val x: Int) {
+ |}
+ """.trimIndent(),
+ configuration
+ ) {
+ pagesTransformationStage = {
+ assertNoUndocumentedReport(Regex("component"))
+ assertNumberOfUndocumentedReports(1)
+ }
+ }
+ }
+
@Disabled
@Test
fun `undocumented secondary constructor gets reported`() {