Bug 431591 - [1.8] Javadoc tool from JavaSE 8 reveals HTML problems in APIs
Summary: [1.8] Javadoc tool from JavaSE 8 reveals HTML problems in APIs
Status: NEW
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 4.4   Edit
Hardware: All All
: P4 trivial (vote)
Target Milestone: ---   Edit
Assignee: Jay Arthanareeswaran CLA
QA Contact:
URL:
Whiteboard: stalebug
Keywords:
Depends on:
Blocks:
 
Reported: 2014-03-30 20:53 EDT by Markus Keller CLA
Modified: 2024-05-03 15:22 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Markus Keller CLA 2014-03-30 20:53:05 EDT
With bug 431236, we now get new HTML problems from Java SE 8's Javadoc tool:

http://download.eclipse.org/eclipse/downloads/drops4/N20140329-1500/compilelogs/jdt.doc.isv.javadoc.txt

The APIs in BindingKey would best be fixed by using <pre>{@code ... }</pre>, but that triggers wrong Javadoc warnings in ecj (bug 206345).
Comment 1 Markus Keller CLA 2014-04-04 10:39:12 EDT
I've temporarily disabled -Xdoclint html/syntax checks, so that we can see if there are any other problems with Javadoc 8:
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=75aa57e71cd387ffd9a5da03d04213a9ac5bd5c6

Trying to fix "javadoc: warning - Error fetching URL: http://download.oracle.com/javase/8/docs/api" with http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=62dfc077f9c5e8e0440bcbc9d04184d3c49ba945
Comment 2 Markus Keller CLA 2014-04-07 08:20:32 EDT
With http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=0d455992444fd4be8c029a1a5fb613eef20cf025 , the build now uses the same level of validation we already had with Javadoc 7 (just -Xdoclint:reference).

Would still be good to eventually clean up the APIs so that we can enable the default doclint options again, but this can wait until we're in the RC cycle and have nothing else to do.
Comment 3 Jay Arthanareeswaran CLA 2014-05-08 07:10:00 EDT
Markus, sorry I didn't look at the errors while the builds were available. Can you confirm that the issue was only with BindingKey?

Assuming bug 206345 doesn't get fixed for Luna, what is the fix you had in mind? I just tried removing <code> and </code> altogether and didn't seem to change any format. Looks we could just do this.
Comment 4 Markus Keller CLA 2014-05-08 13:32:29 EDT
(In reply to Jayaprakash Arthanareeswaran from comment #3)
> Markus, sorry I didn't look at the errors while the builds were available.
> Can you confirm that the issue was only with BindingKey?

No, that was just the first of a gazillion files with issues. Note that this bug has low priority and can easily be moved to 4.5 if we have better things to do. The Xdoclint options won't be enabled in 4.4 builds.


> Assuming bug 206345 doesn't get fixed for Luna, what is the fix you had in
> mind? I just tried removing <code> and </code> altogether and didn't seem to
> change any format. Looks we could just do this.

Removing the redundant <code> tags would also be good, but that's not the actual problem. You can see the problems by running Project > Generate Javadoc...: Select a javadoc.exe from JDK 8 and make sure the last page doesn't contain an Xdoclint argument that would disable html or syntax checking.

These are the two kinds of problems in BindingKey:

C:\e\w\master\git\eclipse.jdt.core\org.eclipse.jdt.core\model\org\eclipse\jdt\core\BindingKey.java:46: error: bad use of '>'
	 * createArrayTypeBindingKey("I", 2) -> "[[I"
	                                      ^
C:\e\w\master\git\eclipse.jdt.core\org.eclipse.jdt.core\model\org\eclipse\jdt\core\BindingKey.java:49: error: unexpected end tag: </p>
	 * </p>
	   ^
Comment 5 Jay Arthanareeswaran CLA 2014-05-22 22:57:12 EDT
With not much time left in Luna, we will handle this in 4.5 or 4.4.1.
Comment 6 Jay Arthanareeswaran CLA 2015-05-12 04:02:07 EDT
No progress on this. Moving out to 4.6.
Comment 7 Jay Arthanareeswaran CLA 2016-04-05 03:46:20 EDT
Moving out of 4.6
Comment 8 Manoj N Palat CLA 2018-05-21 06:13:52 EDT
Bulk move out of 4.8
Comment 9 Eclipse Genie CLA 2020-05-20 17:32:34 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.
Comment 10 Eclipse Genie CLA 2022-05-13 10:37:35 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.
Comment 11 Eclipse Genie CLA 2024-05-03 15:22:53 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.