Bug 314413 - Relative link inside ListenerList.IDENTITY and EQUALITY cause broken links in generated Javadoc
Summary: Relative link inside ListenerList.IDENTITY and EQUALITY cause broken links in...
Status: VERIFIED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: Components (show other bugs)
Version: 3.6   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.7 RC3   Edit
Assignee: Thomas Watson CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
: 346825 (view as bug list)
Depends on:
Blocks: 314328
  Show dependency tree
 
Reported: 2010-05-26 04:35 EDT by Dani Megert CLA
Modified: 2011-05-24 13:17 EDT (History)
1 user (show)

See Also:

Attachments
javadoc patch (2.83 KB, patch)
2011-05-23 09:46 EDT, Thomas Watson CLA 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2010-05-26 04:35:03 EDT 
3.6 RC2.

org.eclipse.core.runtime.ListenerList.IDENTITY refers to Javadoc/HTML
inside the same class using a relative link:
<a href="#same">same</a>

This relative link is broken once this is generated by Javadoc into
the alphabetical index.
Comment 1 Dani Megert CLA 2010-05-26 08:56:34 EDT 
I would argue that this is a bug of the javadoc tool: it should rewrite relative URLs when moving files around. However, I doubt this will be fixed soon, so changing our Javadoc might be the best path to follow.
Comment 2 Thomas Watson CLA 2010-05-26 09:16:20 EDT 
Dani, where does this show up as a problem?  When I view the javadoc through eclipse 3.6 help it seems to work fine.  The same links take you back to the top of the javadoc page for ListenernList.  The Galileo help also looks fine:

http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/runtime/ListenerList.html
Comment 3 Dani Megert CLA 2010-05-26 09:30:02 EDT 
It appears in the index where the field is taken out of its context:
http://help.eclipse.org/galileo/topic/org.eclipse.platform.doc.isv/reference/api/index-files/index-9.html
Comment 5 Thomas Watson CLA 2011-05-23 09:36:16 EDT 
*** Bug 346825 has been marked as a duplicate of this bug. ***
Comment 6 Thomas Watson CLA 2011-05-23 09:37:40 EDT 
In bug346825 Dani provides a solution.  Lets give it a try.
Comment 7 Thomas Watson CLA 2011-05-23 09:46:18 EDT 
Created attachment 196337 [details]
javadoc patch

Patch to use <a href="ListenerList.html#same">same</a>
Comment 8 Thomas Watson CLA 2011-05-23 09:47:38 EDT 
Patch released.
Comment 9 Thomas Watson CLA 2011-05-24 13:17:39 EDT 
I verified this is fixed in the I20110524-0900 build.