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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dmitrysulman
Copy link

@dmitrysulman dmitrysulman commented May 17, 2025

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:

<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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant