Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecated constructor listings are not struck through #3853

Open
sorenoid opened this issue Oct 9, 2024 · 0 comments
Open

deprecated constructor listings are not struck through #3853

sorenoid opened this issue Oct 9, 2024 · 0 comments
Labels
bug format: html An issue/PR related to Dokka's default HTML output format

Comments

@sorenoid
Copy link

sorenoid commented Oct 9, 2024

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

  • Operating system: reproduced on macOS/Linux
  • Build tool: Gradle 8.9
  • Dokka version: 1.9.20

Additional context
Add any other context about the problem here

@sorenoid sorenoid added the bug label Oct 9, 2024
@whyoleg whyoleg added the format: html An issue/PR related to Dokka's default HTML output format label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug format: html An issue/PR related to Dokka's default HTML output format
Projects
None yet
Development

No branches or pull requests

2 participants