From 8e6079e9b6f0131099c30f0ebf4bfff77aff2fa5 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Fri, 17 Dec 2021 16:23:19 +0300 Subject: [PATCH] Correct an inconsistency with default values and leave a comment of intentions --- .../DocumentableVisibilityFilterTransformer.kt | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/plugins/base/src/main/kotlin/transformers/documentables/DocumentableVisibilityFilterTransformer.kt b/plugins/base/src/main/kotlin/transformers/documentables/DocumentableVisibilityFilterTransformer.kt index c15e2137c1..4b9da03bf7 100644 --- a/plugins/base/src/main/kotlin/transformers/documentables/DocumentableVisibilityFilterTransformer.kt +++ b/plugins/base/src/main/kotlin/transformers/documentables/DocumentableVisibilityFilterTransformer.kt @@ -40,12 +40,10 @@ class DocumentableVisibilityFilterTransformer(val context: DokkaContext) : PreMe else -> globalOptions.documentedVisibilities to globalOptions.includeNonPublic } + // if `documentedVisibilities` is explicitly overridden by the user (i.e. not default value by reference), + // deprecated `includeNonPublic` should not be taken into account, so that only one setting prevails val isDocumentedVisibilitiesOverridden = documentedVisibilities !== DokkaDefaults.documentedVisibilities - return if (isDocumentedVisibilitiesOverridden) { - documentedVisibilities.contains(visibility) - } else { - visibility == DokkaConfiguration.Visibility.PUBLIC || includeNonPublic - } + return documentedVisibilities.contains(visibility) || (!isDocumentedVisibilitiesOverridden && includeNonPublic) } fun processModule(original: DModule) =