MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-04-21 22:11:40 +07:00
Code Issues Packages Projects Releases Wiki Activity

[javadoc] Fix the inline return tag in markdown javadoc

Browse Source 
#IDEA-374263 Fixed

GitOrigin-RevId: 2d275ddf5652a912caf6455823bc09b6c4e81f9c
This commit is contained in:
Louis Vignier
2025-06-10 11:58:05 +02:00
committed by intellij-monorepo-bot
parent 245aac8b12
commit ea057e2544
2 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
java/java-impl/src/com/intellij/codeInsight/javadoc/JavaDocInfoGenerator.java
View File

@@ -2153,9 +2153,12 @@ public class JavaDocInfoGenerator {
private void generateInlineReturnValue(@NotNull StringBuilder buffer,
@NotNull PsiInlineDocTag tag,
InheritDocProvider<PsiElement[]> provider) {
// According to the spec (https://docs.oracle.com/en/java/javase/16/docs/specs/javadoc/doc-comment-spec.html#return), the format is "Returns<description>."
buffer.append("Returns");
generateValue(buffer, tag.getDataElements(), 0, provider);
// According to the spec (https://docs.oracle.com/en/java/javase/16/docs/specs/javadoc/doc-comment-spec.html#return), the format is "Returns <description>."
buffer.append("Returns ");
final var elements = Arrays.stream(tag.getDataElements())
.dropWhile(e -> e instanceof PsiWhiteSpace)
.toArray(PsiElement[]::new);
generateValue(buffer, elements, 0, provider);
buffer.append(".");
}

2
java/java-tests/testData/codeInsight/javadocIG/allTagsMarkdown.html
View File

@@ -1,6 +1,6 @@
<html><head><base href="placeholder"></head><body><div class="bottom"><icon src="AllIcons.Nodes.Class"></icon>&nbsp;<a href="psi_element://X"><code><span style="color:#000000;">X</span></code></a></div><div class="definition"><pre><span style="color:#000080;font-weight:bold;">public</span>&nbsp;<span style="">&lt;</span><span style="color:#20999d;">T</span><span style="color:#000080;font-weight:bold;"> extends </span><a href="psi_element://java.lang.Number"><code><span style="color:#000000;">Number</span></code></a><span style="">&gt;</span>&nbsp;<span style="color:#000080;font-weight:bold;">double</span>&nbsp;<span style="color:#000000;">calculateMd</span><span style="">(</span><br> <i><span style="color:#808000;">@</span><a href="psi_element://org.jetbrains.annotations.NotNull"><code><span style="color:#808000;">NotNull</span></code></a></i><sup><font color="808080" size="3"><i>i</i></font></sup><a href="inferred.annotations"><icon src="AllIcons.Ide.External_link_arrow"></icon></a>&nbsp;<span style="color:#20999d;">T</span>&nbsp;<span style="color:#000000;">a</span><span style="">,</span>
<i><span style="color:#808000;">@</span><a href="psi_element://org.jetbrains.annotations.NotNull"><code><span style="color:#808000;">NotNull</span></code></a></i><sup><font color="808080" size="3"><i>i</i></font></sup><a href="inferred.annotations"><icon src="AllIcons.Ide.External_link_arrow"></icon></a>&nbsp;<span style="color:#20999d;">T</span>&nbsp;<span style="color:#000000;">b</span><br><span style="">)</span></pre></div><hr><div class="content"><p>Sample method demonstrating all Javadoc tags <br>
Returnscalculated result. <br>
Returns calculated result. <br>
<code><span style="">Math.<wbr>E</span></code> <br>
&lt;T&gt; <br>
<a href="psi_element://java.lang.Math#E"><code><span style="color:#660e7a;">Math#E</span></code></a> <br>