Kotlin / dokka

API documentation engine for Kotlin
https://kotl.in/dokka
Apache License 2.0
3.45k stars 410 forks source link

deprecated constructor listings are not struck through #3853

Open sorenoid opened 1 month ago

sorenoid commented 1 month ago

Describe the bug In a single module project, with dokkaHtml configured Deprecated constructors are not struck through on the class doc page (or the constructor page).

Expected behaviour

Deprecated constructors are struck through

Screenshots

Screenshot 2024-10-09 at 9 35 59 AM

Screenshot 2024-10-09 at 9 37 57 AM

To Reproduce deprecate a constructor for a class run ./gradlew :yourModule:dokkaHtml

Dokka configuration Configuration of dokka used to reproduce the bug

    dokkaHtml {
        pluginConfiguration<org.jetbrains.dokka.versioning.VersioningPlugin, org.jetbrains.dokka.versioning.VersioningConfiguration> {
            version = buildVer
        }
        // separate inherited members in our public API
        pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
            separateInheritedMembers = true
        }
        dependsOn(generateKotlinCode)
        // fix implicit dependency on jni generation. This prevents gradle from generating the interop when the
        // dokkaHtml is run by itself.
        mustRunAfter(generateInteropCode)
        finalizedBy(named("replaceApiRefName"))
        // localization?
        moduleName.set("arcgis-maps-kotlin")
        dokkaSourceSets {
            configureEach {
                perPackageOption {
                    matchingRegex.set(".*internal.*")
                    suppress.set(true)
                }
                perPackageOption {
                    matchingRegex.set("android\\.view\\.View")
                    suppress.set(true)
                }
            }
        }
    }

Installation

Additional context Add any other context about the problem here