Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Newcomers » Newcomers » Can I attach javadoc that's online to a jar?
Can I attach javadoc that's online to a jar? [message #249125] Sun, 17 February 2008 20:51 Go to next message
Eclipse UserFriend
Originally posted by: dennis.research.bell-labs.com

Hi,

I'm creating a jar to be shipped somewhere soon, but I don't want to
attach the javadoc that I currently have, since I'm planning to improve it.

Can I somehow attach a [reference to online javadoc (say,
http://look.here.for.javadoc)] to the jar, and then make sure that the
latest and greatest version of the documentation is always available on
http://look.here.for.javadoc ?

thanks,
--Dennis.

Report message to a moderator

Re: Can I attach javadoc that's online to a jar? [message #249145 is a reply to message #249125] Mon, 18 February 2008 08:20 Go to previous messageGo to next message
Krzysztof Daniel is currently offline Krzysztof DanielFriend
Messages: 42
Registered: July 2009
Member
Dennis,

I am afraid you can't do it. Jar manifest file does not allow for that
(you can read more about manifest here:
http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html).

Actually one thing you can do is just to release README or FAQ file, and
allow user to configure his IDE to use particular documentation.

Regards,
Chris

Report message to a moderator

Re: Can I attach javadoc that's online to a jar? [message #249199 is a reply to message #249145] Mon, 18 February 2008 16:26 Go to previous messageGo to next message
Mark Dexter is currently offline Mark DexterFriend
Messages: 324
Registered: July 2009
Senior Member
Christopher Daniel wrote:
> Dennis,
>
> I am afraid you can't do it. Jar manifest file does not allow for that
> (you can read more about manifest here:
> http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html).
>
> Actually one thing you can do is just to release README or FAQ file, and
> allow user to configure his IDE to use particular documentation.
>
> Regards,
> Chris
Hi Christopher. I'm curious about this. When you use JUnit inside
Eclipse, it seems automatically to set the Javadoc location (e.g.,
www.junit.org/junit/javadoc/4.3) for the junit.jar file. Do you know how
this is done? Thanks. Mark

Report message to a moderator

Re: Can I attach javadoc that's online to a jar? [message #249206 is a reply to message #249199] Mon, 18 February 2008 16:36 Go to previous messageGo to next message
Krzysztof Daniel is currently offline Krzysztof DanielFriend
Messages: 42
Registered: July 2009
Member
Mark Dexter pisze:

> Hi Christopher. I'm curious about this. When you use JUnit inside
> Eclipse, it seems automatically to set the Javadoc location (e.g.,
> www.junit.org/junit/javadoc/4.3) for the junit.jar file. Do you know how
> this is done? Thanks. Mark

I do not know why is that working ;-). I have checked junit.jar and
there is nothing about javadoc location. I would rather assume that
eclipse recognizes junit (but if you want to be sure search bugzilla for
particular RFE or ask someone more informed than me).

Regards,
Chris

Report message to a moderator

Re: Can I attach javadoc that's online to a jar? [message #249210 is a reply to message #249145] Mon, 18 February 2008 17:00 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: dennis.research.bell-labs.com

Thanks, Chris.

> Actually one thing you can do is just to release README or FAQ file, and
allow > user to configure his IDE to use particular documentation.

Could you briefly say how to do this?

--dennis.

Report message to a moderator

Re: Can I attach javadoc that's online to a jar? [message #249225 is a reply to message #249210] Mon, 18 February 2008 18:18 Go to previous messageGo to next message
Mark Dexter is currently offline Mark DexterFriend
Messages: 324
Registered: July 2009
Senior Member
Dennis Dams wrote:
> Thanks, Chris.
>
>> Actually one thing you can do is just to release README or FAQ file, and
> allow > user to configure his IDE to use particular documentation.
>
> Could you briefly say how to do this?
>
> --dennis.
>
When you attach a JAR to your project's build path, you can add a source
attachment and a Javadoc location. Go to Project / Properties, select
the Libraries tab. You add a JAR file using Add External JARs. Then, if
you expand, there is a place for Javadoc location. Here you can
reference a URL or an archive. HTH. Mark

Report message to a moderator

Re: Can I attach javadoc that's online to a jar? [message #249236 is a reply to message #249225] Mon, 18 February 2008 21:28 Go to previous message
Eclipse UserFriend
Originally posted by: dennis.research.bell-labs.com

Thanks, Mark!
--dennis.


Mark Dexter wrote:

> Dennis Dams wrote:
>> Thanks, Chris.
>>
>>> Actually one thing you can do is just to release README or FAQ file, and
>> allow > user to configure his IDE to use particular documentation.
>>
>> Could you briefly say how to do this?
>>
>> --dennis.
>>
> When you attach a JAR to your project's build path, you can add a source
> attachment and a Javadoc location. Go to Project / Properties, select
> the Libraries tab. You add a JAR file using Add External JARs. Then, if
> you expand, there is a place for Javadoc location. Here you can
> reference a URL or an archive. HTH. Mark

Report message to a moderator

Previous Topic:CDT/gdb unknown target exception 0xc0000135 at 0x7c964ed1
Next Topic:Exporting libraries to jar file?
Goto Forum:
  

[ Syndicate this forum (XML) ] [ RSS ]

Current Time: Wed Jan 15 12:07:11 GMT 2025

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

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

Back to the top

Sign up to our Newsletter

A fresh new issue delivered monthly