Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Apply the same style to all KDoc tags, including throws/see/parameters #2587

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Aug 3, 2022
Merged

Apply the same style to all KDoc tags, including throws/see/parameters #2587

merged 3 commits into from
Aug 3, 2022

Conversation

@IgnatBeresnev
Copy link
Contributor

See #2576

  • Now all KDoc tag sections should look the same, including throws/see/parameters

  • Decreased space between tag header and values

  • Fixed a problem where longer link text had many word breaks:

    • See/Throws link text is now just the class name (if DRI is resolved), full path if unresolved; previously always full path
    • Increased first column width for See/Throws/Parameters a bit.
    • (I have a complete JS script to dynamically adjust the width of the first column based on link width, will discuss it during sync and maybe file it as another PR)

@IgnatBeresnev IgnatBeresnev requested a review from vmishenev July 26, 2022 20:56
@IgnatBeresnev IgnatBeresnev mentioned this pull request Jul 26, 2022
Closed
vmishenev
vmishenev requested changes Jul 27, 2022
View reviewed changes
Copy link
Contributor

@vmishenev vmishenev left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before:
image
After (there is space after Return):
image

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt Outdated
val availablePlatforms = params.values.flatMap { it.keys }.toSet()

header(2, "Parameters", kind = ContentKind.Parameters, sourceSets = availablePlatforms)
header(4, "Parameters", kind = ContentKind.Parameters, sourceSets = availablePlatforms)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to make a constant to avoid magic number.

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt Outdated
styles = mainStyles + ContentStyle.RowTitle
)
comment(it.root)
if (it.root.children.isNotEmpty()) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would create a helper like TagWrapper.isEmpty() = children.isEmpty() (Law of Demeter)

@IgnatBeresnev
Copy link
Contributor Author

After (there is space after Return)

I've fixed Since Kotlin block, totally forgot about that 👍 but I don't understand what's wrong with Return

@IgnatBeresnev IgnatBeresnev requested a review from vmishenev July 27, 2022 22:14
@IgnatBeresnev IgnatBeresnev merged commit 3994c42 into master Aug 3, 2022
@IgnatBeresnev IgnatBeresnev deleted the same-style-tags branch August 3, 2022 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vmishenev vmishenev vmishenev approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@IgnatBeresnev @vmishenev