[news.eclipse.newcomer] Re: Java API documentation tooltip

[Steve Berry <dalroth5@xxxxxxxxxxx>]

Hello there.

To see the doc for anything, you have to have:

1. downloaded and installed it (I think it's a separate package from the
JDK; go to: http://java.sun.com/ and get the one you need);

and

2. associated it with its executables. As far as I can remember, the
association was automatic for the JDK, but it can be done for any jar as
long as there _is_ some doc! :) To specify doc for any given jar, do this:
right click on your project in the navigator view and select 'Properties'.
In that window, select 'Java Build Path'. In the right hand pane, select
the 'Libraries' tab and locate the jar you're interested in, then expand
the 'twistie' to its left and you'll see 4 new lines: 'Source attachment',
'Javadoc location', 'Native library location' and 'Access rules'. Click on
'Javadoc location' and then the 'Edit' button. 

If the doc is in a jar, select the lower radio button and point it at that
jar. Note that the upper button can deal with both local doc and doc out on
the web. Hit the 'Browse...' button and navigate to the doc folder which
contains the 'index.html' and 'package-list' file for the jar. To make sure
you've got the right one, use the 'Validate...' button. Finally, 'OK' your
way back to the project. This all takes a _lot_ longer to describe (and
read! :) than it does to execute, trust me.

You can follow the same procedure to attach the source code if it's OSS, of
course. :) Attaching the source is especially useful when debugging because
you will now be able to step through and set breakpoints in the code of the
third party products you're using as well as your own.

HTH

Steve