Skip to content

Typealiases should have their own separate pages #2862

@IgnatBeresnev

Description

@IgnatBeresnev

At the moment, typealiases don't have their own pages and can only be found among the package's types, which is not always convenient and is difficult to link to.

Typealiases should have dedicated pages, with persistent index.html generated for them, similar to other declarations.

Things to consider/keep in mind:

  1. Previously generated anchor links should be preserved if possible (so compatibility with previous versions of Dokka, especially when linking to external documentation).
  2. If not already, the description of the typealias declaration on the package page should be changed to "brief", similar to other elements.
  3. The dedicated page for the typealias should display full documentation (all KDoc paragraphs, tags, etc).
  4. Check that the search and similar common features work (for instance, see Kotlin's typealias is not handled correctly #2311)
  5. Some internal refactoring may be needed as DTypeAlias is not handled the same way as DClasslike or any other documentable, so it needs to be checked/supported additionally.

Metadata

Metadata

Assignees

Labels

enhancementAn issue for a feature or an overall improvementfeedback: Kotlin libsFeedback from Kotlin's internal libraries

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions