d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ba86e75654
freebsd-nq/sys/doc/subsys/Doxyfile-cam

21 lines
802 B
Plaintext
Raw Normal View History

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@. 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
2006-05-26 18:06:07 +00:00
# Doxyfile 1.4.1
# $FreeBSD$
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "FreeBSD kernel CAM code"
OUTPUT_DIRECTORY = $(DOXYGEN_DEST_PATH)/cam/
EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
Add a disclaimer regarding public/internal functions to every subsystem for now. Discussed on: cvs-all Helped with the wording: "Ben Kaduk" <minimarmot@gmail.com>
2006-05-28 15:25:18 +00:00
INPUT = $(DOXYGEN_SRC_PATH)/cam/ $(NOTREVIEWED)
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@. 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
2006-05-26 18:06:07 +00:00
GENERATE_TAGFILE = cam/cam.tag
@INCLUDE_PATH = $(DOXYGEN_INCLUDE_PATH)
@INCLUDE = common-Doxyfile
Reference in New Issue Copy Permalink