Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Newcomers » Newcomers » Is there a plugin that lets me access the documentation for a class from the editor?
Is there a plugin that lets me access the documentation for a class from the editor? [message #188453] Tue, 16 January 2007 18:41 Go to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

What I would like to do is select a class in the editor and right click to open the JavaDoc for that class.

Opening the declaration is already available. That's really handy. But sometimes I want to see a page from SUN's JavaDocs for a class. There must be a plugin for that somewhere.

Does anyone know where to find that plugin?
Re: Is there a plugin that lets me access the documentation for a class from the editor? [message #188546 is a reply to message #188453] Wed, 17 January 2007 04:45 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: eclipse5.rizzoweb.com

DemonDuck wrote:
> What I would like to do is select a class in the editor and right click
> to open the JavaDoc for that class.
>
> Opening the declaration is already available. That's really handy. But
> sometimes I want to see a page from SUN's JavaDocs for a class. There
> must be a plugin for that somewhere.
>
> Does anyone know where to find that plugin?

Not a plugin, just his Shift+F2. Alternatively, you can open the JavaDoc
view (Window > Show View) and it will automatically sync with whatever
is under the cursor in the editor. It is an embedded view within
Eclipse, not a full browser.

Hope this helps,
Eric
Re: Is there a plugin that lets me access the documentation for a class from the editor? [message #188651 is a reply to message #188546] Wed, 17 January 2007 18:44 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

Eric Rizzo wrote:
> DemonDuck wrote:
>
>> What I would like to do is select a class in the editor and right
>> click to open the JavaDoc for that class.
>>
>> Opening the declaration is already available. That's really handy.
>> But sometimes I want to see a page from SUN's JavaDocs for a class.
>> There must be a plugin for that somewhere.
>>
>> Does anyone know where to find that plugin?
>
>
> Not a plugin, just his Shift+F2. Alternatively, you can open the JavaDoc
> view (Window > Show View) and it will automatically sync with whatever
> is under the cursor in the editor. It is an embedded view within
> Eclipse, not a full browser.
>
> Hope this helps,
> Eric

I've used that -- it brings up a summary of the Class selected but not a full JavaDoc view with methods and all that one sees in the full documentation. I would be really handy to somehow connect with the JavaDocs for the JDK one is using. I usually have my browser running on the JDK JavaDocs while I'm using Eclipse.

IMHO any IDE is somehow incomplete without direct access to documentation.
Re: Is there a plugin that lets me access the documentation for a class from the [message #188694 is a reply to message #188651] Wed, 17 January 2007 20:26 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: wegener.cboenospam.com

DemonDuck wrote:

> Eric Rizzo wrote:
>> DemonDuck wrote:
>>
>>> What I would like to do is select a class in the editor and right
>>> click to open the JavaDoc for that class.
>>>
>>> Opening the declaration is already available. That's really handy.
>>> But sometimes I want to see a page from SUN's JavaDocs for a class.
>>> There must be a plugin for that somewhere.
>>>
>>> Does anyone know where to find that plugin?
>>
>>
>> Not a plugin, just his Shift+F2. Alternatively, you can open the JavaDoc
>> view (Window > Show View) and it will automatically sync with whatever
>> is under the cursor in the editor. It is an embedded view within
>> Eclipse, not a full browser.
>>
>> Hope this helps,
>> Eric

> I've used that -- it brings up a summary of the Class selected but not a
full JavaDoc view with methods and all that one sees in the full
documentation. I would be really handy to somehow connect with the JavaDocs
for the JDK one is using. I usually have my browser running on the JDK
JavaDocs while I'm using Eclipse.

Did you try Shift+F2 as indicated initially in the response? This brings
up the JavaDoc for the element under the cursor.
> IMHO any IDE is somehow incomplete without direct access to documentation.

Eclipse has at least 3 ways to access documentation. Hover help, JavaDoc
view, and Shift+F2
Re: Is there a plugin that lets me access the documentation for a class from the editor? [message #188774 is a reply to message #188651] Thu, 18 January 2007 09:38 Go to previous messageGo to next message
Asaf Yaffe is currently offline Asaf YaffeFriend
Messages: 333
Registered: July 2009
Senior Member
DemonDuck wrote:
> I've used that -- it brings up a summary of the Class selected but not a
> full JavaDoc view with methods and all that one sees in the full
> documentation. I would be really handy to somehow connect with the
> JavaDocs for the JDK one is using. I usually have my browser running on
> the JDK JavaDocs while I'm using Eclipse.
> IMHO any IDE is somehow incomplete without direct access to documentation.

Open the Help View (Ctrl+F1 or Window > Show View > Other... > Help).
Then, whenever the cursor is pointing to a Java class in the Java
editor, the Help view will show a topic titled "Javadoc for <the class
the cursor is pointing to>". Click this link and the Javadoc entry for
the selected class will open in the Help View. You may need to configure
the Javadoc URL for the JRE you are using for this to work properly.

HTH,
Asaf

--
Asaf Yaffe
Eclipse TPTP Committer, JVMTI Profiler
Re: Is there a plugin that lets me access the documentation for a class from the [message #188880 is a reply to message #188694] Fri, 19 January 2007 01:11 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

Dave Wegener wrote:
> DemonDuck wrote:
>
>> Eric Rizzo wrote:
>
> Eclipse has at least 3 ways to access documentation. Hover help,
> JavaDoc view, and Shift+F2
>

I don't know what you see using the above methods but I see only brief summaries of the JavaDocs. Relatively useless ...
Re: Is there a plugin that lets me access the documentation for a class from the editor? [message #188896 is a reply to message #188774] Fri, 19 January 2007 01:21 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

Asaf Yaffe wrote:
> DemonDuck wrote:
>
>> I've used that -- it brings up a summary of the Class selected but not
>> a full JavaDoc view with methods and all that one sees in the full
>> documentation. I would be really handy to somehow connect with the
>> JavaDocs for the JDK one is using. I usually have my browser running
>> on the JDK JavaDocs while I'm using Eclipse. IMHO any IDE is somehow
>> incomplete without direct access to documentation.
>
>
> Open the Help View (Ctrl+F1 or Window > Show View > Other... > Help).
> Then, whenever the cursor is pointing to a Java class in the Java
> editor, the Help view will show a topic titled "Javadoc for <the class
> the cursor is pointing to>". Click this link and the Javadoc entry for
> the selected class will open in the Help View. You may need to configure
> the Javadoc URL for the JRE you are using for this to work properly.
>
> HTH,
> Asaf
>
In the Help Preferences, what should be the Help Server address? SUN's JavaDoc page? Something else?

This is what I see, for example, for BufferedImage.

---------

The BufferedImage subclass describes an java.awt.Image Image with an accessible buffer of image data. A BufferedImage is comprised of a ColorModel and a Raster of image data. The number and types of bands in the SampleModel of the Raster must match the number and types required by the ColorModel to represent its color and alpha components. All BufferedImage objects have an upper left corner coordinate of (0, 0). Any Raster used to construct a BufferedImage must therefore have minX=0 and minY=0.

This class relies on the data fetching and setting methods of Raster, and on the color characterization methods of ColorModel.

See Also:
ColorModel
Raster
WritableRaster
@version
10 Feb 1997
Re: Is there a plugin that lets me access the documentation for a class from the [message #189117 is a reply to message #188880] Fri, 19 January 2007 22:56 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: eclipse5.rizzoweb.com

DemonDuck wrote:
> Dave Wegener wrote:
>> DemonDuck wrote:
>>
>>> Eric Rizzo wrote:
>>
>> Eclipse has at least 3 ways to access documentation. Hover help,
>> JavaDoc view, and Shift+F2
>>
>
> I don't know what you see using the above methods but I see only brief
> summaries of the JavaDocs. Relatively useless ...

I don't know what to say to you. Thousands of programmers find those
tools very useful. You don't. We've tried to answer all your questions,
but I guess it is not enough. <shrug>

Specific enhancement ideas are always welcome: http://bugs.eclipse.org -
seems like you have some pre-conceived idea of how you'd like to see
things; please look through what is there and if it doesn't meet your
needs then please enter feature requests.

Eric
Re: Is there a plugin that lets me access the documentation for a class from the [message #189125 is a reply to message #189117] Sat, 20 January 2007 00:57 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

Eric Rizzo wrote:

> I don't know what to say to you. Thousands of programmers find those
> tools very useful. You don't. We've tried to answer all your questions,
> but I guess it is not enough. <shrug>
>
> Specific enhancement ideas are always welcome: http://bugs.eclipse.org -
> seems like you have some pre-conceived idea of how you'd like to see
> things; please look through what is there and if it doesn't meet your
> needs then please enter feature requests.
>
> Eric

Well, I appreciate that you have taken the time to reply. THat is always a welcome courtesy.

But you have only tried to convince me that the methods for help are sufficient -- and they are -- it is the CONTENT not the methods. The content should be at least as complete as SUN's JDK documentation. It is not. And all I've asked is how do I get to SUN's JavaDoc's using the same METHODS as exist now in Eclipse.

There seems to be some confusion on your part between method and content. The method is fine -- the content is not fine. It is dated and abbreviated. It should be just a small step for all the wonderful code and multitudinous feature set to access the CONTENT of SUN's JavaDocs for the JDK.

That's my feature request. And I will end my part of this dialog now...
Re: Is there a plugin that lets me access the documentation for a class from the [message #189191 is a reply to message #189125] Sat, 20 January 2007 22:50 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: eclipse5.rizzoweb.com

DemonDuck wrote:
> Well, I appreciate that you have taken the time to reply. THat is
> always a welcome courtesy.
> But you have only tried to convince me that the methods for help are
> sufficient -- and they are -- it is the CONTENT not the methods. The
> content should be at least as complete as SUN's JDK documentation. It
> is not. And all I've asked is how do I get to SUN's JavaDoc's using the
> same METHODS as exist now in Eclipse.
>
> There seems to be some confusion on your part between method and
> content. The method is fine -- the content is not fine. It is dated
> and abbreviated. It should be just a small step for all the wonderful
> code and multitudinous feature set to access the CONTENT of SUN's
> JavaDocs for the JDK.

Shift+F2, as has been pointed out several times, will get you to the
Javadoc pages directly.
Eclipse is not in the business of providing JavaDoc content (other than
for its own APIs); the content belongs to the library provider (Sun,
Jakarta, etc.). Eclipse's job is to present that content, which it does
in a variety of ways.


> That's my feature request. And I will end my part of this dialog now...

These newsgroups are not the correct forum for submitting feature
requests. See Bugzilla at http://bugs.eclipse.org. I think you have an
enhancement idea (basically, provide an internal browser to view Javadoc
content), so look to see if such a request already exists and if not
then enter a new one.

Eric
Re: Is there a plugin that lets me access the documentation for a class from the [message #189199 is a reply to message #189191] Sun, 21 January 2007 00:50 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

Eric Rizzo wrote:

>
> Shift+F2, as has been pointed out several times, will get you to the
> Javadoc pages directly.

> Eric

Only if you are online. If you are offline, you're out of luck.

But I repeat -- thank you for responding Eric. I really do appreciate your input.
Re: Is there a plugin that lets me access the documentation for a class from the [message #189206 is a reply to message #189199] Sun, 21 January 2007 02:20 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

DemonDuck wrote:
> Eric Rizzo wrote:
>
>>
>> Shift+F2, as has been pointed out several times, will get you to the
>> Javadoc pages directly.
>
>
>> Eric

But if their was a way to point to locally hosted JavaDocs rather than to SUN's hosted JavaDocs -- that would be the answer to my question.

Seems like it should be just a simple change to the URL that tells Eclipse where to look for the JavaDocs.

It must be somewhere. My unfamiliarity with Eclipse is the problem...
Re: Is there a plugin that lets me access the documentation for a class from the [message #189229 is a reply to message #189206] Sun, 21 January 2007 20:38 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: wegener.cboenospam.com

DemonDuck wrote:
> DemonDuck wrote:
>> Eric Rizzo wrote:
>>
>>>
>>> Shift+F2, as has been pointed out several times, will get you to the
>>> Javadoc pages directly.
>>
>>
>>> Eric
>
> But if their was a way to point to locally hosted JavaDocs rather than
> to SUN's hosted JavaDocs -- that would be the answer to my question.
>
> Seems like it should be just a simple change to the URL that tells
> Eclipse where to look for the JavaDocs.
>
> It must be somewhere. My unfamiliarity with Eclipse is the problem...
Window->Preferences->Installed JREs. Select the JRE you have local
javadoc for and click Edit. Select all of the .jar files that you have
local javadoc for (You can select them all by selecting the first one,
holding shift and selecting the last one). Select Javadoc Location.

If you have the javadoc expanded, use the top option. If you have the
javadoc in a zip file, use the bottom option.
Re: Is there a plugin that lets me access the documentation for a class from the [message #189245 is a reply to message #189229] Sun, 21 January 2007 23:06 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: kwarner.uneedspeed.net

David Wegener wrote:
> DemonDuck wrote:
>
>> DemonDuck wrote:
>>
>>> Eric Rizzo wrote:
>>>
>>>>
>>>> Shift+F2, as has been pointed out several times, will get you to the
>>>> Javadoc pages directly.
>>>
>>>
>>>
>>>> Eric
>>
>>
>> But if their was a way to point to locally hosted JavaDocs rather than
>> to SUN's hosted JavaDocs -- that would be the answer to my question.
>>
>> Seems like it should be just a simple change to the URL that tells
>> Eclipse where to look for the JavaDocs.
>>
>> It must be somewhere. My unfamiliarity with Eclipse is the problem...
>
> Window->Preferences->Installed JREs. Select the JRE you have local
> javadoc for and click Edit. Select all of the .jar files that you have
> local javadoc for (You can select them all by selecting the first one,
> holding shift and selecting the last one). Select Javadoc Location.
>
> If you have the javadoc expanded, use the top option. If you have the
> javadoc in a zip file, use the bottom option.

YES! YES! YES! This is the answer I needed. It works perfect. Ima happy duck...

THANKYOU!!!!!

I knew there was a way....
Re: Is there a plugin that lets me access the documentation for a class from the editor? [message #189382 is a reply to message #188896] Mon, 22 January 2007 08:26 Go to previous message
Asaf Yaffe is currently offline Asaf YaffeFriend
Messages: 333
Registered: July 2009
Senior Member
DemonDuck wrote:
> In the Help Preferences, what should be the Help Server address? SUN's
> JavaDoc page? Something else?
>

The Help Server address in the Help Preferences is an internal setting
for the Eclipse help system. It is not related to your Javadoc issue.
Leave it as is.

Do the following to check whether the Javadoc location is properly
configured for the Java environment you use:
1. Right click your Java project and select Properties
2. Select the Java Build Path category
3. Switch to the Libraries page, expand the JRE System Library node, and
then expand its rt.jar node and check that the Javadoc location points
to a valid URL. You can update this URL by clicking the Edit button.

HTH,
Asaf

--
Asaf Yaffe
Eclipse TPTP Committer, JVMTI Profiler
Previous Topic:Can't build Eclipse 3.2.1 source bundle on Mac
Next Topic:Writing a database application
Goto Forum:
  


Current Time: Thu Apr 25 19:07:43 GMT 2024

Powered by FUDForum. Page generated in 0.10886 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top