diff options
| author | Marcin Aman <marcin.aman@gmail.com> | 2021-03-01 13:50:17 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-01 13:50:17 +0100 |
| commit | 7cf644f064868934fe8dcb46ab150f25fab8e8c8 (patch) | |
| tree | 30d97e4cdaa6017401e7780bd86471f93d6f4d08 /core/src | |
| parent | ab853a866c40771e84a3235f40575efe04c435c5 (diff) | |
| download | dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.tar.gz dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.tar.bz2 dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.zip | |
Add ability to suppress obvious functions like equals, toString... (#1758)
* Add ability to suppress obvious functions like equals, toString...
* Add ability to suppress obvious functions like equals, toString...
Diffstat (limited to 'core/src')
| -rw-r--r-- | core/src/main/kotlin/configuration.kt | 2 | ||||
| -rw-r--r-- | core/src/main/kotlin/defaultConfiguration.kt | 1 | ||||
| -rw-r--r-- | core/src/main/kotlin/model/documentableProperties.kt | 4 |
3 files changed, 7 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 |