1 The kernel subsystem API documentation generation framework. 2 -------------------------------------------------------------- 3 4For every Doxyfile-(.*) the Makefile adds the public targets $1, pdf-$1 and 5clean-$1. For e.g. Doxyfile-dev_pci this translates to the targets dev_pci, 6pdf-dev_pci and clean-dev_pci. 7 8Additionally, the targets 'all', 'pdf-all' and 'clean' to generate or remove 9the documentation for all targets are available. 10 11The file 'Dependencies' contains dependencies for the .tag files. 12 13To add another part to the documentation just copy a Doxyfile and add 14the necessary dependencies to the file 'Dependencies'. 15 16The following environment variables can be used in the Doxyfile: 17 - DOXYGEN_SRC_PATH (/usr/src/sys) 18 - DOXYGEN_DEST_PATH (where the docs are generated) 19 - DOXYGEN_TARGET_ARCH (${TARGET_ARCH} if set, else ${MACHINE_ARCH}) 20 21For the PDF generation you may have to change some limits in the latex 22configuration (the build may fail and an error about e.g. "pool size" is 23shown), for print/teTeX this is done in 24 /usr/local/share/texmf/web2c/texmf.cnf 25 26Programs needed to generate the API docs: 27 - devel/doxygen 28 - print/teTeX 29 - graphics/graphviz 30 31-- 32