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

Skip to content

Fix constructor details to show description instead of brief in Javadoc #4105

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 1 commit into from
Jun 11, 2025
Merged

Fix constructor details to show description instead of brief in Javadoc #4105

merged 1 commit into from
Jun 11, 2025

Conversation

@dmitrysulman
Copy link
Contributor

@dmitrysulman dmitrysulman commented May 17, 2025 •
edited
Loading

When generating Javadoc, the Constructor Detail section displays only the brief constructor description (i.e., the first sentence) instead of the full description. See line 252 in class.korte:

dokka/dokka-subprojects/plugin-javadoc/src/main/resources/views/class.korte

Lines 245 to 264 in 540fe08

<h3>Constructor Detail</h3>
{% for constructor in constructors %}
<a name="{{ constructor.anchorLink }}"></a>
<ul class="blockList">
<li class="blockList">
<h4>{{ constructor.name }}</h4>
<pre>{{ constructor.name }}({{ constructor.inlineParameters|raw }})</pre>
<div class="block">{{ constructor.brief|raw}}</div>
{% if constructor.parameters.size != 0 && hasAnyDescription(constructor.parameters) %}
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
{% for parameter in constructor.parameters %}
{% if parameter.description != "" %}
<dd><code>{{ parameter.name }}</code> - {{ parameter.description|raw }}</dd>
{% endif %}
{% endfor %}
</dl>
{% endif %}
</li>
</ul>

A similar issue for method details was fixed long time ago in version 1.4.0.

This PR fixes the issue by replacing constructor.brief with constructor.description.

@vmishenev vmishenev requested review from vmishenev and whyoleg May 31, 2025 10:49
whyoleg
whyoleg approved these changes Jun 11, 2025
View reviewed changes
Copy link
Collaborator

@whyoleg whyoleg left a comment

Choose a reason for hiding this comment

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

Thanks!
I've additionally checked all other brief vs description usage in the template, and looks like there are no other issues like this.
I've started the test on CI, after they are finished, I will merge the PR

@whyoleg whyoleg merged commit d4ada66 into Kotlin:master Jun 11, 2025
7 checks passed
@whyoleg whyoleg added this to the Dokka 2.1.0 milestone Jul 30, 2025
@strangesource strangesource mentioned this pull request Sep 17, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@whyoleg whyoleg whyoleg approved these changes

@vmishenev vmishenev Awaiting requested review from vmishenev

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

Dokka 2.1.0

Development

Successfully merging this pull request may close these issues.

2 participants

@dmitrysulman @whyoleg