Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Newcomers » Newcomers » How to read javadoc documentation from Eclipse?
How to read javadoc documentation from Eclipse? [message #113238] Sun, 30 October 2005 16:10 Go to next message
Eclipse UserFriend
Originally posted by: siegfried.heintze.com

I was looking for the documentation on the constructor arguments for
StreamReader last night and, while I was pleased the intellisense gave me
some nice hints, I could not figure out how to hi-lite "StreamReader" and
get a nice JavaDoc display.
Thanks,
Siegfried
Re: How to read javadoc documentation from Eclipse? [message #113301 is a reply to message #113238] Sun, 30 October 2005 22:13 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: hendrik_maryns.despammed.com

Siegfried Heintze uitte de volgende tekst op 30/10/2005 17:10:
> I was looking for the documentation on the constructor arguments for
> StreamReader last night and, while I was pleased the intellisense gave me
> some nice hints, I could not figure out how to hi-lite "StreamReader" and
> get a nice JavaDoc display.

What did you try, what did your code look like, have you tried F2, did
you hover your mouse and Ctrl click on it? ... Please be more specific,
and see http://catb.org/~esr/faqs/smart-questions.html.

H.

--
Hendrik Maryns

==================
www.lieverleven.be
http://aouw.org
Re: How to read javadoc documentation from Eclipse? [message #113352 is a reply to message #113238] Mon, 31 October 2005 12:53 Go to previous messageGo to next message
Jeff Myers is currently offline Jeff MyersFriend
Messages: 489
Registered: July 2009
Senior Member
Siegfried,

Source code must be attached for a class for Eclipse to read the javadoc
for it. You can change your installed Java Runtime to point to a Java
SDK with source zip included rather than a JRE via
Window->Preferences->Java->Installed JREs.

Once you have that set up, you might be interested in the Javadoc view:
Window->Show View->Javadoc.

Hope this helps,
- Jeff

Siegfried Heintze wrote:
> I was looking for the documentation on the constructor arguments for
> StreamReader last night and, while I was pleased the intellisense gave me
> some nice hints, I could not figure out how to hi-lite "StreamReader" and
> get a nice JavaDoc display.
> Thanks,
> Siegfried
>
>
Re: How to read javadoc documentation from Eclipse? [message #113404 is a reply to message #113238] Mon, 31 October 2005 21:50 Go to previous messageGo to next message
Kenneth Evans, Jr. is currently offline Kenneth Evans, Jr.Friend
Messages: 77
Registered: July 2009
Member
I get a quick Javadoc by hovering over the name. Alt+Shift+Q,J makes a
Javadoc view. If the view is already there, clicking on the name makes the
quick Javadoc appear in the view. Shift+F2 gets an external Javadoc, but
you have to configure the location. Hope this helps,

-Ken
Re: How to read javadoc documentation from Eclipse? [message #113824 is a reply to message #113404] Wed, 02 November 2005 04:33 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: siegfried.heintze.com

Ken,
I'm trying to do this for SWT. I right click on
org.eclipse.swt.win32.win32.x86_3.1.1.jar and it gives me a dialog box but
there is no place to specify
http://download.eclipse.org/eclipse/downloads/documentation/ 2.0/html/plugins/org.eclipse.platform.doc.isv/reference/api/ index.html
..
This is kind of a strange UI. There is an Apply button and a "Restore
Defaults" button.

What am I doing wrong?

Siegfried

"Kenneth Evans" <evans@aps.anl.gov> wrote in message
news:dk63jb$jo0$1@news.eclipse.org...
> I get a quick Javadoc by hovering over the name. Alt+Shift+Q,J makes a
> Javadoc view. If the view is already there, clicking on the name makes
the
> quick Javadoc appear in the view. Shift+F2 gets an external Javadoc, but
> you have to configure the location. Hope this helps,
>
> -Ken
>
>
Re: How to read javadoc documentation from Eclipse? [message #113841 is a reply to message #113352] Wed, 02 November 2005 04:43 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: siegfried.heintze.com

Hmmm...

This might be what I was looking for. Is this only true for JREs? It looks
like it. Can you give me some hints as to where I might find a JRE with the
source? Now you said I need a ":JavaSDK with source zip included".Am I
looking for a JRE class file that has both the class files and the html
javadoc files zipped into the same jar file? Where do I get that?

I'm looking at http://java.sun.com/j2se/1.5.0/download.jsp and I see J2SE
Documentation I can download but this is not a JRE or SDK. I also see
"download JDK 5.0 source via JRL/SCSL". Is that what I want? That does not
sound like what you described either.

Thanks,
Siegfried





"Jeff Myers" <jeff.myers@eclipse.org> wrote in message
news:dk544q$69q$1@news.eclipse.org...
> Siegfried,
>
> Source code must be attached for a class for Eclipse to read the javadoc
> for it. You can change your installed Java Runtime to point to a Java
> SDK with source zip included rather than a JRE via
> Window->Preferences->Java->Installed JREs.
>
> Once you have that set up, you might be interested in the Javadoc view:
> Window->Show View->Javadoc.
>
> Hope this helps,
> - Jeff
>
> Siegfried Heintze wrote:
> > I was looking for the documentation on the constructor arguments for
> > StreamReader last night and, while I was pleased the intellisense gave
me
> > some nice hints, I could not figure out how to hi-lite "StreamReader"
and
> > get a nice JavaDoc display.
> > Thanks,
> > Siegfried
> >
> >
Re: How to read javadoc documentation from Eclipse? [message #113959 is a reply to message #113824] Wed, 02 November 2005 16:24 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: bbiggs.ca.ibm.com

Siegfried Heintze wrote:
> Ken,
> I'm trying to do this for SWT. I right click on
> org.eclipse.swt.win32.win32.x86_3.1.1.jar and it gives me a dialog box but
> there is no place to specify
> http://download.eclipse.org/eclipse/downloads/documentation/ 2.0/html/plugins/org.eclipse.platform.doc.isv/reference/api/ index.html
> .
> This is kind of a strange UI. There is an Apply button and a "Restore
> Defaults" button.
>
> What am I doing wrong?

If you get the SWT 3.2M2 download from the SWT homepage:

http://www.eclipse.org/swt/

And add it to your workspace using the "existing projects into
workspace wizard", as described in this little tutorial:

http://www.eclipse.org/swt/eclipse.php

Then the Javadoc assistance will be set up for you. The correct
URL for the SWT 3.1 Javadoc is:

http://help.eclipse.org/help31/nftopic/org.eclipse.platform. doc.isv/reference/api/overview-summary.html

-Billy
Re: How to read javadoc documentation from Eclipse? [message #149068 is a reply to message #113824] Mon, 17 April 2006 21:41 Go to previous message
Eclipse UserFriend
Originally posted by: siegfried.heintze.com

When I right click on a jar file like
org.eclipse.swt.win32.win32.x86_3.1.1.jar when it is inside the package
explorer in 3.1 and select properties it says "Javadoc location can only be
attached to Java projects or archives and class folders in Java projects.
Source folders use the location specified in thre project."

How do I connect the documentation to
org.eclipse.swt.win32.win32.x86_3.1.1.jar?

Thanks,
Siegfried

"Siegfried Heintze" <siegfried@heintze.com> wrote in message
news:dk9fje$jhn$1@news.eclipse.org...
> Ken,
> I'm trying to do this for SWT. I right click on
> org.eclipse.swt.win32.win32.x86_3.1.1.jar and it gives me a dialog box but
> there is no place to specify
>
http://download.eclipse.org/eclipse/downloads/documentation/ 2.0/html/plugins/org.eclipse.platform.doc.isv/reference/api/ index.html
> .
> This is kind of a strange UI. There is an Apply button and a "Restore
> Defaults" button.
>
> What am I doing wrong?
>
> Siegfried
>
> "Kenneth Evans" <evans@aps.anl.gov> wrote in message
> news:dk63jb$jo0$1@news.eclipse.org...
> > I get a quick Javadoc by hovering over the name. Alt+Shift+Q,J makes a
> > Javadoc view. If the view is already there, clicking on the name makes
> the
> > quick Javadoc appear in the view. Shift+F2 gets an external Javadoc,
but
> > you have to configure the location. Hope this helps,
> >
> > -Ken
> >
> >
>
>
Previous Topic:Import
Next Topic:How to append my own plugin
Goto Forum:
  


Current Time: Tue Apr 16 06:43:11 GMT 2024

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

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

Back to the top