From 5afe512c669e68aea3712ac37b67d005657cf60a Mon Sep 17 00:00:00 2001
From: Marcin Aman <marcin.aman@gmail.com>
Date: Tue, 6 Apr 2021 18:06:42 +0200
Subject: Suppress inherited members (#1814)

---
 core/src/main/kotlin/configuration.kt                               | 2 ++
 core/src/main/kotlin/defaultConfiguration.kt                        | 1 +
 .../main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt | 6 +++++-
 3 files changed, 8 insertions(+), 1 deletion(-)

(limited to 'core')

diff --git a/core/src/main/kotlin/configuration.kt b/core/src/main/kotlin/configuration.kt
index 2b8798d7..56fe8437 100644
--- a/core/src/main/kotlin/configuration.kt
+++ b/core/src/main/kotlin/configuration.kt
@@ -33,6 +33,7 @@ object DokkaDefaults {
     val moduleVersion: String? = null
     val pluginsConfiguration = mutableListOf<PluginConfigurationImpl>()
     const val suppressObviousFunctions = true
+    const val suppressInheritedMembers = false
 }
 
 enum class Platform(val key: String) {
@@ -101,6 +102,7 @@ interface DokkaConfiguration : Serializable {
     val delayTemplateSubstitution: Boolean
     val suppressObviousFunctions: Boolean
     val includes: Set<File>
+    val suppressInheritedMembers: Boolean
 
     enum class SerializationFormat : Serializable {
         JSON, XML
diff --git a/core/src/main/kotlin/defaultConfiguration.kt b/core/src/main/kotlin/defaultConfiguration.kt
index aa91fa1a..743cc6c2 100644
--- a/core/src/main/kotlin/defaultConfiguration.kt
+++ b/core/src/main/kotlin/defaultConfiguration.kt
@@ -18,6 +18,7 @@ data class DokkaConfigurationImpl(
     override val delayTemplateSubstitution: Boolean = false,
     override val suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions,
     override val includes: Set<File> = emptySet(),
+    override val suppressInheritedMembers: Boolean = DokkaDefaults.suppressInheritedMembers,
 ) : DokkaConfiguration
 
 data class PluginConfigurationImpl(
diff --git a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
index c0c449fb..fc26ff98 100644
--- a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
+++ b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
@@ -36,6 +36,7 @@ class TestDokkaConfigurationBuilder {
     var modules: List<DokkaModuleDescriptionImpl> = emptyList()
     var suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions
     var includes: List<File> = emptyList()
+    var suppressInheritedMembers: Boolean = DokkaDefaults.suppressInheritedMembers
     private val lazySourceSets = mutableListOf<Lazy<DokkaSourceSetImpl>>()
 
     fun build() = DokkaConfigurationImpl(
@@ -51,6 +52,7 @@ class TestDokkaConfigurationBuilder {
         failOnWarning = failOnWarning,
         suppressObviousFunctions = suppressObviousFunctions,
         includes = includes.toSet(),
+        suppressInheritedMembers = suppressInheritedMembers,
     )
 
     fun sourceSets(block: SourceSetsBuilder.() -> Unit) {
@@ -194,6 +196,8 @@ fun dPackage(
 )
 
 fun documentationNode(vararg texts: String): DocumentationNode {
-    return DocumentationNode(texts.toList().map { Description(CustomDocTag(listOf(Text(it)), name = MarkdownElementTypes.MARKDOWN_FILE.name)) })
+    return DocumentationNode(
+        texts.toList()
+            .map { Description(CustomDocTag(listOf(Text(it)), name = MarkdownElementTypes.MARKDOWN_FILE.name)) })
 }
 
-- 
cgit