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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[multi-modules] Copy KDoc from base symbols into inherited symbols #3547

Closed
martinbonnin opened this issue Mar 22, 2024 · 1 comment
Closed
Labels
enhancement An issue for a feature or an overall improvement

Comments

@martinbonnin
Copy link
Contributor

martinbonnin commented Mar 22, 2024

There's a nice feature that when a symbol doesn't define its KDoc, the one from the overriden/subclassed symbol is used instead.

This works well when everything is in the same module:

interface Greeter {
  /**
   * Says hello 馃憢
   *
   * @return a string that says hello
   */
  fun hello(): String
}

class EnglishGreeter: Greeter {
  override fun hello(): String {
    return "Hello \uD83D\uDC4B"
  }
}

Screenshot 2024-03-22 at 22 43 05

Now when crossing the module boundary, this doesn't work anymore:

class FrenchGreeter : Greeter {
    override fun hello(): String {
        return "Bonjour"
    }
}

Screenshot 2024-03-22 at 22 43 16

Reproducer available here.

This is probably related to #1960 but since this one is about inheriting KDoc specifically, I thought I would open a new one in case someone else bumps into this.

@martinbonnin martinbonnin added the enhancement An issue for a feature or an overall improvement label Mar 22, 2024
@whyoleg
Copy link
Contributor

whyoleg commented Apr 3, 2024

Hey!
This is a known issue:

There is possible workaround (or at least an idea for it) in a comment here: #463 (comment)

@whyoleg whyoleg closed this as completed Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Development

No branches or pull requests

2 participants