You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@netbeans.apache.org by mb...@apache.org on 2023/01/05 22:08:03 UTC
[netbeans] branch master updated: [NETBEANS-1309] add support for @summary javadoc tag
This is an automated email from the ASF dual-hosted git repository.
mbien pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/netbeans.git
The following commit(s) were added to refs/heads/master by this push:
new bef7a93289 [NETBEANS-1309] add support for @summary javadoc tag
new b7ba5d6619 Merge pull request #5180 from jherkel/netbeans-1309
bef7a93289 is described below
commit bef7a93289d28e3c4a4cde1cd0af920f8aa0d48f
Author: Jakub Herkel <j....@uniq.sk>
AuthorDate: Mon Jan 2 21:14:32 2023 +0100
[NETBEANS-1309] add support for @summary javadoc tag
---
.../java/editor/javadoc/JavadocCompletionQueryTest.java | 17 +++++++++++++++++
.../netbeans/modules/java/source/save/Reformatter.java | 2 ++
.../org/netbeans/api/java/source/ui/ElementJavadoc.java | 11 +++++++++--
3 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/java/java.editor/test/unit/src/org/netbeans/modules/java/editor/javadoc/JavadocCompletionQueryTest.java b/java/java.editor/test/unit/src/org/netbeans/modules/java/editor/javadoc/JavadocCompletionQueryTest.java
index bfd4223c4a..8bf90d619f 100644
--- a/java/java.editor/test/unit/src/org/netbeans/modules/java/editor/javadoc/JavadocCompletionQueryTest.java
+++ b/java/java.editor/test/unit/src/org/netbeans/modules/java/editor/javadoc/JavadocCompletionQueryTest.java
@@ -586,6 +586,23 @@ public class JavadocCompletionQueryTest extends JavadocTestSupport {
performCompletionTest(code, "end:");
}
+
+ public void testSummaryCompletionForMethod() throws Exception {
+ String code =
+ "package p;\n" +
+ "class Clazz {\n" +
+ " /**\n" +
+ " * {@sum|\n" +
+ " */\n" +
+ " void method(int p1, int p2) {\n" +
+ " }\n" +
+ " Clazz() {\n" +
+ " }\n" +
+ "}\n";
+ performCompletionTest(code, "@summary:");
+ }
+
+
private static String stripHTML(String from) {
StringBuilder result = new StringBuilder();
diff --git a/java/java.source.base/src/org/netbeans/modules/java/source/save/Reformatter.java b/java/java.source.base/src/org/netbeans/modules/java/source/save/Reformatter.java
index e04f054f03..063fc0a194 100644
--- a/java/java.source.base/src/org/netbeans/modules/java/source/save/Reformatter.java
+++ b/java/java.source.base/src/org/netbeans/modules/java/source/save/Reformatter.java
@@ -419,6 +419,7 @@ public class Reformatter implements ReformatTask {
private static final String JDOC_THROWS_TAG = "@throws"; //NOI18N
private static final String JDOC_VALUE_TAG = "@value"; //NOI18N
private static final String JDOC_SNIPPET_TAG = "@snippet"; //NOI18N
+ private static final String JDOC_SUMMARY_TAG = "@summary"; //NOI18N
private static final String ERROR = "<error>"; //NOI18N
private final String fText;
@@ -4835,6 +4836,7 @@ public class Reformatter implements ReformatTask {
|| JDOC_DOCROOT_TAG.equalsIgnoreCase(tokenText)
|| JDOC_INHERITDOC_TAG.equalsIgnoreCase(tokenText)
|| JDOC_VALUE_TAG.equalsIgnoreCase(tokenText)
+ || JDOC_SUMMARY_TAG.equalsIgnoreCase(tokenText)
|| JDOC_LITERAL_TAG.equalsIgnoreCase(tokenText)) {
insideTag = true;
addMark(Pair.of(currWSOffset >= 0 ? currWSOffset : javadocTokens.offset() - offset, 5), marks, state);
diff --git a/java/java.sourceui/src/org/netbeans/api/java/source/ui/ElementJavadoc.java b/java/java.sourceui/src/org/netbeans/api/java/source/ui/ElementJavadoc.java
index 64e081a1e9..ed8edb9fa3 100644
--- a/java/java.sourceui/src/org/netbeans/api/java/source/ui/ElementJavadoc.java
+++ b/java/java.sourceui/src/org/netbeans/api/java/source/ui/ElementJavadoc.java
@@ -25,6 +25,7 @@ import com.sun.source.doctree.AttributeTree;
import com.sun.source.doctree.DeprecatedTree;
import com.sun.source.doctree.DocCommentTree;
import com.sun.source.doctree.DocTree;
+import static com.sun.source.doctree.DocTree.Kind.SUMMARY;
import com.sun.source.doctree.EndElementTree;
import com.sun.source.doctree.EntityTree;
import com.sun.source.doctree.InheritDocTree;
@@ -37,6 +38,7 @@ import com.sun.source.doctree.SeeTree;
import com.sun.source.doctree.SinceTree;
import com.sun.source.doctree.SnippetTree;
import com.sun.source.doctree.StartElementTree;
+import com.sun.source.doctree.SummaryTree;
import com.sun.source.doctree.TextTree;
import com.sun.source.doctree.ThrowsTree;
import com.sun.source.doctree.UnknownBlockTagTree;
@@ -1060,8 +1062,8 @@ public class ElementJavadoc {
}
sb.append(inlineTags(unTag.getContent(), path, doc, info.getDocTrees(), null));
break;
- }
- break;
+ }
+ break;
}
}
@@ -1325,6 +1327,11 @@ public class ElementJavadoc {
snippetCount++;
processDocSnippet(sb, (SnippetTree)tag, snippetCount,docPath, doc, trees);
break;
+ case SUMMARY:
+ SummaryTree summaryTag = (SummaryTree)tag;
+ List<? extends DocTree> summary = summaryTag.getSummary();
+ sb.append(inlineTags(summary, docPath, doc, trees, null));
+ break;
}
}
return sb;
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@netbeans.apache.org
For additional commands, e-mail: commits-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists