Dynamic Table of Contents of all system Javadoc
 

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi

I was asked if we might be interested in having a dynamic ToC of all
system installed javadocs. The idea was posted as a bug against Fedora
[1]. Of course we have doc-base, but it appears to be Debian specific?

What do you think of this idea?

~Niels

[1] https://bugzilla.redhat.com/show_bug.cgi?id=693418

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQIcBAEBCAAGBQJNnFSVAAoJEAVLu599gGRCE6EQAJA6Gk05Tk fY9gu/WjACd4kM
l1oMf9LrwqeTAZTRYqI32vktcJKAaubZ2rRt8bmftHH22pbhIQ QMjBquUuqsv/BL
QuGBDP3ECbh/DiTEWd74SRIEaj++VrbFoAtVrtJARqBO3YNa5XqZCgqL3gnO//RB
shGmQSXAZFuKyfFN/AAA52DT8/FJQgG3XUoS2zEY6A5d66ldEmiAOXYcByMS6KQS
EYHANj26jzfl6ixgD5oh7+Xk7rPe3aHPraUwz9OAHF01sbunaD OP6kFAP5Pcmy1O
6PUWRc/rhmr70bHwDG3hceoSamgclrjggc7hRlEotsjQic3ZSyWZ0wjcg Raq2TCl
atzXDTrk1RioAssqDflIOtXEQCQVgtOcwqpNo85D2Kb8GeoVjQ RHIk5E8koTlIZ5
3HkQ77qDzAKNLKfGIe/k7dfQbM0MGCRhIBECELmhLxJSShJKTrp8I5ZYmB/BceMy
M+CP21NS8E8uXGkkHM1zKt9demYpuI2lnpF7S6/yNA3N7C3wBJwT8DLidvKxUVdw
dToEiApAfSG3VyGynDMc5p0gIvyt93RMALcZOZ4ylmPiw6uQae YakZlbJI3jhyPQ
QO+Q5uqSKX+wFXj2yDri8bg9M86jG/PU/53Uhk2oTHgmA8bpPUzTHO1NjDs0oA6J
rs4OywtJobKOYSVG4dyP
=LcSU
-----END PGP SIGNATURE-----


--
To UNSUBSCRIBE, email to debian-java-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: 4D9C5495.4000603@thykier.net">http://lists.debian.org/4D9C5495.4000603@thykier.net

Dynamic Table of Contents of all system Javadoc
 

Wouldn't it be better to have something that is neither Java-specific
nor Debian-specific?

--
bye,
pabs

http://wiki.debian.org/PaulWise


--
To UNSUBSCRIBE, email to debian-java-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: BANLkTim8LwtYfRK=Qg9CCSxhuXKr-v9K+w@mail.gmail.com">http://lists.debian.org/BANLkTim8LwtYfRK=Qg9CCSxhuXKr-v9K+w@mail.gmail.com

Dynamic Table of Contents of all system Javadoc
 

This proposal is for Eclipse, so the documentation in question is
Java-specific, but it could also include Groovy doc, and any other
languages providing structured HTML documentation.

It probaly will be implemented as an Eclipse plugin.
I think that is a great idea, as it would provide a good use-case for
those documentation packages which are quite under-used.
In the same way, we could provide automatically Eclipse libraries for
system-installed jars.

Ludovic

On 07/04/2011 08:43, Paul Wise wrote:
>
> Wouldn't it be better to have something that is neither Java-specific
> nor Debian-specific?
>


--
To UNSUBSCRIBE, email to debian-java-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: 4D9E361B.4040109@laposte.net">http://lists.debian.org/4D9E361B.4040109@laposte.net

Dynamic Table of Contents of all system Javadoc
 

Hello !

On 08/04/11 00:09, Ludovic Claude wrote:
> This proposal is for Eclipse, so the documentation in question is
> Java-specific, but it could also include Groovy doc, and any other
> languages providing structured HTML documentation.
>
> It probaly will be implemented as an Eclipse plugin.
> I think that is a great idea, as it would provide a good use-case for
> those documentation packages which are quite under-used.
> In the same way, we could provide automatically Eclipse libraries for
> system-installed jars.

I too think it is a good idea, and that would probably be a good
occasion to enforce the policy on javadoc. I'm currently improving
lintian with a little more knowledge of java (see #620829). I haven't
started to work on javadoc, but it's somewhere on my TODO-list.

That raises a question I have in mind, and for which the policy is
currently unclear. Several of the packages I maintain are both programs
and libraries (and used as such). One of the examples that come to my
mind is statcvs, which is used by statsvn. For now, the package is
simply called statcvs, and it contains the javadoc (which is bad).
However, if we consider it a library, I should split that into three
packages:

statcvs, that would still contain the wrapper and the manual page.

libstatcvs-java, containing the jar

libstatcvs-java-doc, containing the javadoc.

Is that correct ? Should this be enforced ? (it is simple enough: if
javadoc is built for a program, then most probably it is used as a
library too).

Cheers,

Vincent

--
Vincent Fourmond, Debian Developer
http://vince-debian.blogspot.com/

Some pirates achieved immortality by great deeds of cruelty
and derring-do. Some achieved immortality by amassing great
wealth. But the captain had long ago decided that he would,
on the whole, prefer to achieve immortality by not dying.
-- Terry Pratchet, the Colour of Magic

Vincent, listening to Frank Sinatra (CAKE)


--
To UNSUBSCRIBE, email to debian-java-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: 4D9E3C29.7060405@debian.org">http://lists.debian.org/4D9E3C29.7060405@debian.org