You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2022/09/03 01:02:10 UTC
[groovy] branch master updated: GROOVY-10737: Groovydoc deprecation list page is always empty even if @deprecated is used in groovydoc comments on some elements
This is an automated email from the ASF dual-hosted git repository.
paulk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
The following commit(s) were added to refs/heads/master by this push:
new 6b275d14fc GROOVY-10737: Groovydoc deprecation list page is always empty even if @deprecated is used in groovydoc comments on some elements
6b275d14fc is described below
commit 6b275d14fc2a922efbf21cf086b1bffaa277cc31
Author: Paul King <pa...@asert.com.au>
AuthorDate: Fri Sep 2 21:29:23 2022 +1000
GROOVY-10737: Groovydoc deprecation list page is always empty even if @deprecated is used in groovydoc comments on some elements
---
.../groovy/tools/groovydoc/SimpleGroovyDoc.java | 4 +-
.../groovy/tools/groovydoc/GroovyDocToolTest.java | 51 ++++++++++++++--------
.../groovydoc/testfiles/DeprecatedClass.groovy | 2 +
.../groovydoc/testfiles/DeprecatedField.groovy | 6 ++-
4 files changed, 41 insertions(+), 22 deletions(-)
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java
index 58b79be0a8..f519b3e87d 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyDoc.java
@@ -39,7 +39,7 @@ public class SimpleGroovyDoc implements GroovyDoc/*, GroovyTokenTypes*/ {
public static final int ENUM_DEF = 61;
private static final Pattern TAG2_PATTERN = Pattern.compile("(?s)([a-z]+)\\s+(.*)");
private static final Pattern TAG3_PATTERN = Pattern.compile("(?s)([a-z]+)\\s+(\\S*)\\s+(.*)");
- private static final Pattern RAW_COMMENT_PATTERN = Pattern.compile("\"(?s).*?\\\\*\\\\s*@\"");
+ private static final Pattern RAW_COMMENT_PATTERN = Pattern.compile("(?s).*?\\*\\s*@");
private static final Pattern TRIMMED_COMMENT_PATTERN = Pattern.compile("(?m)^\\s*\\*\\s*([^*]*)$");
private static final GroovyTag[] EMPTY_GROOVYTAG_ARRAY = new GroovyTag[0];
private final String name;
@@ -104,7 +104,7 @@ public class SimpleGroovyDoc implements GroovyDoc/*, GroovyTokenTypes*/ {
if (trimmed.equals(rawCommentText)) return;
String cleaned = TRIMMED_COMMENT_PATTERN.matcher(trimmed).replaceAll("$1").trim();
String[] split = cleaned.split("(?m)^@", -1);
- List<GroovyTag> result = new ArrayList<GroovyTag>();
+ List<GroovyTag> result = new ArrayList<>();
for (String s : split) {
String tagname = null;
if (s.startsWith("param") || s.startsWith("throws")) {
diff --git a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/GroovyDocToolTest.java b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/GroovyDocToolTest.java
index 2fcc35e6cb..86eb165b50 100644
--- a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/GroovyDocToolTest.java
+++ b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/GroovyDocToolTest.java
@@ -757,7 +757,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testGroovyExtendsImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Groovy interface b.Test imports a.List and extends List.
- // List should be recognized as a.List and not java.util.List
+ // List should be recognized as a.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/List.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/Test.groovy"
@@ -769,7 +769,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// Test should etends a.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/))List)\\.html'[^>]*>List</a>").matcher(testAdapterDoc);
-
+
assertTrue("Test interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/List", extendedClass.group(1));
@@ -777,7 +777,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testJavaExtendsImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Java interface b.Test imports a.List and extends List.
- // List should be recognized as a.List and not java.util.List
+ // List should be recognized as a.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/List.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/Test.java"
@@ -789,7 +789,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// Test should etends a.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/))List)\\.html'[^>]*>List</a>").matcher(testAdapterDoc);
-
+
assertTrue("Test interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/List", extendedClass.group(1));
@@ -797,7 +797,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testGroovyExtendsStarImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Groovy interface b.TestStar imports a.* and extends List.
- // List should be recognized as a.List and not java.util.List
+ // List should be recognized as a.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/List.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStar.groovy"
@@ -809,7 +809,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStar should etends a.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/))List)\\.html'[^>]*>List</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStar interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/List", extendedClass.group(1));
@@ -817,7 +817,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testJavaExtendsStarImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Java interface b.TestStar imports a.* and extends List.
- // List should be recognized as a.List and not java.util.List
+ // List should be recognized as a.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/List.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStar.java"
@@ -829,7 +829,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStar should etends a.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/))List)\\.html'[^>]*>List</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStar interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/List", extendedClass.group(1));
@@ -837,7 +837,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testGroovyExtendsStaticImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Groovy interface b.TestStatic imports a.StaticList.List and extends List.
- // List should be recognized as a.StaticList.List and not java.util.List
+ // List should be recognized as a.StaticList.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/StaticList.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStatic.groovy"
@@ -849,7 +849,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStatic should etends a.StaticList.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/StaticList\\.))List)\\.html'[^>]*>((StaticList\\.)?List)</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStatic interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/StaticList.List", extendedClass.group(1));
@@ -858,7 +858,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testJavaExtendsStaticImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Java interface b.TestStatic imports a.StaticList.List and extends List.
- // List should be recognized as a.StaticList.List and not java.util.List
+ // List should be recognized as a.StaticList.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/StaticList.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStatic.java"
@@ -870,7 +870,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStatic should etends a.StaticList.List".
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/StaticList\\.))List)\\.html'[^>]*>((StaticList\\.)?List)</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStatic interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/StaticList.List", extendedClass.group(1));
@@ -879,7 +879,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testGroovyExtendsStaticImportedAliasesClassWithNameWhichExistInDefaultPackages() throws Exception {
// Groovy interface b.TestStatic imports a.StaticList.ListAlias as List and extends List.
- // List should be recognized as a.StaticList.List and not java.util.List
+ // List should be recognized as a.StaticList.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/StaticList.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStaticAlias.groovy"
@@ -891,7 +891,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStatic should etends a.StaticList.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/StaticList\\.))List(Alias)?)\\.html'[^>]*>((StaticList\\.)?List(Alias)?)</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStatic interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/StaticList.ListAlias", extendedClass.group(1));
@@ -900,7 +900,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testGroovyExtendsStaticStarImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Groovy interface b.TestStaticStar imports a.StaticList.* and extends List.
- // List should be recognized as a.StaticList.List and not java.util.List
+ // List should be recognized as a.StaticList.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/StaticList.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStaticStar.groovy"
@@ -912,7 +912,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStatic should etends a.StaticList.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/StaticList\\.))List)\\.html'[^>]*>((StaticList\\.)?List)</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStaticStar interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/StaticList.List", extendedClass.group(1));
@@ -921,7 +921,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
public void testJavaExtendsStaticStarImportedClassWithNameWhichExistInDefaultPackages() throws Exception {
// Java interface b.TestStaticStar imports a.StaticList.* and extends List.
- // List should be recognized as a.StaticList.List and not java.util.List
+ // List should be recognized as a.StaticList.List and not java.util.List
htmlTool.add(Arrays.asList(
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/a/StaticList.java",
"org/codehaus/groovy/tools/groovydoc/testfiles/groovy_10593/b/TestStaticStar.groovy"
@@ -933,7 +933,7 @@ public class GroovyDocToolTest extends GroovyTestCase {
// TestStatic should etends a.StaticList.List
final Matcher extendedClass = Pattern.compile("extends\\s+<a[^>]*href='[^']*(((java/util/)|(a/StaticList\\.))List)\\.html'[^>]*>((StaticList\\.)?List)</a>").matcher(testAdapterDoc);
-
+
assertTrue("TestStaticStar interface should extends List", extendedClass.find());
assertEquals("Classes from imported packages should shadow classes from default packages", "a/StaticList.List", extendedClass.group(1));
@@ -1307,6 +1307,21 @@ public class GroovyDocToolTest extends GroovyTestCase {
assertFalse("Private ctor should not be listed", matcher.find());
}
+ public void testDeprecated() throws Exception {
+ final String base = "org/codehaus/groovy/tools/groovydoc/testfiles";
+ htmlTool.add(Arrays.asList(
+ base + "/DeprecatedClass.groovy",
+ base + "/DeprecatedField.groovy"
+ ));
+
+ final MockOutputTool output = new MockOutputTool();
+ htmlTool.renderToOutput(output, MOCK_DIR);
+
+ final String groovydoc = output.getText(MOCK_DIR + "/deprecated-list.html");
+ assertTrue(groovydoc, groovydoc.contains("summary=\"Deprecated Classes table, listing deprecated classes, and an explanation\""));
+ assertTrue(groovydoc, groovydoc.contains("<a href=\"org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedClass.html\">DeprecatedClass</a>"));
+ }
+
public void testProperty() throws Exception {
final String base = "org/codehaus/groovy/tools/groovydoc/testfiles";
htmlTool.add(Arrays.asList(
diff --git a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedClass.groovy b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedClass.groovy
index 87dd2e0dc8..11c37ea7ed 100644
--- a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedClass.groovy
+++ b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedClass.groovy
@@ -20,6 +20,8 @@ package org.codehaus.groovy.tools.groovydoc.testfiles
/**
* Meow!
+ *
+ * @deprecated Use something else
*/
@Deprecated
class DeprecatedClass {
diff --git a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedField.groovy b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedField.groovy
index ab47de6731..1cdda21b91 100644
--- a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedField.groovy
+++ b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/DeprecatedField.groovy
@@ -21,11 +21,13 @@ package org.codehaus.groovy.tools.groovydoc.testfiles
class DeprecatedField {
@Deprecated
/**
- * @deprecated Use my ass instead
+ * A public deprecated field
+ *
+ * @deprecated Use something else
*/
public String field
- public boolean isHandlesNodeChildren() {
+ boolean isHandlesNodeChildren() {
return true
}