Re: Location of API docs

2007-01-16 Thread Paul Cager
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

Re: Location of API docs

2007-01-14 Thread Eric Lavarde - Debian
Hi, Mark Wielaard said: >> > 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. >> > >> For Debian packages we need -linkoffline to link to t

Re: Location of API docs

2007-01-13 Thread Matthew Johnson
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 insta

Re: Location of API docs

2007-01-13 Thread Michael Koch
On Sun, Jan 14, 2007 at 12:31:11AM +, Matthew Johnson wrote: > > >>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

Re: Location of API docs

2007-01-13 Thread Michael Koch
On Sat, Jan 13, 2007 at 11:54:14PM +, Paul Cager wrote: > Michael Koch wrote: > > On Sat, Jan 13, 2007 at 09:19:31PM +, 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

Re: Location of API docs

2007-01-13 Thread Paul Cager
Michael Koch wrote: > On Sat, Jan 13, 2007 at 09:19:31PM +, 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

Re: Location of API docs

2007-01-13 Thread Mark Wielaard
On Sun, 2007-01-14 at 01:12 +0100, Michael Koch wrote: > On Sat, Jan 13, 2007 at 09:19:31PM +, 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 ..

Re: Location of API docs

2007-01-13 Thread Michael Koch
On Sat, Jan 13, 2007 at 09:19:31PM +, 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 f

Re: Location of API docs

2007-01-13 Thread Paul Cager
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

Re: Location of API docs

2007-01-13 Thread Marcus Better
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

Re: Location of API docs

2007-01-12 Thread Matthias Klose
Mark Wielaard writes: > Hi Matthias, > > On Thu, 2007-01-11 at 21:11 +0100, Matthias Klose wrote: > > The idea was to make the -doc packages depend on other -doc packages > > so that references to other packages can be resolved; unfortunately > > gjdoc doesn't support that yet. > > What would you

Re: Location of API docs

2007-01-12 Thread Mark Wielaard
Hi Matthias, On Thu, 2007-01-11 at 21:11 +0100, Matthias Klose wrote: > The idea was to make the -doc packages depend on other -doc packages > so that references to other packages can be resolved; unfortunately > gjdoc doesn't support that yet. What would you need from gjdoc to support 'that'? Co

Re: Location of API docs

2007-01-12 Thread Eric Lavarde - Debian
Hi, Marcus Better said: > Matthias Klose wrote: >>> How come? I thought we put api docs in the -doc package, if there is >>> one. > >> exactly, but into the /usr/share/doc/$package/api directory, not into >> the /usr/share/doc/$package-doc/api directory. > [...] > Is it really better to put the do

Re: Location of API docs

2007-01-12 Thread Marcus Better
Matthias Klose wrote: >> How come? I thought we put api docs in the -doc package, if there is >> one. > exactly, but into the /usr/share/doc/$package/api directory, not into > the /usr/share/doc/$package-doc/api directory. Oh, I wasn't aware of that. I've been doing it the other way around. But i

Re: Location of API docs

2007-01-12 Thread Matthias Klose
Marcus Better writes: > Matthias Klose wrote: > >> which seems more sensible to me. Should I change it to > >> /usr/share/doc/$package/api? I assume I should also create a doc-base. > > > where $package is the name of the library package, not the name of the > > doc package (if there exists an ext

Re: Location of API docs

2007-01-12 Thread Marcus Better
Matthias Klose wrote: >> which seems more sensible to me. Should I change it to >> /usr/share/doc/$package/api? I assume I should also create a doc-base. > where $package is the name of the library package, not the name of the > doc package (if there exists an extra -doc package). How come? I tho

Re: Location of API docs

2007-01-11 Thread Matthias Klose
Paul Cager writes: > I am updating the BCEL library to the new upstream version. The old > version installed the Javadocs into: > > /usr/share/doc/$package/doc/api > > Daniel Baumann queried this last night on IRC, and it seems that other > (newer) packages (e.g. libxalan2-java-doc) install int

Re: Location of API docs

2007-01-11 Thread Marcus Better
Paul Cager wrote: > which seems more sensible to me. Should I change it to > /usr/share/doc/$package/api? I assume I should also create a doc-base. Yes, sounds reasonable. The draft policy [1] suggests /usr/share/doc//api. Check this thread [2] about how to write the doc-base file. Marcus [1] h

Location of API docs

2007-01-10 Thread Paul Cager
I am updating the BCEL library to the new upstream version. The old version installed the Javadocs into: /usr/share/doc/$package/doc/api Daniel Baumann queried this last night on IRC, and it seems that other (newer) packages (e.g. libxalan2-java-doc) install into /usr/share/doc/$package/api