Bug 41610 - valid javadoc (verified from dialog) not binded to jar [javadoc]
Summary: valid javadoc (verified from dialog) not binded to jar [javadoc]
Status: RESOLVED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows 2000
: P3 enhancement (vote)
Target Milestone: 3.2   Edit
Assignee: Martin Aeschlimann CLA
QA Contact:
URL:
Whiteboard:
Keywords: helpwanted
Depends on:
Blocks:
 
Reported: 2003-08-15 10:09 EDT by quartz quartz CLA
Modified: 2007-02-12 06:01 EST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description quartz quartz CLA 2003-08-15 10:09:44 EDT
I used j2ee.jar in a project, and while the javadoc folder is validated
(index.html and package list), the tooltips do not show the javadoc info, and
the jar icon does not have the "books" on it, like other documented jar I
sucessfully have configured.

No message in error log. Eclipse 3.0 i20030806, but existed in previous versions
too. I already have javadoc on the rt.jar, but not on the servlet nor ejb, which
I only import from j2ee.jar
Comment 1 Olivier Thomann CLA 2003-08-17 19:07:02 EDT
Move to JDT/UI
Comment 2 Dirk Baeumer CLA 2003-08-18 04:09:01 EDT
Martin, can you please comment on this.
Comment 3 Martin Aeschlimann CLA 2003-08-18 06:06:38 EDT
The Javadoc shown in tooltips is extracted from the attached source. So what you
have to fo is to attach source to j2ee.jar.

The external javadoc is only shown on 'Open external javadoc (Shift F2)'.

ok to close?
Comment 4 quartz quartz CLA 2003-08-18 08:30:38 EDT
But why is it based on source?!!!
Isn't that's useless in most API and libraries like commercial products?

Please base the tooltips on the javadoc, not the source.
Comment 5 Martin Aeschlimann CLA 2003-08-18 08:39:55 EDT
There are two reasons:
- The source is mostly more up to date than the generated Javadoc. This might
not make a difference for JAR's but having the source attached to JAR's is very
helpful for debugging as well.
- Extracting documentation from the generated HTML is not trivial as this
requires guessing about how the HTML was generated. 

However I agree that for non open sourece libraries it would be nice to have
that feature. I think there are already feature requests for that in bugzilla.
Comment 6 quartz quartz CLA 2003-08-20 09:47:58 EDT
fyi: the source for j2ee is not available and we cannot attach more than one
source to a jar (like servlet api and ejb api).

Yes, javadoc parsing is a must.
Comment 7 Martin Aeschlimann CLA 2003-08-20 12:58:27 EDT
Note that there is a extension point for hovers, so an external plugin could
provide this functionality.
Comment 8 Martin Aeschlimann CLA 2003-08-27 11:10:33 EDT
set to later
Comment 9 quartz quartz CLA 2003-08-27 12:23:14 EDT
In other words, set to forget-me?
Keep open please. It doesn't cost much.
Many other bugs have been opened for more than a year.
Imagine if you resolve this one to later... it will never be fixed.

Should have been done long ago, when javadoc tooltip appeared.
Comment 10 Martin Aeschlimann CLA 2003-08-27 12:44:43 EDT
Please do not reopen bugs. Please understand that we have to prioritize bug and
feture requests. I have an inbox which is not maintainable anymore if it gets
too big.
I'm browsing the LATER bugs in regular fashion, be assured.

I set keywords to 'helpwanted' to signal that this bug would be a nice project
for an external contributor. What about you?! :-)

Comment 11 Jay Johnston CLA 2007-02-09 18:22:08 EST
I am able to, with Eclipse 3.2.1, attach external javadocs to a jar and cause eclipse to correctly display the tooltips by doing the following:
- In Package Explorer, open the properties for the project
- Select "Java Build Path"
- Find the jar and show the options by expanding the tree node
- Double-click "Javadoc Location" and enter the location

It seems to me this bug should be totally closed.
Comment 12 Martin Aeschlimann CLA 2007-02-12 06:00:26 EST
Reopen
Comment 13 Martin Aeschlimann CLA 2007-02-12 06:01:18 EST
You're right, this got added in 3.2