|
|
 Up |
|
|
  |
Author: Mark WielaardMark Wielaard Date: Jan 12, 2007 04:40
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'?
Could you give an example, I am afraid I was unable to follow the
discussion to see what is really needed here.
Thanks,
Mark
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
iD8DBQBFp1s5xVhZCJWr9QwRAlxoAKCW0NN2QmoeBO7QgiC+2I3dUXd1OQCfbbJ7
ilqciQot6uZPricqCNYWo0k=
=FdeP
-----END PGP SIGNATURE-----
|
| |
|
| | 8 Comments |
|
|
Author: Matthias KloseMatthias Klose Date: Jan 12, 2007 07:00
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 need from gjdoc to support 'that'?
> Could you give an example, I am afraid I was unable to follow the
> discussion to see what is really needed here.
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 (but it seems to
be easier to use the name of the java package in all cases, instead of
the name of the -doc package in some cases).
Matthias
|
| Show full article (0.94Kb) |
|
| | 7 Comments |
|
|
Author: Marcus BetterMarcus Better Date: Jan 13, 2007 09:50
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?
|
| |
| 6 Comments |
|
|
Author: Paul CagerPaul Cager Date: Jan 13, 2007 13:40
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.
|
| |
| 5 Comments |
|
|
Author: Michael KochMichael Koch Date: Jan 13, 2007 15:20
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.
|
| Show full article (1.27Kb) |
| 4 Comments |
|
|
Author: Paul CagerPaul Cager Date: Jan 13, 2007 16:10
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. ...
|
| Show full article (1.80Kb) |
| 3 Comments |
|
|
Author: Michael KochMichael 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.
>> ...
|
| Show full article (2.30Kb) |
| 2 Comments |
|
|
Author: Michael KochMichael Koch Date: Jan 13, 2007 16:40
On Sun, Jan 14, 2007 at 12:31:11AM +0000, Matthew Johnson wrote:
>
>>
>>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.
>
> These aren't quite equivalent. For packages in contrib which depend on
> the sun compiler, VM and classes they can't really depend on the
> classpath docs when they don't match the API you are actually using.
Thats right currently. GNU classpath has merged its generics branch to
HEAD lately. The next release will be 1.5 compatible/comparable. Then
this will be a non-issue. There will always (?) be differences. If you
find one please report to the GNU classpath project.
|
| Show full article (1.22Kb) |
| no comments |
|
|
|
|
|
Author: Matthew JohnsonMatthew Johnson Date: Jan 13, 2007 16:50
>
> 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.
These aren't quite equivalent. For packages in contrib which depend on
the sun compiler, VM and classes they can't really depend on the
classpath docs when they don't match the API you are actually using.
Matt
--
Matthew Johnson
http://www.matthew.ath.cx/
|
| |
| no comments |
|
RELATED THREADS |
|
|
|
|
