diff options
| author | Dmitry Jemerov <yole@jetbrains.com> | 2015-03-02 18:34:05 +0100 |
|---|---|---|
| committer | Dmitry Jemerov <yole@jetbrains.com> | 2015-03-02 18:34:05 +0100 |
| commit | feed2016cea8650626ba53306251a3c42da63dfd (patch) | |
| tree | f12d50f477243a4191a56235f6f50ef32534c57e /src/Kotlin/DocumentationBuilder.kt | |
| parent | 0427adc6d074caeb5644358096be149de6eb48dc (diff) | |
| download | dokka-feed2016cea8650626ba53306251a3c42da63dfd.tar.gz dokka-feed2016cea8650626ba53306251a3c42da63dfd.tar.bz2 dokka-feed2016cea8650626ba53306251a3c42da63dfd.zip | |
option to exclude deprecated members from generated documentation
Diffstat (limited to 'src/Kotlin/DocumentationBuilder.kt')
| -rw-r--r-- | src/Kotlin/DocumentationBuilder.kt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/Kotlin/DocumentationBuilder.kt b/src/Kotlin/DocumentationBuilder.kt index ddea6d6e..60f03f14 100644 --- a/src/Kotlin/DocumentationBuilder.kt +++ b/src/Kotlin/DocumentationBuilder.kt @@ -28,6 +28,7 @@ import org.jetbrains.kotlin.types.expressions.OperatorConventions public data class DocumentationOptions(val includeNonPublic: Boolean = false, val reportUndocumented: Boolean = true, val skipEmptyPackages: Boolean = true, + val skipDeprecated: Boolean = false, val sourceLinks: List<SourceLinkDefinition>) private fun isSamePackage(descriptor1: DeclarationDescriptor, descriptor2: DeclarationDescriptor): Boolean { @@ -289,7 +290,9 @@ class DocumentationBuilder(val session: ResolveSession, private fun DeclarationDescriptor.isDocumented(): Boolean { return (options.includeNonPublic || this !is MemberDescriptor - || this.getVisibility() in visibleToDocumentation) && !isDocumentationSuppressed() + || this.getVisibility() in visibleToDocumentation) && + !isDocumentationSuppressed() && + (!options.skipDeprecated || !isDeprecated()) } fun DeclarationDescriptor.isDocumentationSuppressed(): Boolean { |