Re: Location of API docs
  Home FAQ Contact Sign in
linux.debian.maint.java only
 
Advanced search
POPULAR GROUPS

more...

 Up
Re: Location of API docs         

Group: linux.debian.maint.java · Group Profile
Author: Michael Koch
Date: Jan 13, 2007 16:30

On Sat, Jan 13, 2007 at 11:54:14PM +0000, Paul Cager wrote:
> Michael Koch wrote:
>> On Sat, Jan 13, 2007 at 09:19:31PM +0000, Paul Cager wrote:
>>> Marcus Better wrote:
>>>> Matthias Klose wrote:
>>>>> Assuming that the doc is installed in /usr/share/doc/libfoo-java/api,
>>>>> a reference to a class Bar should point to ../../libbar-java/api. Not
>>>>> yet sure how to find the location for this reference
>>>> I seem to remember that javadoc can be given a command line parameter giving
>>>> the location of the javadocs for a certain Java package?
>>> You can use the "-link" option to do this. It works very well with Sun's
>>> Javadoc, but I have not tried it with gjdoc. I can't remember the
>>> details, but it's integrated with ant's javadoc target.
>>>
>>> Thanks for the reminder - I'll put this in for the BCEL and checkstyle
>>> packages.
>>
>> For Debian packages we need -linkoffline to link to the locally
>> installed javadocs of dependant packages.
>>
>> I havent tried yet if one or both of these options work in gjdoc or not.
>>
>>
>> Michael
>
> It's probably worth pointing out that "-linkoffline" still generates
> links to the *remote* site; it just uses the local documents during the
> generation of your javadocs. I use it at work, for example, where the
> internet is hidden behind a slow-ish proxy.
>
> I think either "link" or "linkoffline" would work, although linkoffline
> would require the linked-to packages to be build dependencies.
>
> In either case we would have to use a "file://" URL link to our
> /usr/share/doc/*/api directories (should work, but I haven't tried it yet).
>
> Another question: Where th package uses a standard API (e.g.
> java.util.Map), should I link to
> http://java.sun.com/j2se/1.5.0/docs/api/ or what?

No, please depend on classpath-doc and use these. We dont wanna link to
resources on the net. The idea is to have all on your hard disk when you
install the *-doc packages.

Michael
--
.''`. | Michael Koch
: :' : | Free Java Developer <http://www.classpath.org>
`. `' |
`- | 1024D/BAC5 4B28 D436 95E6 F2E0 BD11 5923 A008 2763 483B

--
To UNSUBSCRIBE, email to debian-java-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
2 Comments
diggit! del.icio.us! reddit!

RELATED THREADS
SubjectArticles qty Group
The only (very likely) solution to energy needs (was Re: Location, Location, Location!)sci.space.policy ·