Eclipse Community Forums: Standard Widget Toolkit (SWT)

Home » Eclipse Projects » Standard Widget Toolkit (SWT) » SWT Javadoc

Sun, 15 July 2012 08:13

Eclipse User

Where can I download the SWT Javadoc?

I installed Window Builder (which I think installed SWT), but there was
no Javadoc included.

I know there is an online Javadoc, but my development machine is not
connected, so I actually need a file.

Thanks

--
Wojtek :-)

Re: SWT Javadoc [message #895813 is a reply to message #895728]

Mon, 16 July 2012 03:37

Eclipse User

Wojtek wrote :
> Where can I download the SWT Javadoc?
>
> I installed Window Builder (which I think installed SWT), but there was no
> Javadoc included.
>
> I know there is an online Javadoc, but my development machine is not
> connected, so I actually need a file.
>

I managed to find a ZIP which contained a src.zip file. Eclipse accepts
this as valid to show pop-up Javadocs.

BTW, is there any reason this is such a painful process? Google
searches show that people have been looking for SWT Javadoc for at
least 5 years. It should be trivial for the SWT caretakers to generate
a downloadable Javadoc file and make it available on the download page,
or the documentation page.

$0.02 worth

--
Wojtek :-)

Re: SWT Javadoc [message #896177 is a reply to message #895813]

Tue, 17 July 2012 09:53

Eclipse User

There is associated javadoc with all eclipse distributions, under Help -> Help Contents. Other than that, there is no standalone javadoc that Eclipse provides. If this is something you are interested in, all you would need to do is download the source from git [1] and generate the javadoc yourself.

JD

[1] http://git.eclipse.org/c/platform/eclipse.platform.swt.git/

Re: SWT Javadoc [message #896605 is a reply to message #896177]

Thu, 19 July 2012 02:45

Eclipse User

you can find swt javadoc at
http://help.eclipse.org/

Re: SWT Javadoc [message #897008 is a reply to message #896177]

Fri, 20 July 2012 14:41

Eclipse User

Joseph Carroll wrote :
> If this is something you are interested in, all you would need to do is
> download the source from git [1] and generate the javadoc yourself.

Which illustrates my question, "all YOU need to do".

Please understand that I am NOT trying to be snarky or trying to pick a
fight.

I am simply trying to understand why the Javadocs are not available as
a downloadable file. They obviously exist as I can view them online.
Which means that they were generated into a series of files which then
had to be uploaded to the help web site. For someone to then archive
that series of files and add it to the download section should be a
simple matter.

And then people could get access to it, especially for use in the
Eclipse Javadoc popup.

And therefore I was wondering if this was a matter of policy, as the
technical aspects are trivial.

--
Wojtek :-)

Re: SWT Javadoc [message #897019 is a reply to message #897008]

Fri, 20 July 2012 15:16

Eclipse User

They are available in the Platform Plug-in Developers Guide which is available in the Help->Help Contents. They are also available indirectly as source from the swt plugins. You should get these automatically if you install the Eclipse Platform SDK.

Re: SWT Javadoc [message #897042 is a reply to message #897019]

Fri, 20 July 2012 19:01

Eclipse User

David Wegener wrote :
> They are available in the Platform Plug-in Developers Guide which is
> available in the Help->Help Contents. They are also available indirectly as
> source from the swt plugins. You should get these automatically if you
> install the Eclipse Platform SDK.

Yes they are in the Eclipse Help. However there is no place I can point
the swt.jar/ properties/ java doc location to. Without this path
Eclipse does not popup Javadoc when you hover over a class/method. I
know I could use a URL, but my development machine is on a private LAN
not connected to the Internet.

My installation of Eclipse + Window Builder only had the Windows jar
file.

I did eventually learn that I could use the source, but then my
installation did not include that source. After rooting around the
Eclipse site I located an SWT jar which did include the source, I
downloaded it, pointed Eclipse at it, and now I have popup Javadoc.

It is not that I could not eventually solve this. It is that I spent
too much time searching the Web, reading other people's posts in
various forums, finding a solution, then searching the Eclipse sites.

Call me lazy, but could not a download link to the SWT Javadoc be
placed on the http://www.eclipse.org/swt/javadoc.php page?

--
Wojtek :-)

Re: SWT Javadoc [message #897045 is a reply to message #897042]

Fri, 20 July 2012 19:54

Eclipse User

On 07/20/2012 06:01 PM, Wojtek wrote:
> David Wegener wrote :
>> They are available in the Platform Plug-in Developers Guide which is
>> available in the Help->Help Contents. They are also available
>> indirectly as source from the swt plugins. You should get these
>> automatically if you install the Eclipse Platform SDK.
>
> Yes they are in the Eclipse Help. However there is no place I can point
> the swt.jar/ properties/ java doc location to. Without this path Eclipse
> does not popup Javadoc when you hover over a class/method. I know I
> could use a URL, but my development machine is on a private LAN not
> connected to the Internet.
>
> My installation of Eclipse + Window Builder only had the Windows jar file.
>
> I did eventually learn that I could use the source, but then my
> installation did not include that source. After rooting around the
> Eclipse site I located an SWT jar which did include the source, I
> downloaded it, pointed Eclipse at it, and now I have popup Javadoc.
>
> It is not that I could not eventually solve this. It is that I spent too
> much time searching the Web, reading other people's posts in various
> forums, finding a solution, then searching the Eclipse sites.
>
> Call me lazy, but could not a download link to the SWT Javadoc be placed
> on the http://www.eclipse.org/swt/javadoc.php page?
>
If you install the Eclipse Platform SDK, it will automatically associate
the source with the SWT classes so the hover will be populated. The SDK
includes the source plugin.

Re: SWT Javadoc [message #897048 is a reply to message #897045]

Sat, 21 July 2012 00:40

Eclipse User

David Wegener wrote :
> On 07/20/2012 06:01 PM, Wojtek wrote:
>> David Wegener wrote :
>>> They are available in the Platform Plug-in Developers Guide which is
>>> available in the Help->Help Contents. They are also available
>>> indirectly as source from the swt plugins. You should get these
>>> automatically if you install the Eclipse Platform SDK.
>>
>> Yes they are in the Eclipse Help. However there is no place I can point
>> the swt.jar/ properties/ java doc location to. Without this path Eclipse
>> does not popup Javadoc when you hover over a class/method. I know I
>> could use a URL, but my development machine is on a private LAN not
>> connected to the Internet.
>>
>> My installation of Eclipse + Window Builder only had the Windows jar file.
>>
>> I did eventually learn that I could use the source, but then my
>> installation did not include that source. After rooting around the
>> Eclipse site I located an SWT jar which did include the source, I
>> downloaded it, pointed Eclipse at it, and now I have popup Javadoc.
>>
>> It is not that I could not eventually solve this. It is that I spent too
>> much time searching the Web, reading other people's posts in various
>> forums, finding a solution, then searching the Eclipse sites.
>>
>> Call me lazy, but could not a download link to the SWT Javadoc be placed
>> on the http://www.eclipse.org/swt/javadoc.php page?
>>
> If you install the Eclipse Platform SDK, it will automatically associate the
> source with the SWT classes so the hover will be populated. The SDK includes
> the source plugin.

Hmm, I downloaded "Eclipse IDE for Java Developers"

Because according to this page
http://www.eclipse.org/downloads/compare.php that package had what I
needed.

--
Wojtek :-)

Re: SWT Javadoc [message #1039224 is a reply to message #897048]

Thu, 11 April 2013 19:20

Eclipse User

Yeah. Wojtek is right. Getting this offline SWT javadoc to work is real PITA. I also don't know what is it with all secrecy around offline JAR or ZIP. Why it can't be made easy downloadable from main online javadoc page?
I don't know exact steps that Wojtek did, but here are mine (since I couldn't find them alltogether anywhere):
- download source for SWT from 'http://www.eclipse.org/swt/' (search for links near title "Releases")
(next few steps are taken from page on stackoverflow - looks like I'm not allowed to paste it since i'm new on this forum)
- Go to eclipse and load downloaded swt as existing project
- you'll find src.zip in that project
- unzip src.zip and copy the folder "org" (org\eclipse\swt...)
- paste that folder in src (inside the project)
- select org folder in eclipse then go to project >> generate javadocs
- If you're in windows you probably going to press on (Configure) to pick up the Javadoc.exe file it's in the C:\programFiles\java\jdk-xyz\bin\
- choose where you want to drop the doc files, next then finish
- go to the files and zip it (zip the files don't zip the folder which contains the files cause when you load the docs as archive and validate it won't see the index.html)
- right click on your project and choose 'properties'
- under 'java build path' go to 'libraries'
- here choose 'org.eclipse.swt.win32.win32.x86_3.100.1.v4236b.jar' and expand it with '+' key (or click on arrow on the left)
- doubleclick on 'javadoc location'
- choose 'javadoc in archive' and 'external file'
- under 'archive path' put into whole path to previously created javadoc ZIP file

FINALLY you have it!

Previous Topic:	SWT.VIRTUAL and Lists
Next Topic:	Horizontal scroll bar for table widget

Goto Forum:

-=] Back to Top [=-

Current Time: Thu Jul 24 15:14:29 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter