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)

---
 docs/src/doc/docs/user_guide/cli/usage.md    | 1 +
 docs/src/doc/docs/user_guide/gradle/usage.md | 5 +++++
 docs/src/doc/docs/user_guide/maven/usage.md  | 5 +++++
 3 files changed, 11 insertions(+)

(limited to 'docs/src')

diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md
index 862b161b..4cb9c67e 100644
--- a/docs/src/doc/docs/user_guide/cli/usage.md
+++ b/docs/src/doc/docs/user_guide/cli/usage.md
@@ -21,6 +21,7 @@ Dokka supports the following command line arguments:
   * `-globalLinks` - external documentation links added to all source sets
   * `-globalSrcLink` - source links added to all source sets
   * `-noSuppressObviousFunctions` - don't suppress obvious functions like default `toString` or `equals`
+  * `-suppressInheritedMembers` - suppress all inherited members that were not overriden in a given class. Eg. using it you can suppress toString or equals functions but you can't suppress componentN or copy on data class
   * `-sourceSet` - (repeatable) - configuration for a single source set. Following this argument, you can pass other arguments:
     * `-sourceSetName` - source set name as a part of source set ID when declaring dependent source sets
     * `-displayName` - source set name displayed in the generated documentation
diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md
index 7a7761af..f18d3bc8 100644
--- a/docs/src/doc/docs/user_guide/gradle/usage.md
+++ b/docs/src/doc/docs/user_guide/gradle/usage.md
@@ -92,6 +92,11 @@ dokkaHtml {
 
     // Suppress obvious functions like default toString or equals. Defaults to true
     suppressObviousFunctions.set(false)
+
+    // Suppress all inherited members that were not overriden in a given class. 
+    // Eg. using it you can suppress toString or equals functions but you can't suppress componentN or copy on data class. To do that use with suppressObviousFunctions
+    // Defaults to false
+    suppressInheritedMembers.set(true)
     
     dokkaSourceSets {
         configureEach { // Or source set name, for single-platform the default source sets are `main` and `test`
diff --git a/docs/src/doc/docs/user_guide/maven/usage.md b/docs/src/doc/docs/user_guide/maven/usage.md
index dec0712c..0290d2f7 100644
--- a/docs/src/doc/docs/user_guide/maven/usage.md
+++ b/docs/src/doc/docs/user_guide/maven/usage.md
@@ -88,6 +88,11 @@ The available configuration options are shown below:
         <!-- Suppress obvious functions like default toString or equals. Defaults to true -->
         <suppressObviousFunctions>false</suppressObviousFunctions>
 
+        <!-- Suppress all inherited members that were not overriden in a given class. -->
+        <!-- Eg. using it you can suppress toString or equals functions but you can't suppress componentN or copy on data class. To do that use with suppressObviousFunctions -->
+        <!-- Defaults to false -->
+        <suppressInheritedMembers>true</suppressInheritedMembers>
+
         <!-- Used for linking to JDK, default: 6 -->
         <jdkVersion>6</jdkVersion>
 
-- 
cgit