Home » Language IDEs » Java Development Tools (JDT) » Displaying API Documentation from within Eclipse
| Displaying API Documentation from within Eclipse [message #156485] |
Wed, 28 April 2004 21:38  |
Eclipse User |
|
|
|
Originally posted by: l.levinson.grc.nasa.gov
I just sent this as a reply to a posting from last week, but after I'd sent
it out, I reallized that it probably wouldn't be noticed unless I sent it as
a new posting. So... sorry for the duplication, but I really DO want to
know how to fix this frustrating problem, so here it is again...
Hi All,
I've just started using Eclipse in the last week or so, but I was actually
just about to post essentially the same question...
I've been trying for awhile now to get the API documentation to come up
properly from within the Eclipse environment, but I can't seem to get it to
work, no matter what I do! I'm beginning to wonder if there's a bug in the
system, but I'm hoping it's just
that I'm doing something wrong. I followed the recommendations in the Help
system to specify the documentation's "URL" in the Properties for rt.jar,
but it still doesn't work properly. I've tried specifying both the location
on my hard drive and the online location - but either way, it starts to
display the documentation page, and then replaces it with the darned
introductory "Using Eclipse help system" screen, which has no "navigation
buttons" or anything on it to allow you to move back to the previous screen!
(It's the same screen that I get when I select Help/Help Contents, but I
haven't been able to figure out any way to prevent it from coming up and
"displacing" the documentation screen!)
Please help!
Thanks in advance for any and all replies!
"Phillip Rhodes" <mindcrime@cpphacker.co.uk> wrote in message
news:c64oq7$9g4$1@eclipse.org...
> Ady Wang wrote:
>
> > Hello,
> >
> > I wonder if it's possible in Eclipse to have a look at the Java SDK API
> > documentation?Thanks a lot!
> >
>
> Highlight a class name somewhere in your code, that's part of the
> standard library and hit Shift+F2, it should display the API docs
> for that class...
>
> You may have to configure the location of the javadoc, but in theory
> it should just work. You can also "attach" external javadoc for classes
> defined in the current project, so you can do the same Shift+F2 business
> with those as well. I'm not sure about linking javadoc for classes
> defined in referenced libraries...
>
>
> TTYL,
>
> Phillip
>
|
|
|
| Re: Displaying API Documentation from within Eclipse [message #156536 is a reply to message #156485] |
Thu, 29 April 2004 00:23  |
| Eclipse User |
|
|
|
Originally posted by: eclipse.rizzoweb.com
L. Levinson wrote:
> I've been trying for awhile now to get the API documentation to come up
> properly from within the Eclipse environment, but I can't seem to get it to
> work, no matter what I do! I'm beginning to wonder if there's a bug in the
> system, but I'm hoping it's just
> that I'm doing something wrong. I followed the recommendations in the Help
> system to specify the documentation's "URL" in the Properties for rt.jar,
> but it still doesn't work properly. I've tried specifying both the location
> on my hard drive and the online location - but either way, it starts to
> display the documentation page, and then replaces it with the darned
> introductory "Using Eclipse help system" screen, which has no "navigation
> buttons" or anything on it to allow you to move back to the previous screen!
> (It's the same screen that I get when I select Help/Help Contents, but I
> haven't been able to figure out any way to prevent it from coming up and
> "displacing" the documentation screen!)
Which version of Eclipse are you using? I can only help with 2.1x at
this point since I have not adopted the early 3.0 builds.
In your preferences for Java > Installed JREs, you can select a JRE and
choose Edit... where it lets you specify the JavaDoc location (among
other things). Do you have that properly set? Also, is the JRE you have
set up in Eclipse a full JDK with source? If yes, you can try to attach
the source code for the JDK (src.zip in most cases) - that will enable
the tool-tip JavaDoc in your Java editors.
HTH,
Eric
--
I give "Reality" as my previous address.
|
|
|
| Re: Displaying API Documentation from within Eclipse [message #156542 is a reply to message #156536] |
Thu, 29 April 2004 00:49 |
| Eclipse User |
|
|
|
Originally posted by: l.levinson.grc.nasa.gov
I'm currently using version 2.1.3, although when I first had this problem, I
was using 2.1.2. But then I decided to try the "Help/Software Updates"
option - thinking maybe the problem was that I was using out-of-date
software - and it updated the software to version 2.1.3. Unfortunately,
tho, the problem didn't go away!
I did try your suggestion of going in and specifying the Javadoc location
under Window/Preferences/Java/Installed JREs, tho, but it still does the
same thing: when I hit F1 (and then select the "Javadoc" option) or
Shift-F2, it - very briefly! - loads the API documentation page, but then
loads that "intro" page right over it. And there doesn't seem to be any way
to get rid of the "intro" page, and get back to the documentation page!
What I don't know, though, is whether it's working properly for anyone else,
or whether others are having the same problem? Because if it's just me,
then I'm guessing there must be something wrong with my configuration (or
maybe some kind of "first-time-user flag" that's set and that I haven't
disabled???); but I have absolutely no idea where to look to fix the
problem!
Any suggestions???
Thanks for your time!
"Eric Rizzo" <eclipse@rizzoweb.com> wrote in message
news:c6pvbb$sa3$1@eclipse.org...
> L. Levinson wrote:
> > I've been trying for awhile now to get the API documentation to come
up
> > properly from within the Eclipse environment, but I can't seem to get it
to
> > work, no matter what I do! I'm beginning to wonder if there's a bug in
the
> > system, but I'm hoping it's just
> > that I'm doing something wrong. I followed the recommendations in the
Help
> > system to specify the documentation's "URL" in the Properties for
rt.jar,
> > but it still doesn't work properly. I've tried specifying both the
location
> > on my hard drive and the online location - but either way, it starts to
> > display the documentation page, and then replaces it with the darned
> > introductory "Using Eclipse help system" screen, which has no
"navigation
> > buttons" or anything on it to allow you to move back to the previous
screen!
> > (It's the same screen that I get when I select Help/Help Contents, but I
> > haven't been able to figure out any way to prevent it from coming up and
> > "displacing" the documentation screen!)
>
> Which version of Eclipse are you using? I can only help with 2.1x at
> this point since I have not adopted the early 3.0 builds.
>
> In your preferences for Java > Installed JREs, you can select a JRE and
> choose Edit... where it lets you specify the JavaDoc location (among
> other things). Do you have that properly set? Also, is the JRE you have
> set up in Eclipse a full JDK with source? If yes, you can try to attach
> the source code for the JDK (src.zip in most cases) - that will enable
> the tool-tip JavaDoc in your Java editors.
>
> HTH,
> Eric
> --
> I give "Reality" as my previous address.
|
|
|
| Update Re: Displaying API Documentation from within Eclipse [message #156548 is a reply to message #156542] |
Thu, 29 April 2004 01:38 |
| Eclipse User |
|
|
|
Originally posted by: l.levinson.grc.nasa.gov
Well... I can't say as I understand things, really, but I WAS able to fix
the problem, anyway! The only thing I can figure is that there MUST be some
kind of "subtle" bug in the software...
Anyway, here's what I did - in case anyone else SHOULD run across this
problem...
After sending out my last post, I decided to try looking through the
"Preferences" dialog again, to see if there was anything else that might
impact the situation. First I tried setting the "Java/Javadoc" setting. I
didn't really think that would do it, and - as expected - it didn't. So
then I decided to try looking under the "Help" option. The "Embedded
Internet Explorer Adapter" option was currently selected, and the "Custom
Browser command" textbox at the bottom of the dialog was grayed out, but was
filled in with the command for Internet Explorer. So, I decided to change
the checkbox selection to "Custom Browser" and see what happened. Well, lo
and behold, it worked! So, then I decided to try the other option, "Default
System Browser" - and that worked too! So... I got curious, and decided to
put it back to "Embedded Internet Explorer Adapter" - just to see what would
happen. And THAT worked too!! So, it's now working properly, but I still
have NO idea why!
But at least it works!!! :)
"L. Levinson" <l.levinson@grc.nasa.gov> wrote in message
news:c6q1e2$tl9$1@eclipse.org...
> I'm currently using version 2.1.3, although when I first had this problem,
I
> was using 2.1.2. But then I decided to try the "Help/Software Updates"
> option - thinking maybe the problem was that I was using out-of-date
> software - and it updated the software to version 2.1.3. Unfortunately,
> tho, the problem didn't go away!
>
> I did try your suggestion of going in and specifying the Javadoc location
> under Window/Preferences/Java/Installed JREs, tho, but it still does the
> same thing: when I hit F1 (and then select the "Javadoc" option) or
> Shift-F2, it - very briefly! - loads the API documentation page, but then
> loads that "intro" page right over it. And there doesn't seem to be any
way
> to get rid of the "intro" page, and get back to the documentation page!
>
> What I don't know, though, is whether it's working properly for anyone
else,
> or whether others are having the same problem? Because if it's just me,
> then I'm guessing there must be something wrong with my configuration (or
> maybe some kind of "first-time-user flag" that's set and that I haven't
> disabled???); but I have absolutely no idea where to look to fix the
> problem!
>
> Any suggestions???
>
> Thanks for your time!
>
> "Eric Rizzo" <eclipse@rizzoweb.com> wrote in message
> news:c6pvbb$sa3$1@eclipse.org...
> > L. Levinson wrote:
> > > I've been trying for awhile now to get the API documentation to come
> up
> > > properly from within the Eclipse environment, but I can't seem to get
it
> to
> > > work, no matter what I do! I'm beginning to wonder if there's a bug
in
> the
> > > system, but I'm hoping it's just
> > > that I'm doing something wrong. I followed the recommendations in the
> Help
> > > system to specify the documentation's "URL" in the Properties for
> rt.jar,
> > > but it still doesn't work properly. I've tried specifying both the
> location
> > > on my hard drive and the online location - but either way, it starts
to
> > > display the documentation page, and then replaces it with the darned
> > > introductory "Using Eclipse help system" screen, which has no
> "navigation
> > > buttons" or anything on it to allow you to move back to the previous
> screen!
> > > (It's the same screen that I get when I select Help/Help Contents, but
I
> > > haven't been able to figure out any way to prevent it from coming up
and
> > > "displacing" the documentation screen!)
> >
> > Which version of Eclipse are you using? I can only help with 2.1x at
> > this point since I have not adopted the early 3.0 builds.
> >
> > In your preferences for Java > Installed JREs, you can select a JRE and
> > choose Edit... where it lets you specify the JavaDoc location (among
> > other things). Do you have that properly set? Also, is the JRE you have
> > set up in Eclipse a full JDK with source? If yes, you can try to attach
> > the source code for the JDK (src.zip in most cases) - that will enable
> > the tool-tip JavaDoc in your Java editors.
> >
> > HTH,
> > Eric
> > --
> > I give "Reality" as my previous address.
>
>
|
|
|
Goto Forum:
Current Time: Thu Jul 24 21:59:23 EDT 2025
Powered by FUDForum. Page generated in 0.10738 seconds |
Home