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

[K2] Documentation on extension properties is not propagated to the generated extension getters #3752

Open
vmishenev opened this issue Aug 19, 2024 · 0 comments
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs topic: K2 Issues / PRs that are related to the K2 migration. See #2888

Comments

@vmishenev
Copy link
Member

vmishenev commented Aug 19, 2024

From Google:

If you create val FooClass.extensionProperty with /** docs for extensionProperty */, those docs will never appear for Java consumers. Java consumers never use (and don't get documented) extensionProperty, they only can use FooClassKt.getExtensionProperty(FooClass), which is an autogenerated getter for extensionProperty. With the K1 backend, dackka is putting /** docs for extensionProperty */ on getExtensionProperty, with the K2 backend there are no docs for getExtensionProperty, which means the documentation for extensionProperty is never surfaced for java consumers.

Kotlin K2 IDE plugin (which uses AA) works fine in this case and shows documentation correctly
image
image

@vmishenev vmishenev added bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs topic: K2 Issues / PRs that are related to the K2 migration. See #2888 labels Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs topic: K2 Issues / PRs that are related to the K2 migration. See #2888
Projects
None yet
Development

No branches or pull requests

1 participant