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