Support for nested typealiases #4261
Merged
+1,434
−78
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Let me know if you have any ideas what test cases we should also add |
whyoleg
requested changes
Sep 18, 2025
Collaborator
whyoleg
left a comment
There was a problem hiding this comment.
Nice work!
As for additional tests, here is what comes in mind for me:
- check that we handle nested typealias in all classlikes: class, interface, object, enum (not supported only in
annotation class) - check that we correctly resolve link to typealias page if parameter/receiver/return-value of the function/property is type alias
- check that we correctly resolve links
[typealias], mostly AA work here, but still would be nice to check, that we resolve correct DRI/pages -
- maybe something based on the comments
...jetbrains/dokka/analysis/kotlin/symbols/translators/DefaultSymbolToDocumentableTranslator.kt
Show resolved
Hide resolved
dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka/model/Documentable.kt
Outdated
Show resolved
Hide resolved
...otlin/org/jetbrains/dokka/base/transformers/documentables/DocumentableReplacerTransformer.kt
Show resolved
Hide resolved
dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka/model/Documentable.kt
Outdated
Show resolved
Hide resolved
.../kotlin/org/jetbrains/dokka/base/transformers/documentables/ExtensionExtractorTransformer.kt
Show resolved
Hide resolved
...ase/src/main/kotlin/org/jetbrains/dokka/base/translators/documentables/DefaultPageCreator.kt
Show resolved
Hide resolved
dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka/model/Documentable.kt
Outdated
Show resolved
Hide resolved
...ase/src/main/kotlin/org/jetbrains/dokka/base/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
...ase/src/main/kotlin/org/jetbrains/dokka/base/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
...ase/src/main/kotlin/org/jetbrains/dokka/base/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
vmishenev
reviewed
Sep 19, 2025
Contributor
vmishenev
left a comment
There was a problem hiding this comment.
@whyoleg provided a good review.
It would be nice to check not only the Content model, but also the Documentable model.
Also, some tests can be edited/added for each modified transformer, e.g.
...ain/kotlin/org/jetbrains/dokka/base/transformers/pages/annotations/SinceKotlinTransformer.kt
Outdated
Show resolved
Hide resolved
.../dokka/base/transformers/documentables/SuppressedByConditionDocumentableFilterTransformer.kt
Show resolved
Hide resolved
dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka/model/Documentable.kt
Show resolved
Hide resolved
b19a8c2 to
4e4243a
Compare
…ing if the classlike was changed
4e4243a to
edb13ce
Compare
vmishenev
approved these changes
Sep 29, 2025
Contributor
vmishenev
left a comment
There was a problem hiding this comment.
Is there a test for SuppressedByConditionDocumentableFilterTransformer?
E.g.
| divergentInstance { | ||
| group4 { | ||
| +"typealias " | ||
| group { groupedLink { +"Foo.A" } } |
Contributor
There was a problem hiding this comment.
Sorry, I haven't noticed.
Should we render a nested typealias as A or Foo.A?
cc @whyoleg
Member
Author
There was a problem hiding this comment.
I think that to be more consistent, we need to show only A in the typealias declaration itself, and Foo.A in the use-cases. This will be similar to how nested classes are displayed currently
whyoleg
requested changes
Oct 6, 2025
...jetbrains/dokka/analysis/kotlin/symbols/translators/DefaultSymbolToDocumentableTranslator.kt
Show resolved
Hide resolved
...s/plugin-base/src/main/kotlin/org/jetbrains/dokka/base/signatures/KotlinSignatureProvider.kt
Outdated
Show resolved
Hide resolved
dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka/model/Documentable.kt
Show resolved
Hide resolved
…typealiases, replace it with custom implementation
whyoleg
approved these changes
Oct 7, 2025
Collaborator
whyoleg
left a comment
There was a problem hiding this comment.
Nice! Thanks for fixing all the remarks!
Collaborator
|
The TeamCity IT setup is now fixed, and the CI is green. PR could be merged :) |
This was referenced Oct 7, 2025
whyoleg
pushed a commit
that referenced
this pull request
Oct 13, 2025
* Add `WithTypealiases` interface to documentables * Copy typealiases everywhere * Merge typealiases in multiplatform projects * Fix DocumentableReplacerTransformer: consider typealiases when computing if the classlike was changed * Add test for nested typealiases in SuppressTagFilterTest.kt * Change the rendering of typealias names * Ensure ABI compatibility of documentables that implement `WithTypealiases` * Add test that checks nested typealiases with type parameters * Remove the use of `signatureForProjection` in `regularSignature` for typealiases, replace it with custom implementation (cherry picked from commit b49856b)
adam-enko
pushed a commit
that referenced
this pull request
Nov 4, 2025
* Add `WithTypealiases` interface to documentables * Copy typealiases everywhere * Merge typealiases in multiplatform projects * Fix DocumentableReplacerTransformer: consider typealiases when computing if the classlike was changed * Add test for nested typealiases in SuppressTagFilterTest.kt * Change the rendering of typealias names * Ensure ABI compatibility of documentables that implement `WithTypealiases` * Add test that checks nested typealiases with type parameters * Remove the use of `signatureForProjection` in `regularSignature` for typealiases, replace it with custom implementation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.