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 f4f938a GROOVY-9549: groovydoc: show implemented interfaces in class declaration header (closes #1245) f4f938a is described below commit f4f938a93e46199671e7ef11c39b97a277cb393e Author: Mikko Värri <v...@linuxbox.fi> AuthorDate: Mon May 11 17:21:00 2020 +0300 GROOVY-9549: groovydoc: show implemented interfaces in class declaration header (closes #1245) Also, add type params if any. --- .../gstringTemplates/classLevel/classDocName.html | 29 +++++++--- .../groovy/tools/groovydoc/GroovyDocToolTest.java | 66 ++++++++++++++++++---- .../testfiles/GroovyInterfaceWithTypeParam.groovy | 22 ++++++++ .../testfiles/JavaInterfaceWithTypeParam.java | 22 ++++++++ 4 files changed, 119 insertions(+), 20 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 e3dfe10..277799d 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 @@ -179,7 +179,8 @@ if (location.href.indexOf('is-external=true') == -1) { <% def pkg = classDoc.containingPackage().nameWithDots() def name = classDoc.getNameWithTypeArgs() ?: classDoc.name() -String classDesc = "${classDoc.isGroovy() ? "[Groovy]" : "[Java]"} ${classDoc.typeDescription} ${org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc.encodeAngleBrackets(name)}" +final nameEncoded = org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc.encodeAngleBrackets(name) +String classDesc = "${classDoc.isGroovy() ? "[Groovy]" : "[Java]"} ${classDoc.typeDescription} $nameEncoded" if (pkg != "DefaultPackage") { %> <div class="subTitle">Package: <strong>${pkg}</strong></div> @@ -230,13 +231,25 @@ if (classDoc.isInterface()) { <!-- todo: direct known subclasses --> <hr> <br> -<pre>${annotations(classDoc, '\n') + modifiersWithOptions(classDoc, classDoc.isGroovy(), classDoc.isInterface() || classDoc.isAnnotationType()) + classDoc.typeSourceDescription + ' ' + classDoc.name()} -<% if (classDoc.isInterface() && classDoc.interfaces()) { -%>extends ${classDoc.interfaces().collect{ linkable(it) }.join(', ')} -<% } else if (classDoc.superclass()) { -%>extends ${linkable(classDoc.superclass())} -<% } %> -</pre> +<% +def declaration = annotations(classDoc, '\n') + + modifiersWithOptions(classDoc, classDoc.isGroovy(), classDoc.isInterface() || classDoc.isAnnotationType()) + + classDoc.typeSourceDescription + + ' ' + + nameEncoded +final interfaces = classDoc.interfaces().collect{ linkable(it) }.join(', ') +if (classDoc.isInterface() && classDoc.interfaces()) { + if (interfaces) { + declaration += "\nextends $interfaces" + } +} else if (classDoc.superclass()) { + declaration += "\nextends ${linkable(classDoc.superclass())}" + if (interfaces) { + declaration += "\nimplements $interfaces" + } +} +%> +<pre>${declaration}</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 2c6f078..a8be2c7 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 @@ -721,24 +721,66 @@ public class GroovyDocToolTest extends GroovyTestCase { } public void testClassDeclarationHeader() throws Exception { - final String base = "org/codehaus/groovy/tools/groovydoc/testfiles/a"; + final String base = "org/codehaus/groovy/tools/groovydoc/testfiles"; htmlTool.add(Arrays.asList( - base + "/Base.groovy" + base + "/JavaInterfaceWithTypeParam.java", + base + "/GroovyInterfaceWithTypeParam.groovy", + base + "/JavaInterfaceWithMultipleInterfaces.java", + base + "/GroovyInterfaceWithMultipleInterfaces.groovy", + base + "/ClassWithMethodComment.java", + base + "/DocumentedClass.groovy", + base + "/JavaClassWithMultipleInterfaces.java", + base + "/GroovyClassWithMultipleInterfaces.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()); + final String javaBaseInterface = output.getText(MOCK_DIR + "/" + base + "/JavaInterfaceWithTypeParam.html"); + final String groovyBaseInterface = output.getText(MOCK_DIR + "/" + base + "/GroovyInterfaceWithTypeParam.html"); + final String javaDerivedInterface = output.getText(MOCK_DIR + "/" + base + "/JavaInterfaceWithMultipleInterfaces.html"); + final String groovyDerivedInterface = output.getText(MOCK_DIR + "/" + base + "/GroovyInterfaceWithMultipleInterfaces.html"); + final String javaBaseClass = output.getText(MOCK_DIR + "/" + base + "/ClassWithMethodComment.html"); + final String groovyBaseClass = output.getText(MOCK_DIR + "/" + base + "/DocumentedClass.html"); + final String javaDerivedClass = output.getText(MOCK_DIR + "/" + base + "/JavaClassWithMultipleInterfaces.html"); + final String groovyDerivedClass = output.getText(MOCK_DIR + "/" + base + "/GroovyClassWithMultipleInterfaces.html"); + + final String object = Pattern.quote( + "<a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html' title='Object'>Object</a>"); + final String interfaces = Pattern.quote( + "org.codehaus.groovy.tools.groovydoc.testfiles.GroovyInterface1, " + + "org.codehaus.groovy.tools.groovydoc.testfiles.JavaInterface1, " + + "<a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html' title='Runnable'>Runnable</a>"); + + final Pattern baseInterface = Pattern.compile( + "<pre>" + + "(public )?interface (Java|Groovy)InterfaceWithTypeParam<T>" + + "</pre>"); + final Pattern derivedInterface = Pattern.compile( + "<pre>" + + "(public )?interface (Java|Groovy)InterfaceWithMultipleInterfaces\n" + + "extends " + interfaces + + "</pre>"); + final Pattern baseClass = Pattern.compile( + "<pre>" + + "(public )?class (ClassWithMethodComment|DocumentedClass)\n" + + "extends " + object + + "</pre>"); + final Pattern derivedClass = Pattern.compile( + "<pre>" + + "(public )?abstract class (Java|Groovy)ClassWithMultipleInterfaces\n" + + "extends " + object + "\n" + + "implements " + interfaces + + "</pre>"); + + assertTrue("The Java base interface declaration header should match", baseInterface.matcher(javaBaseInterface).find()); + assertTrue("The Groovy base interface declaration header should match", baseInterface.matcher(groovyBaseInterface).find()); + assertTrue("The Java derived interface declaration header should match", derivedInterface.matcher(javaDerivedInterface).find()); + assertTrue("The Groovy derived interface declaration header should match", derivedInterface.matcher(groovyDerivedInterface).find()); + assertTrue("The Java base class declaration header should match", baseClass.matcher(javaBaseClass).find()); + assertTrue("The Groovy base class declaration header should match", baseClass.matcher(groovyBaseClass).find()); + assertTrue("The Java derived class declaration header should match", derivedClass.matcher(javaDerivedClass).find()); + assertTrue("The Groovy derived class declaration header should match", derivedClass.matcher(groovyDerivedClass).find()); } public void testJavaGenericsTitle() throws Exception { diff --git a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/GroovyInterfaceWithTypeParam.groovy b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/GroovyInterfaceWithTypeParam.groovy new file mode 100644 index 0000000..ec5eaea --- /dev/null +++ b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/GroovyInterfaceWithTypeParam.groovy @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.codehaus.groovy.tools.groovydoc.testfiles + +interface GroovyInterfaceWithTypeParam<T> { +} diff --git a/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/JavaInterfaceWithTypeParam.java b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/JavaInterfaceWithTypeParam.java new file mode 100644 index 0000000..1fe43c6 --- /dev/null +++ b/subprojects/groovy-groovydoc/src/test/groovy/org/codehaus/groovy/tools/groovydoc/testfiles/JavaInterfaceWithTypeParam.java @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.codehaus.groovy.tools.groovydoc.testfiles; + +public interface JavaInterfaceWithTypeParam<T> { +}