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 2020/05/11 10:48:52 UTC
[groovy] 02/03: GROOVY-9465: groovydoc: show class declaration
header for all types (closes #1242)
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
commit 27bcbb18ba99ba3cdb8e488836a7e8f2042ff1b2
Author: Mikko Värri <vm...@linuxbox.fi>
AuthorDate: Mon May 11 02:03:31 2020 +0300
GROOVY-9465: groovydoc: show class declaration header for all types (closes #1242)
---
.../gstringTemplates/classLevel/classDocName.html | 4 ++--
.../groovy/tools/groovydoc/GroovyDocToolTest.java | 21 +++++++++++++++++++++
2 files changed, 23 insertions(+), 2 deletions(-)
diff --git a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
index 0091217..e3dfe10 100644
--- a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
+++ b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
@@ -225,6 +225,8 @@ if (classDoc.isInterface()) {
<dt>All Implemented Interfaces and Traits:</dt>
<dd>${interfaces.collect{ linkable(it) }.join(', ')}</dd>
</dl>
+ <% } %>
+<% } %>
<!-- todo: direct known subclasses -->
<hr>
<br>
@@ -235,8 +237,6 @@ if (classDoc.isInterface()) {
%>extends ${linkable(classDoc.superclass())}
<% } %>
</pre>
-<% } %>
-<% } %>
<% if (classDoc.commentText()) { %>
<p>${classDoc.commentText()}</p>
<% } %>
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 581c795..0292fb7 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
@@ -720,6 +720,27 @@ public class GroovyDocToolTest extends GroovyTestCase {
assertEquals("The constructor parameter link text should be Foo", "Foo", constructor.group(3));
}
+ public void testClassDeclarationHeader() throws Exception {
+ final String base = "org/codehaus/groovy/tools/groovydoc/testfiles/a";
+ htmlTool.add(Arrays.asList(
+ base + "/Base.groovy"
+ ));
+
+ final MockOutputTool output = new MockOutputTool();
+ htmlTool.renderToOutput(output, MOCK_DIR);
+
+ final String basedoc = output.getText(MOCK_DIR + "/" + base + "/Base.html");
+
+ final Matcher classDecl = Pattern.compile(Pattern.quote(
+ "<pre>class Base\n"+
+ "extends <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html' title='Object'>Object</a>\n"+
+ "\n"+
+ "</pre>"
+ )).matcher(basedoc);
+
+ assertTrue("The class declaration header should exist in class description", classDecl.find());
+ }
+
public void testJavaGenericsTitle() throws Exception {
final String base = "org/codehaus/groovy/tools/groovydoc/testfiles/generics";
htmlTool.add(Arrays.asList(