aboutsummaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
Diffstat (limited to 'core')
-rw-r--r--core/src/main/kotlin/configuration.kt2
-rw-r--r--core/src/main/kotlin/defaultConfiguration.kt1
-rw-r--r--core/src/main/kotlin/model/documentableProperties.kt4
-rw-r--r--core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt2
4 files changed, 9 insertions, 0 deletions
diff --git a/core/src/main/kotlin/configuration.kt b/core/src/main/kotlin/configuration.kt
index a3989ebc..1501ab2f 100644
--- a/core/src/main/kotlin/configuration.kt
+++ b/core/src/main/kotlin/configuration.kt
@@ -32,6 +32,7 @@ object DokkaDefaults {
const val sourceSetName = "main"
val moduleVersion: String? = null
val pluginsConfiguration = mutableListOf<PluginConfigurationImpl>()
+ const val suppressObviousFunctions = true
}
enum class Platform(val key: String) {
@@ -98,6 +99,7 @@ interface DokkaConfiguration : Serializable {
val pluginsClasspath: List<File>
val pluginsConfiguration: List<PluginConfiguration>
val delayTemplateSubstitution: Boolean
+ val suppressObviousFunctions: Boolean
enum class SerializationFormat : Serializable {
JSON, XML
diff --git a/core/src/main/kotlin/defaultConfiguration.kt b/core/src/main/kotlin/defaultConfiguration.kt
index 869a99ed..ec1dde8e 100644
--- a/core/src/main/kotlin/defaultConfiguration.kt
+++ b/core/src/main/kotlin/defaultConfiguration.kt
@@ -16,6 +16,7 @@ data class DokkaConfigurationImpl(
override val modules: List<DokkaModuleDescriptionImpl> = emptyList(),
override val failOnWarning: Boolean = DokkaDefaults.failOnWarning,
override val delayTemplateSubstitution: Boolean = false,
+ override val suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions,
) : DokkaConfiguration
data class PluginConfigurationImpl(
diff --git a/core/src/main/kotlin/model/documentableProperties.kt b/core/src/main/kotlin/model/documentableProperties.kt
index 209a6296..90ab3053 100644
--- a/core/src/main/kotlin/model/documentableProperties.kt
+++ b/core/src/main/kotlin/model/documentableProperties.kt
@@ -33,4 +33,8 @@ data class ExceptionInSupertypes(val exceptions: SourceSetDependent<List<TypeCon
}
override val key: ExtraProperty.Key<Documentable, *> = ExceptionInSupertypes
+}
+
+object ObviousMember : ExtraProperty<Documentable>, ExtraProperty.Key<Documentable, ObviousMember> {
+ override val key: ExtraProperty.Key<Documentable, *> = this
} \ No newline at end of file
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 87e85c02..82f6da3a 100644
--- a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
+++ b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
@@ -34,6 +34,7 @@ class TestDokkaConfigurationBuilder {
var pluginsConfigurations: MutableList<PluginConfigurationImpl> = mutableListOf()
var failOnWarning: Boolean = false
var modules: List<DokkaModuleDescriptionImpl> = emptyList()
+ var suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions
private val lazySourceSets = mutableListOf<Lazy<DokkaSourceSetImpl>>()
fun build() = DokkaConfigurationImpl(
@@ -47,6 +48,7 @@ class TestDokkaConfigurationBuilder {
pluginsConfiguration = pluginsConfigurations,
modules = modules,
failOnWarning = failOnWarning,
+ suppressObviousFunctions = suppressObviousFunctions
)
fun sourceSets(block: SourceSetsBuilder.() -> Unit) {