Home » Newcomers » Newcomers » Making Java docs for Eclipse Foundation software work offline in Eclipse IDE(Where to download Javadoc from eclipse.org and how to associate)
| Making Java docs for Eclipse Foundation software work offline in Eclipse IDE [message #696656] |
Thu, 14 July 2011 13:58  |
 Mark Ludwig
Messages: 3
Registered: July 2011 |
Junior Member |
|
|
First of all, I am embarrassed that I have to ask about this stuff, because I am a very experienced Java programmer (over 13 years). I work for a company that produces Javadoc for our APIs, distributes it to customers, etc., so I understand how Javadoc works. I'm short of time, so am not acting like Luke (use the source...), and hope there are some simple things I'm missing about Eclipse.
What's new to me is Eclipse and how it finds Javadoc for APIs. (Forgive me, but I'm an Emacs user normally, but have taken over responsibility for something built in Eclipse, so am trying to learn how to do things the "Eclipse way"....) At the moment, I'm looking for some SWT APIs.
This is about hovering over API calls in my Java code, or about highlighting an API and pressing F2 (is that necessary?). What it tells me is that there is neither attached source nor attached Javadoc and hence no Javadoc could be found. The bottom panel where there is a Javadoc tab says the same thing. It knows the API's complete (fully-qualitifed) name (org.eclipse.swt.widget.Display.getClientArea).
I understand that if I had downloaded the SWT source with my Eclipse installation that it would just work. I'd rather not do that, because I don't want to hack the source.
Is there a place where I can download the Javadoc for Eclipse APIs (at least SWT) in another form that the IDE would show? What is that format? I wonder if that other form is just the HTML form I'm familiar with (generated by the javadoc tool), or if there's some other form for Eclipse.
I see another topic here where a newbie asked how to make Javadoc work offline. Hopefully it's obvious from the above description that's what I want to do too. Part of why I want that is because I need to manage the versioning of this stuff (meaning which version of the Eclipse APIs this thing depends on, which means the Javadoc must be the corresponding version).
Thanks in advance!
|
|
|
| Re: Making Java docs for Eclipse Foundation software work offline in Eclipse IDE [message #697868 is a reply to message #696656] |
Mon, 18 July 2011 08:12  |
Dani Megert
Messages: 3802
Registered: July 2009 |
Senior Member |
|
|
On 14.07.2011 15:58, Mark Ludwig wrote:
> First of all, I am embarrassed that I have to ask about this stuff,
> because I am a very experienced Java programmer (over 13 years). I
> work for a company that produces Javadoc for our APIs, distributes it
> to customers, etc., so I understand how Javadoc works. I'm short of
> time, so am not acting like Luke (use the source...), and hope there
> are some simple things I'm missing about Eclipse.
>
> What's new to me is Eclipse and how it finds Javadoc for APIs.
> (Forgive me, but I'm an Emacs user normally, but have taken over
> responsibility for something built in Eclipse, so am trying to learn
> how to do things the "Eclipse way"....) At the moment, I'm looking
> for some SWT APIs.
>
> This is about hovering over API calls in my Java code, or about
> highlighting an API and pressing F2 (is that necessary?). What it
> tells me is that there is neither attached source nor attached Javadoc
> and hence no Javadoc could be found. The bottom panel where there is
> a Javadoc tab says the same thing. It knows the API's complete
> (fully-qualitifed) name (org.eclipse.swt.widget.Display.getClientArea).
>
> I understand that if I had downloaded the SWT source with my Eclipse
> installation that it would just work. I'd rather not do that, because
> I don't want to hack the source.
Why? Even the simple download for SWT already contains the source as
ZIP. You don't have to work with the source - just attach it.
>
> Is there a place where I can download the Javadoc for Eclipse APIs (at
> least SWT) in another form that the IDE would show? What is that
> format? I wonder if that other form is just the HTML form I'm
> familiar with (generated by the javadoc tool), or if there's some
> other form for Eclipse.
Besides source you can also attach Javadoc to a project or JAR. The
format is that of normal Javadoc and can either be on your disk or on
the web. I'm not sure you find a download or website that only has the
SWT Javadoc though. Normally it is shipped/published together with all
other API doc, see e.g.
http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fapi%2Foverview-summary.html
Dani
>
> I see another topic here where a newbie asked how to make Javadoc work
> offline. Hopefully it's obvious from the above description that's
> what I want to do too. Part of why I want that is because I need to
> manage the versioning of this stuff (meaning which version of the
> Eclipse APIs this thing depends on, which means the Javadoc must be
> the corresponding version).
>
> Thanks in advance!
>
|
|
|
| Re: Making Java docs for Eclipse Foundation software work offline in Eclipse IDE [message #697997 is a reply to message #697868] |
Mon, 18 July 2011 15:16 |
Mark Ludwig
Messages: 3
Registered: July 2011 |
Junior Member |
|
|
Dani Megert wrote on Mon, 18 July 2011 04:12
Mark Ludwig wrote on 14.07.2011 15:58
I understand that if I had downloaded the SWT source with my Eclipse
installation that it would just work. I'd rather not do that, because
I don't want to hack the source.
Why? Even the simple download for SWT already contains the source as
ZIP. You don't have to work with the source - just attach it.
Partly this is about me learning about how Eclipse is packaged and structured. I understand that my point of view (preferring not to have the source) is a bit counter-cultural here, because the point of open source is generally to use it. I like that philosophy, and do it when I need or want to, but in this case, I'm picking up maintenance responsibility for this application built with Eclipse, and want to understand how this might look to our customers that do not get the source. I also want to minimize the Eclipse installation as much as possible. If I'm pushing the envelope too much, I can just add the source.
I also don't need to strictly limit this to SWT, if that's not how things are packaged for download. I'll need the rest of the Eclipse APIs eventually anyway, I assume. 
Dani Megert wrote on Mon, 18 July 2011 04:12
Mark Ludwig wrote on 14.07.2011 15:58
Is there a place where I can download the Javadoc for Eclipse APIs (at
least SWT) in another form that the IDE would show? What is that
format? I wonder if that other form is just the HTML form I'm
familiar with (generated by the javadoc tool), or if there's some
other form for Eclipse.
Besides source you can also attach Javadoc to a project or JAR. The
format is that of normal Javadoc and can either be on your disk or on
the web. I'm not sure you find a download or website that only has the
SWT Javadoc though. Normally it is shipped/published together with all
other API doc, see e.g.
<There was a nice link from Dani here that I can't repost because I'm such a newbie>
Dani
This appears to be a viewing (online) reference, and I don't see any way to download from there (arrange for viewing offline). Am I missing something? (I found numerous other pointers like this in my Google searches, which makes me wonder if there's a download feature here that I'm missing. I'm using IE -- is that part of the problem?)
Did you mean that I could point a mirroring tool at this and have it pull it down that way (one file at a time), or is there a .zip or .jar with the Javadoc, or is this Javadoc structure visible to an FTP server that bundles on the fly?
Thanks!
|
|
|
| Re: Making Java docs for Eclipse Foundation software work offline in Eclipse IDE [message #698431 is a reply to message #697997] |
Tue, 19 July 2011 12:57 |
Dani Megert
Messages: 3802
Registered: July 2009 |
Senior Member |
|
|
On 18.07.2011 17:16, Mark Ludwig wrote:
> Dani Megert wrote on Mon, 18 July 2011 04:12
>> Mark Ludwig wrote on 14.07.2011 15:58
>> > I understand that if I had downloaded the SWT source with my
>> Eclipse > installation that it would just work. I'd rather not do
>> that, because > I don't want to hack the source.
>>
>> Why? Even the simple download for SWT already contains the source as
>> ZIP. You don't have to work with the source - just attach it.
>
> Partly this is about me learning about how Eclipse is packaged and
> structured. I understand that my point of view (preferring not to
> have the source) is a bit counter-cultural here, because the point of
> open source is generally to use it. I like that philosophy, and do it
> when I need or want to, but in this case, I'm picking up maintenance
> responsibility for this application built with Eclipse, and want to
> understand how this might look to our customers that do not get the
> source. I also want to minimize the Eclipse installation as much as
> possible. If I'm pushing the envelope too much, I can just add the
> source.
As I tried to explain, this is not needed. You can either add source or
Javadoc or both.
>
> I also don't need to strictly limit this to SWT, if that's not how
> things are packaged for download. I'll need the rest of the Eclipse
> APIs eventually anyway, I assume. :d
>
> Dani Megert wrote on Mon, 18 July 2011 04:12
>> Mark Ludwig wrote on 14.07.2011 15:58
>> > Is there a place where I can download the Javadoc for Eclipse APIs
>> (at > least SWT) in another form that the IDE would show? What is
>> that > format? I wonder if that other form is just the HTML form I'm
>> > familiar with (generated by the javadoc tool), or if there's some >
>> other form for Eclipse.
>>
>> Besides source you can also attach Javadoc to a project or JAR. The
>> format is that of normal Javadoc and can either be on your disk or on
>> the web. I'm not sure you find a download or website that only has
>> the SWT Javadoc though. Normally it is shipped/published together
>> with all other API doc, see e.g.
>> <There was a nice link from Dani here that I can't repost because I'm
>> such a newbie>
>>
>> Dani
>
> This appears to be a viewing (online) reference, and I don't see any
> way to download from there (arrange for viewing offline). Am I
> missing something? (I found numerous other pointers like this in my
> Google searches, which makes me wonder if there's a download feature
> here that I'm missing. I'm using IE -- is that part of the problem?)
>
> Did you mean that I could point a mirroring tool at this and have it
> pull it down that way (one file at a time), or is there a .zip or .jar
> with the Javadoc, or is this Javadoc structure visible to an FTP
> server that bundles on the fly?
No, simply download the Platform or Eclipse SDK
(http://download.eclipse.org/eclipse/downloads/drops/R-3.7-201106131736/index.php).
This contains documentation including the Javadoc (it's inside
<install>/plugins/org.eclipse.platform.doc.isv_3.7.0.v20110602-0800.jar).
Dani
>
> Thanks!
>
|
|
|
Goto Forum:
Current Time: Fri Sep 20 10:04:17 GMT 2024
Powered by FUDForum. Page generated in 0.06902 seconds |
] 
Search
Help
Register
Login
Home
