Eclipse Community Forums: Eclipse Platform » Generating links to Java API in my JavaDocs

Home » Eclipse Projects » Eclipse Platform » Generating links to Java API in my JavaDocs

Generating links to Java API in my JavaDocs [message #287062]

Thu, 23 June 2005 12:00

Eclipse User

Originally posted by: bradley.wagner.hannonhill.com

Hi, I am trying to generate JavaDocs for my project. I have setup the rt.jar file to use:
http://java.sun.com/j2se/1.4.2/docs/api/ as the location for Java's API. However, when I generate my
own docs no links are created to types like java.lang.String. Instead, it's just the plain text
'java.lang.String'. I was looking at the documentation for Apache's Cocoon project which definitely
has links to the Java API. Take a look:

http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/Cocoo n.html#getSystemProperty(java.lang.String,
java.lang.String)

Any thoughts?

Bradley

Re: Generating links to Java API in my JavaDocs [message #287066 is a reply to message #287062]

Thu, 23 June 2005 13:04

Eclipse User

Originally posted by: chaves-do-not-spam.inf.ufsc.br

Use the -link command line option for javadoc (the Javadoc wizard allows
you to to that). For instance:

-link http://java.sun.com/j2se/1.4.2/docs/api

More info:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc .html#link

Bradley Wagner wrote:

> Hi, I am trying to generate JavaDocs for my project. I have setup the rt.jar
file to use:
> http://java.sun.com/j2se/1.4.2/docs/api/ as the location for Java's API.
However, when I generate my
> own docs no links are created to types like java.lang.String. Instead,
it's just the plain text
> 'java.lang.String'. I was looking at the documentation for Apache's Cocoon
project which definitely
> has links to the Java API. Take a look:

>
http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/Cocoo n.html#getSystemProperty(java.lang.String,
> java.lang.String)

> Any thoughts?

> Bradley

Re: Generating links to Java API in my JavaDocs [message #287074 is a reply to message #287066]

Thu, 23 June 2005 14:25

Eclipse User

Originally posted by: bradley.wagner.hannonhill.com

Thanks,
Is there any way to automate this for ALL the jar files in my project? These jars all have links to
their JavaDocs setup.

Bradley

Rafael Chaves wrote:
> Use the -link command line option for javadoc (the Javadoc wizard allows
> you to to that). For instance:
>
> -link http://java.sun.com/j2se/1.4.2/docs/api
>
> More info:
>
> http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc .html#link
>

Previous Topic:	ICharacterScanner.unread() should return an error if I unread to many times
Next Topic:	What's wrong with my eclipse in FC4Linux

Goto Forum:

-=] Back to Top [=-

Current Time: Wed Jul 16 17:18:28 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter