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)

---
 runners/cli/src/main/kotlin/cli/main.kt                              | 5 +++++
 .../src/main/kotlin/org/jetbrains/dokka/gradle/AbstractDokkaTask.kt  | 4 ++++
 .../src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt | 4 +++-
 .../src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt          | 1 +
 .../src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt   | 1 +
 runners/maven-plugin/src/main/kotlin/DokkaMojo.kt                    | 4 ++++
 6 files changed, 18 insertions(+), 1 deletion(-)

(limited to 'runners')

diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt
index 42ac1806..7c402df5 100644
--- a/runners/cli/src/main/kotlin/cli/main.kt
+++ b/runners/cli/src/main/kotlin/cli/main.kt
@@ -83,6 +83,11 @@ class GlobalArguments(args: Array<String>) : DokkaConfiguration {
 
     override val includes: Set<File> by lazy { _includes.toSet() }
 
+    override val suppressInheritedMembers: Boolean by parser.option(
+        ArgType.Boolean,
+        description = "Suppress members inherited from other classes"
+    ).default(DokkaDefaults.suppressInheritedMembers)
+
     val globalPackageOptions by parser.option(
         ArgType.String,
         description = "List of package source sets in format \"prefix,-deprecated,-privateApi,+warnUndocumented,+suppress;...\" "
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/AbstractDokkaTask.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/AbstractDokkaTask.kt
index ead7b978..c3217722 100644
--- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/AbstractDokkaTask.kt
+++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/AbstractDokkaTask.kt
@@ -47,6 +47,10 @@ abstract class AbstractDokkaTask : DefaultTask() {
     val suppressObviousFunctions: Property<Boolean> = project.objects.safeProperty<Boolean>()
         .safeConvention(DokkaDefaults.suppressObviousFunctions)
 
+    @Input
+    val suppressInheritedMembers: Property<Boolean> = project.objects.safeProperty<Boolean>()
+        .safeConvention(DokkaDefaults.suppressInheritedMembers)
+
     @Input
     val offlineMode: Property<Boolean> = project.objects.safeProperty<Boolean>()
         .safeConvention(DokkaDefaults.offlineMode)
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt
index b0fc5f22..cfe56d52 100644
--- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt
+++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt
@@ -17,7 +17,9 @@ abstract class DokkaCollectorTask : AbstractDokkaParentTask() {
             failOnWarning = failOnWarning.getSafe(),
             offlineMode = offlineMode.getSafe(),
             pluginsClasspath = plugins.resolve().toList(),
-            pluginsConfiguration = buildPluginsConfiguration()
+            pluginsConfiguration = buildPluginsConfiguration(),
+            suppressObviousFunctions = suppressObviousFunctions.getSafe(),
+            suppressInheritedMembers = suppressInheritedMembers.getSafe(),
         )
 
         val subprojectDokkaConfigurations = childDokkaTasks.map { dokkaTask -> dokkaTask.buildDokkaConfiguration() }
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt
index 0d6f35da..eaf4f495 100644
--- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt
+++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt
@@ -44,5 +44,6 @@ abstract class DokkaTask : AbstractDokkaTask() {
             pluginsConfiguration = buildPluginsConfiguration(),
             pluginsClasspath = plugins.resolve().toList(),
             suppressObviousFunctions = suppressObviousFunctions.getSafe(),
+            suppressInheritedMembers = suppressInheritedMembers.getSafe(),
         )
 }
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt
index c2789c19..4513cfea 100644
--- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt
+++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt
@@ -46,6 +46,7 @@ abstract class DokkaTaskPartial : AbstractDokkaTask() {
             pluginsClasspath = plugins.resolve().toList(),
             delayTemplateSubstitution = true,
             suppressObviousFunctions = suppressObviousFunctions.getSafe(),
+            suppressInheritedMembers = suppressInheritedMembers.getSafe(),
         )
     }
 }
\ No newline at end of file
diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
index 3e1916a6..5228f44b 100644
--- a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
+++ b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
@@ -159,6 +159,9 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc
     @Parameter(defaultValue = "${DokkaDefaults.suppressObviousFunctions}")
     var suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions
 
+    @Parameter(defaultValue = "${DokkaDefaults.suppressInheritedMembers}")
+    var suppressInheritedMembers: Boolean = DokkaDefaults.suppressInheritedMembers
+
     @Parameter
     var dokkaPlugins: List<Dependency> = emptyList()
         get() = field + defaultDokkaPlugins
@@ -248,6 +251,7 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc
             modules = emptyList(),
             failOnWarning = failOnWarning,
             suppressObviousFunctions = suppressObviousFunctions,
+            suppressInheritedMembers = suppressInheritedMembers,
         )
 
         val gen = DokkaGenerator(configuration, logger)
-- 
cgit