Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor javadoc improvements #10258

Merged
merged 1 commit into from
Jul 27, 2020
Merged

Conversation

keithc-ca
Copy link
Contributor

Avoid < and > in javadoc; use &lt; and &gt; instead.

Without these changes, building openj9 javadocs for jdknext (via ibmruntimes/openj9-openjdk-jdk#210) fails:

javadoc: error - An internal exception has occurred. 
	(java.lang.NullPointerException)
Please file a bug against the javadoc tool via the Java bug reporting page
(http://bugreport.java.com) after checking the Bug Database (http://bugs.java.com)
for duplicates. Include error messages and the following diagnostic in your report. Thank you.
java.lang.NullPointerException
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.isSelfClosingAllowed(Checker.java:424)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.visitStartElement(Checker.java:382)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.visitStartElement(Checker.java:106)
	at jdk.compiler.interim/com.sun.tools.javac.tree.DCTree$DCStartElement.accept(DCTree.java:850)
	at jdk.compiler.interim/com.sun.source.util.DocTreePathScanner.scan(DocTreePathScanner.java:71)
	at jdk.compiler.interim/com.sun.source.util.DocTreeScanner.scanAndReduce(DocTreeScanner.java:83)
	at jdk.compiler.interim/com.sun.source.util.DocTreeScanner.scan(DocTreeScanner.java:98)
	at jdk.compiler.interim/com.sun.source.util.DocTreeScanner.visitAuthor(DocTreeScanner.java:147)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.visitAuthor(Checker.java:815)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.visitAuthor(Checker.java:106)
	at jdk.compiler.interim/com.sun.tools.javac.tree.DCTree$DCAuthor.accept(DCTree.java:238)
	at jdk.compiler.interim/com.sun.source.util.DocTreePathScanner.scan(DocTreePathScanner.java:71)
	at jdk.compiler.interim/com.sun.source.util.DocTreeScanner.scan(DocTreeScanner.java:98)
	at jdk.compiler.interim/com.sun.source.util.DocTreeScanner.scanAndReduce(DocTreeScanner.java:106)
	at jdk.compiler.interim/com.sun.source.util.DocTreeScanner.visitDocComment(DocTreeScanner.java:185)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.visitDocComment(Checker.java:269)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.visitDocComment(Checker.java:106)
	at jdk.compiler.interim/com.sun.tools.javac.tree.DCTree$DCDocComment.accept(DCTree.java:138)
	at jdk.compiler.interim/com.sun.source.util.DocTreePathScanner.scan(DocTreePathScanner.java:50)
	at jdk.compiler.interim/com.sun.tools.doclint.Checker.scan(Checker.java:231)
	at jdk.compiler.interim/com.sun.tools.doclint.DocLint.scan(DocLint.java:351)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.WorkArounds.runDocLint(WorkArounds.java:111)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.Utils.getDocCommentTree0(Utils.java:2725)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.Utils.getDocCommentTree(Utils.java:2768)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.Utils$CommentHelperCache.computeIfAbsent(Utils.java:2914)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.Utils.getCommentHelper(Utils.java:2588)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.Utils.hasBlockTag(Utils.java:2632)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.Utils.hasHiddenTag(Utils.java:1556)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.ClassTree.buildTree(ClassTree.java:175)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.util.ClassTree.<init>(ClassTree.java:119)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:204)
	at jdk.javadoc.interim/jdk.javadoc.internal.doclets.toolkit.AbstractDoclet.run(AbstractDoclet.java:113)
	at jdk.javadoc.interim/jdk.javadoc.doclet.StandardDoclet.run(StandardDoclet.java:103)
	at jdk.javadoc.interim/jdk.javadoc.internal.tool.Start.parseAndExecute(Start.java:555)
	at jdk.javadoc.interim/jdk.javadoc.internal.tool.Start.begin(Start.java:399)
	at jdk.javadoc.interim/jdk.javadoc.internal.tool.Start.begin(Start.java:348)
	at jdk.javadoc.interim/jdk.javadoc.internal.tool.Main.execute(Main.java:63)
	at jdk.javadoc.interim/jdk.javadoc.internal.tool.Main.main(Main.java:52)

Signed-off-by: Keith W. Campbell <keithc@ca.ibm.com>
@pshipton pshipton self-assigned this Jul 27, 2020
@pshipton
Copy link
Member

The travis build should be sufficient testing for this.

@pshipton pshipton merged commit 485d0e0 into eclipse-openj9:master Jul 27, 2020
@keithc-ca keithc-ca deleted the javadoc branch July 27, 2020 23:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants