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

Extensions/implementations from another modules in multi-module documentation #2845

Open
ilya-g opened this issue Feb 5, 2023 · 1 comment
Labels
enhancement An issue for a feature or an overall improvement feedback: Kotlin libs Feedback from Kotlin's internal libraries

Comments

@ilya-g
Copy link
Member

ilya-g commented Feb 5, 2023

When combining documentation of multiple modules, Dokka resolves links between them, so for example the types of a core module referenced in the signatures of an extension module get proper links to their respective documentation pages.

However, there's no information in the core module documentation that dependent modules could have some extensions for its API.
I'd expect to see at least the following references to the dependent modules:

  • extension functions/properties for the types in the core module. For example, asObservable extensions for Flow from rx2 and rx3 modules are not shown in the Flow index page. Beware that since they come from different modules/packages, they shouldn't be merged in the same overload group in the index page.
  • inheritors of types declared in the core modules. For example, the class HandlerDispatcher should be shown in the list of inheritors of its base class MainCoroutineDispatcher
@ilya-g ilya-g added enhancement An issue for a feature or an overall improvement feedback: Kotlin libs Feedback from Kotlin's internal libraries labels Feb 5, 2023
@IgnatBeresnev
Copy link
Member

Similar request about inheritors: #1960

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 feedback: Kotlin libs Feedback from Kotlin's internal libraries
Projects
None yet
Development

No branches or pull requests

2 participants