Re: Doxygen generated PDF's of parts of the kernel available

From: Poul-Henning Kamp <phk_at_phk.freebsd.dk>
Date: Sun, 01 May 2005 17:59:52 +0200
In message <20050501170800.1bf7e377_at_Magellan.Leidinger.net>, Alexander Leidinge
r writes:

As far as I can tell, this gives us very little over a normal
code reading because we have not marked up our source code.

If we mark up the source code for doxygen, does that buy us anything
besides more text in the pdf files ?

Or to put the question another way:  Is the doxygen markup
*semantically* useful for any automated code-munching tools ?

Will anything tell us "you have an inconsistency here" or "this is
ambiguous" etc ?

It's not that I am against marking up for doxygen, that is probably
a good idea at some level.

My primary interest is tools which will tell us something about our
source code which we didn't know before, not just pretty-print what
we told it ourselves.

Poul-Henning

>Hi,
>
>I've generated the doxygen docs for some parts of the kernel, in
>particular for:
> - cam
> - crypto
> - dev/pci
> - dev/sound
> - dev/usb
> - geom
> - i4b
> - kern
> - libkern
> - net80211
> - netgraph
> - netinet
> - netinet6
> - netipsec
> - opencrypto
> - vm
>
>Since the content of all html trees sums up to >360 MB, I'm just
>uploading (it will need some minutes) the PDF's to
>	http://www.leidinger.net/FreeBSD/src_docs/
>
>They describe -current as of today (and may contain some local
>patches, I've used my development tree...).
>
>Bye,
>Alexander.
>
>-- 
>         The computer revolution is over. The computers won.
>
>http://www.Leidinger.net                       Alexander _at_ Leidinger.net
>  GPG fingerprint = C518 BC70 E67F 143F BE91  3365 79E2 9C60 B006 3FE7
>_______________________________________________
>freebsd-current_at_freebsd.org mailing list
>http://lists.freebsd.org/mailman/listinfo/freebsd-current
>To unsubscribe, send any mail to "freebsd-current-unsubscribe_at_freebsd.org"
>

-- 
Poul-Henning Kamp       | UNIX since Zilog Zeus 3.20
phk_at_FreeBSD.ORG         | TCP/IP since RFC 956
FreeBSD committer       | BSD since 4.3-tahoe    
Never attribute to malice what can adequately be explained by incompetence.
Received on Sun May 01 2005 - 13:59:54 UTC

This archive was generated by hypermail 2.4.0 : Wed May 19 2021 - 11:38:33 UTC