Skip to content
Permalink
Browse files
8267219: Javadoc method summary breaks when {@inheritdoc} from an emp…
…ty parent

Reviewed-by: hannesw
  • Loading branch information
liach authored and hns committed May 20, 2021
1 parent aba2265 commit 459abd561accc9f10456a9d63f7fa19c7f8e020e
@@ -326,8 +326,8 @@ public void addRow(Element element, List<Content> contents) {
HtmlStyle cellStyle = (columnStyles == null || colIndex > columnStyles.size())
? null
: columnStyles.get(colIndex);
// Replace empty content with HtmlTree.EMPTY to make sure the cell isn't dropped
HtmlTree cell = HtmlTree.DIV(cellStyle, !c.isEmpty() ? c : HtmlTree.EMPTY);
// Replace invalid content with HtmlTree.EMPTY to make sure the cell isn't dropped
HtmlTree cell = HtmlTree.DIV(cellStyle, c.isValid() ? c : HtmlTree.EMPTY);
if (rowStyle != null) {
cell.addStyle(rowStyle);
}
@@ -92,6 +92,23 @@ public boolean isEmpty() {
return true;
}

/**
* {@inheritDoc}
*
* @implSpec
* A content builder is valid if any of its content is; thus, it is
* valid to be added to an HtmlTree, which checks the validity of
* each content in this builder.
*/
@Override
public boolean isValid() {
for (Content content: contents) {
if (content.isValid())
return true;
}
return false;
}

@Override
public int charCount() {
int n = 0;
@@ -107,7 +107,8 @@ public Content add(CharSequence stringContent) {
public abstract boolean isEmpty();

/**
* Returns true if the content is valid.
* Returns true if the content is valid. This allows filtering during
* {@link #add(Content) addition}.
*
* @return true if the content is valid else return false
*/
@@ -0,0 +1,90 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @test
* @bug 8267219
* @summary The method summary's description cell should not be removed when
* it only has inline tags that don't produce any output
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestEmptyInheritDoc
*/

import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import javadoc.tester.JavadocTester;
import toolbox.ToolBox;

public class TestEmptyInheritDoc extends JavadocTester {

public static void main(String... args) throws Exception {
TestEmptyInheritDoc tester = new TestEmptyInheritDoc();
tester.runTests();
}

ToolBox tb = new ToolBox();
Path src;

TestEmptyInheritDoc() throws Exception {
src = Files.createDirectories(Paths.get("src"));
tb.writeJavaFiles(src,
"""
package pkg;
public class First {
public void act() {}
}
""",
"""
package pkg;
public class Second extends First {
/**
* {@inheritDoc}
*/
public void act() {}
public void bark() {}
}
""");
}

@Test
public void run() {
javadoc("-d", "out-empty-inheritdoc",
"-sourcepath", src.toString(),
"pkg");
checkExit(Exit.OK);

checkOutput("pkg/Second.html", true,
"""
<div class="col-second even-row-color method-summary-table \
method-summary-table-tab2 method-summary-table-tab4"><code>\
<a href="#act()" class="member-name-link">act</a>()</code></div>
<div class="col-last even-row-color method-summary-table \
method-summary-table-tab2 method-summary-table-tab4"></div>""");
}
}

1 comment on commit 459abd5

@openjdk-notifier

This comment has been minimized.

Copy link

@openjdk-notifier openjdk-notifier bot commented on 459abd5 May 20, 2021

Please sign in to comment.