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

Hidden members of base class are documented in derived class #1451

Closed
varstyx opened this issue Sep 10, 2020 · 0 comments · Fixed by #1459
Closed

Hidden members of base class are documented in derived class #1451

varstyx opened this issue Sep 10, 2020 · 0 comments · Fixed by #1459
Assignees
Labels
Milestone

Comments

@varstyx
Copy link

varstyx commented Sep 10, 2020

Describe the bug
Hidden members of a base class get printed in the documentation of a derived class.
This happens if the member has @suppress or is internal/protected/private and includeNonPublic is set to false.

Expected behaviour
Hidden members should also not show up in derived classes.

Minimal example

open class Base {
    private val a: Int = 0
}

class Derived : Base() {

}

Screenshots
image
image

Dokka configuration
Configuration of dokka used to reproduce the bug:

tasks.withType<DokkaTask>().configureEach {
    dokkaSourceSets {
        named("main") {
            includeNonPublic.set(false)

            reportUndocumented.set(true)
        }
    }
}

Installation

  • Operating system: Linux
  • IDE: Android Studio 4.0.1
  • Build tool: Gradle v6.1.1
  • Dokka version: 1.4.0 (also tested with 1.4.10-dev-69)
@varstyx varstyx added the bug label Sep 10, 2020
@BarkingBad BarkingBad self-assigned this Sep 11, 2020
@BarkingBad BarkingBad added this to the 1.4.20-1 milestone Sep 11, 2020
@BarkingBad BarkingBad linked a pull request Sep 11, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants