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
Move inheritors, params, see also and samples tabs to description for classlikes #2749
Conversation
* remove contentForComments api, tag parameters are now edited in the contentForDescription * add contentForInheritors api * change api for contentForScopes: remove inheritors param * remove inheritors from package list
* wrong style * missed inheritors in different platform * duplication for mergeImplicitActuals
UPD: Fixed |
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Outdated
Show resolved
Hide resolved
header(KDOC_TAG_HEADER_LEVEL, "Samples", kind = ContentKind.Sample, sourceSets = availableSourceSets) | ||
availableSourceSets.forEach { sourceSet -> | ||
group( | ||
sourceSets = setOf(sourceSet), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sourceSets = availableSourceSets
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In that case, for MPP all samples will be shown on each platform tab
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At least the behavior is preserved as it was before. So no performance degradation is expected in this area.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done — especially on the number of tests! :) And thanks for the PR and in-code comments, they made it easier to understand changes, corner cases and made review easier overall 👍
The only comment I didn't understand was the following:
remove inheritors from the package list
Which package list do you mean? Could you share an example of before/after, if it's still relevant?
plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Show resolved
Hide resolved
plugins/base/src/main/kotlin/translators/documentables/DescriptionSections.kt
Outdated
Show resolved
Hide resolved
plugins/base/src/test/kotlin/content/seealso/ContentForSeeAlsoTest.kt
Outdated
Show resolved
Hide resolved
I've meant this change: https://github.com/Kotlin/dokka/pull/2749/files#diff-393cd6c01196a89045f20b4a981cf4c5b5ac45cec583c8bc2fb41ea0e9fa1765R267 |
* switch collections from nullability to empty * add a little documentation * move code around
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 👍
Migrate params, seealso, samples, and inheritors to the description
contentForComments
API, those tags will be handled in thecontentForDescription
contentForScopes
: remove inheritors parameter in the methodFix #2688