cvs commit: src/sys/doc/subsys Dependencies Doxyfile-cam
Doxyfile-crypto Doxyfile-dev_pci Doxyfile-dev_sound Doxyfile-dev_usb
Doxyfile-geom Doxyfile-i4b Doxyfile-kern Doxyfile-libkern Doxyfile-linux
sam at errno.com
Fri May 26 11:25:02 PDT 2006
Alexander Leidinger wrote:
> netchild 2006-05-26 18:06:07 UTC
> FreeBSD src repository
> Added files:
> sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto
> Doxyfile-dev_pci Doxyfile-dev_sound
> Doxyfile-dev_usb Doxyfile-geom
> Doxyfile-i4b Doxyfile-kern
> Doxyfile-libkern Doxyfile-linux
> Doxyfile-net80211 Doxyfile-netgraph
> Doxyfile-netinet Doxyfile-netinet6
> Doxyfile-netipsec Doxyfile-opencrypto
> Doxyfile-vm Makefile README
> This is the kernel subsystem API documentation generation framework.
> It uses doxygen to generate the API documentation. For each subsystem
> a very small (about 20 lines with comments) subsystem specific Doxyfile
> has to be written (have a look at the README for more). All common doxygen
> options are specified in a separate file.
> The framework is configured to not only generate the HTML version, but also
> a PDF version (the paper size is hardcoded to DIN A4 currently and depending
> on the subsystem you have to increase some limits in the latex configuration
> of your system, the README tells more about this).
> It also allows cross-references between the subsystems (it generates doxygen
> tag files).
> Currently the docs are generated in OBJDIR, but this may change after
> coordination with doc at . The makefile is prepared to generate/move various
> parts of the generated docs to different destinations.
> TARGET_ARCH is respected and some env-vars are set for architecture specific
> handling of the source (the README tells more).
> Subsystems for which docs are generated:
> - cam - crypto - dev_pci
> - dev_sound - dev_usb - geom
> - i4b - kern - libkern
> - linux - net80211 - netgraph
> - netinet - netinet6 - netipsec
> - opencrypto - vm
> Requested by: gnn
Can someone explain the purpose of this? Is the intent to annotate
source code for generating documentation? I don't recall seeing a
discussion about this.
More information about the cvs-src