Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Eclipse Website » JavaDocs
JavaDocs [message #1992] Tue, 26 April 2005 11:53 Go to next message
Eclipse Webmaster is currently offline Eclipse Webmaster
Messages: 444175
Registered: July 2009
Senior Member
Here is an e-mail I got in my inbox re: looking for JavaDocs.

It takes a lot of time to figure out where the javadocs are located on
the eclipse.org site. Would be useful for many users/developers who
visit the site to locate the javadocs, if you could do provision for
downloading javadocs seperately OR providing link on the homepage to
javadocs.


I'll assume this person meant the Platform javadocs, but I'll also
assume that lots of projects produce javadocs as well. Or maybe they
don't. I do know that JavaDocs are a great resource for develoipers and
it would be interesting to have a repository that would list all the
JavaDoc locations at Eclipse.

Here is a link to 1.0 JavaDoc:

http://www.eclipse.org/documentation/html/plugins/org.eclips e.platform.doc.isv/doc/reference/api/overview-summary.html

I haven't found 2.x or 3.x versions.

Denis
Re: JavaDocs [message #3343 is a reply to message #1992] Thu, 05 May 2005 15:39 Go to previous messageGo to next message
Eclipse User
Originally posted by: john.eclipsefaq.org

Eclipse WebMaster (Denis Roy) wrote:
> Here is a link to 1.0 JavaDoc:
>
> http://www.eclipse.org/documentation/html/plugins/org.eclips e.platform.doc.isv/doc/reference/api/overview-summary.html
>
>
> I haven't found 2.x or 3.x versions.

It's not a good sign when the web master can't find things on the site :)

Here is a link to a page that links the javadoc for all platform releases:

http://www.eclipse.org/documentation/main.html

Or, to go directly to javadoc for a 2.x or 3.x release:

http://help.eclipse.org/help20
http://help.eclipse.org/help21
http://help.eclipse.org/help30/

Gathering this doc for all projects in one place is probably a good idea.
--
Re: JavaDocs [message #3443 is a reply to message #3343] Thu, 05 May 2005 22:18 Go to previous messageGo to next message
Eclipse User
Originally posted by: bob.objfac.com

> Gathering this doc for all projects in one place is probably a good idea.

Oh yeah. Where is the javadoc? is a bit of a FAQ. It wouldn't hurt to
point out that the javadoc for the current version is in SDK Help, too.

Bob

John Arthorne wrote:
> Eclipse WebMaster (Denis Roy) wrote:
>
>> Here is a link to 1.0 JavaDoc:
>>
>> http://www.eclipse.org/documentation/html/plugins/org.eclips e.platform.doc.isv/doc/reference/api/overview-summary.html
>>
>>
>> I haven't found 2.x or 3.x versions.
>
>
> It's not a good sign when the web master can't find things on the site :)
>
> Here is a link to a page that links the javadoc for all platform releases:
>
> http://www.eclipse.org/documentation/main.html
>
> Or, to go directly to javadoc for a 2.x or 3.x release:
>
> http://help.eclipse.org/help20
> http://help.eclipse.org/help21
> http://help.eclipse.org/help30/
>
> Gathering this doc for all projects in one place is probably a good idea.
> --
Re: JavaDocs [message #4395 is a reply to message #3343] Fri, 06 May 2005 14:03 Go to previous messageGo to next message
Eclipse Webmaster is currently offline Eclipse Webmaster
Messages: 444175
Registered: July 2009
Senior Member
John Arthorne wrote:
>
> It's not a good sign when the web master can't find things on the site :)

Actually, when I was using Eclipse as a developer before joining the
Foundation, my number 1 complaint was the difficulty of downloading
"Eclipse" (I knew nothing of the other projects, I just wanted the IDE)
and using a mirror site. That's why it was one of the first things I
"enhanced".

> Or, to go directly to javadoc for a 2.x or 3.x release:
>
> http://help.eclipse.org/help20
> http://help.eclipse.org/help21
> http://help.eclipse.org/help30/

I don't believe these are actual Javadoc. Aren't Javadocs generated
html pages that document methods, attributes and comments in the actual
Java code?

http://java.sun.com/j2se/javadoc/

I'm not sure if Eclipse.org actually generates Javadoc, I'm just
thinking that it would be a good resource for developers and contributors.

D.

--

Eclipse WebMaster - webmaster@eclipse.org
Questions? Consult the FAQ at http://www.eclipse.org/webmaster/faq.html
View my status at http://www.eclipse.org/webmaster/main.html
Re: JavaDocs [message #4464 is a reply to message #4395] Fri, 06 May 2005 15:23 Go to previous messageGo to next message
Eclipse User
Originally posted by: newsgroups.ryanlowe.ca

>> http://help.eclipse.org/help20
>> http://help.eclipse.org/help21
>> http://help.eclipse.org/help30/
>
>
> I don't believe these are actual Javadoc. Aren't Javadocs generated
> html pages that document methods, attributes and comments in the actual
> Java code?

The Eclipse JavaDocs are integrated into Eclipse help. When Eclipse
help refers to a specific class, it's usually a link to the JavaDoc for
that class.

If I could make a request: be able to access the Eclipse JavaDocs
*without* having to go through general Eclipse help first. This is a
pain when I just need to quickly look up a class' API. Yes, I know I
can do this in Eclipse itself as well ... I just prefer the web interface.

On Sun's website you can use the sitewide search to find any class in
the Java JavaDocs. The matching class names are always the first result
displayed. It would be nice if I could just do a search for TableViewer
on the Eclipse website and the first search result is the TableViewer
JavaDoc, just like Sun's site.

Ryan Lowe
Re: JavaDocs [message #5693 is a reply to message #4395] Wed, 11 May 2005 12:10 Go to previous messageGo to next message
Eclipse User
Originally posted by: john.eclipsefaq.org

Eclipse WebMaster (Denis Roy) wrote:
>>
>> http://help.eclipse.org/help20
>> http://help.eclipse.org/help21
>> http://help.eclipse.org/help30/
>
>
> I don't believe these are actual Javadoc. Aren't Javadocs generated
> html pages that document methods, attributes and comments in the actual
> Java code?

I didn't explain in enough detail. From one of the above links, go to
Platform Plugin Developer Guide > Reference > API Reference. This takes
you to the generated javadoc pages. I fully agree with everyone that
the javadoc is buried and could be made more prominent, but it is there.
--
Re: JavaDocs [message #5711 is a reply to message #5693] Wed, 11 May 2005 23:27 Go to previous message
Eclipse Webmaster is currently offline Eclipse Webmaster
Messages: 444175
Registered: July 2009
Senior Member
Thanks, John. Now that we know where it is we can post more prominent
links to it.

Denis

John Arthorne wrote:
> Eclipse WebMaster (Denis Roy) wrote:
>
>>>
>>> http://help.eclipse.org/help20
>>> http://help.eclipse.org/help21
>>> http://help.eclipse.org/help30/
>>
>>
>>
>> I don't believe these are actual Javadoc. Aren't Javadocs generated
>> html pages that document methods, attributes and comments in the
>> actual Java code?
>
>
> I didn't explain in enough detail. From one of the above links, go to
> Platform Plugin Developer Guide > Reference > API Reference. This takes
> you to the generated javadoc pages. I fully agree with everyone that
> the javadoc is buried and could be made more prominent, but it is there.
> --
Re: JavaDocs [message #562084 is a reply to message #1992] Thu, 05 May 2005 15:39 Go to previous message
John Arthorne is currently offline John Arthorne
Messages: 174
Registered: July 2009
Senior Member
Eclipse WebMaster (Denis Roy) wrote:
> Here is a link to 1.0 JavaDoc:
>
> http://www.eclipse.org/documentation/html/plugins/org.eclips e.platform.doc.isv/doc/reference/api/overview-summary.html
>
>
> I haven't found 2.x or 3.x versions.

It's not a good sign when the web master can't find things on the site :)

Here is a link to a page that links the javadoc for all platform releases:

http://www.eclipse.org/documentation/main.html

Or, to go directly to javadoc for a 2.x or 3.x release:

http://help.eclipse.org/help20
http://help.eclipse.org/help21
http://help.eclipse.org/help30/

Gathering this doc for all projects in one place is probably a good idea.
--
Re: JavaDocs [message #562153 is a reply to message #3343] Thu, 05 May 2005 22:18 Go to previous message
Eclipse User
Originally posted by: bob.objfac.com

> Gathering this doc for all projects in one place is probably a good idea.

Oh yeah. Where is the javadoc? is a bit of a FAQ. It wouldn't hurt to
point out that the javadoc for the current version is in SDK Help, too.

Bob

John Arthorne wrote:
> Eclipse WebMaster (Denis Roy) wrote:
>
>> Here is a link to 1.0 JavaDoc:
>>
>> http://www.eclipse.org/documentation/html/plugins/org.eclips e.platform.doc.isv/doc/reference/api/overview-summary.html
>>
>>
>> I haven't found 2.x or 3.x versions.
>
>
> It's not a good sign when the web master can't find things on the site :)
>
> Here is a link to a page that links the javadoc for all platform releases:
>
> http://www.eclipse.org/documentation/main.html
>
> Or, to go directly to javadoc for a 2.x or 3.x release:
>
> http://help.eclipse.org/help20
> http://help.eclipse.org/help21
> http://help.eclipse.org/help30/
>
> Gathering this doc for all projects in one place is probably a good idea.
> --
Re: JavaDocs [message #562516 is a reply to message #3343] Fri, 06 May 2005 14:03 Go to previous message
Eclipse Webmaster is currently offline Eclipse Webmaster
Messages: 444175
Registered: July 2009
Senior Member
John Arthorne wrote:
>
> It's not a good sign when the web master can't find things on the site :)

Actually, when I was using Eclipse as a developer before joining the
Foundation, my number 1 complaint was the difficulty of downloading
"Eclipse" (I knew nothing of the other projects, I just wanted the IDE)
and using a mirror site. That's why it was one of the first things I
"enhanced".

> Or, to go directly to javadoc for a 2.x or 3.x release:
>
> http://help.eclipse.org/help20
> http://help.eclipse.org/help21
> http://help.eclipse.org/help30/

I don't believe these are actual Javadoc. Aren't Javadocs generated
html pages that document methods, attributes and comments in the actual
Java code?

http://java.sun.com/j2se/javadoc/

I'm not sure if Eclipse.org actually generates Javadoc, I'm just
thinking that it would be a good resource for developers and contributors.

D.

--

Eclipse WebMaster - webmaster@eclipse.org
Questions? Consult the FAQ at http://www.eclipse.org/webmaster/faq.html
View my status at http://www.eclipse.org/webmaster/main.html
Re: JavaDocs [message #562542 is a reply to message #4395] Fri, 06 May 2005 15:23 Go to previous message
Ryan Lowe is currently offline Ryan Lowe
Messages: 13
Registered: July 2009
Junior Member
>> http://help.eclipse.org/help20
>> http://help.eclipse.org/help21
>> http://help.eclipse.org/help30/
>
>
> I don't believe these are actual Javadoc. Aren't Javadocs generated
> html pages that document methods, attributes and comments in the actual
> Java code?

The Eclipse JavaDocs are integrated into Eclipse help. When Eclipse
help refers to a specific class, it's usually a link to the JavaDoc for
that class.

If I could make a request: be able to access the Eclipse JavaDocs
*without* having to go through general Eclipse help first. This is a
pain when I just need to quickly look up a class' API. Yes, I know I
can do this in Eclipse itself as well ... I just prefer the web interface.

On Sun's website you can use the sitewide search to find any class in
the Java JavaDocs. The matching class names are always the first result
displayed. It would be nice if I could just do a search for TableViewer
on the Eclipse website and the first search result is the TableViewer
JavaDoc, just like Sun's site.

Ryan Lowe
Re: JavaDocs [message #562945 is a reply to message #4395] Wed, 11 May 2005 12:10 Go to previous message
John Arthorne is currently offline John Arthorne
Messages: 174
Registered: July 2009
Senior Member
Eclipse WebMaster (Denis Roy) wrote:
>>
>> http://help.eclipse.org/help20
>> http://help.eclipse.org/help21
>> http://help.eclipse.org/help30/
>
>
> I don't believe these are actual Javadoc. Aren't Javadocs generated
> html pages that document methods, attributes and comments in the actual
> Java code?

I didn't explain in enough detail. From one of the above links, go to
Platform Plugin Developer Guide > Reference > API Reference. This takes
you to the generated javadoc pages. I fully agree with everyone that
the javadoc is buried and could be made more prominent, but it is there.
--
Re: JavaDocs [message #562966 is a reply to message #5693] Wed, 11 May 2005 23:27 Go to previous message
Eclipse Webmaster is currently offline Eclipse Webmaster
Messages: 444175
Registered: July 2009
Senior Member
Thanks, John. Now that we know where it is we can post more prominent
links to it.

Denis

John Arthorne wrote:
> Eclipse WebMaster (Denis Roy) wrote:
>
>>>
>>> http://help.eclipse.org/help20
>>> http://help.eclipse.org/help21
>>> http://help.eclipse.org/help30/
>>
>>
>>
>> I don't believe these are actual Javadoc. Aren't Javadocs generated
>> html pages that document methods, attributes and comments in the
>> actual Java code?
>
>
> I didn't explain in enough detail. From one of the above links, go to
> Platform Plugin Developer Guide > Reference > API Reference. This takes
> you to the generated javadoc pages. I fully agree with everyone that
> the javadoc is buried and could be made more prominent, but it is there.
> --
Previous Topic:New Homepage Comments
Next Topic:Interesting perpective from a ... frustrated ... newbie.
Goto Forum:
  


Current Time: Thu Aug 21 08:25:04 EDT 2014

Powered by FUDForum. Page generated in 0.02571 seconds