mirror of
https://github.com/freebsd/freebsd-src.git
synced 2026-10-28 11:25:21 +01:00
Adrian Chadd
490c53e935
* Add top level README.md, linking to in progress and todo items * Add an 802.11 protocol overview, with todo items - this is designed to provide a basic introduction to 802.11 for people wishing to work on net80211 and drivers. * DEBUG.md - cover the debug API * DATAPATH_TRANSMIT.md - transmit datapath * DATAPATH_RECEIVE.md - receive datapath * PROTOCOL.md - a high level (for values of "high") overview of the 802.11 protocol and where it intersects with net80211 Differential Revision: https://reviews.freebsd.org/D56760
The kernel subsystem API documentation generation framework.
--------------------------------------------------------------
For every Doxyfile-(.*) the Makefile adds the public targets $1, pdf-$1 and
clean-$1. For e.g. Doxyfile-dev_pci this translates to the targets dev_pci,
pdf-dev_pci and clean-dev_pci.
Additionally, the targets 'all', 'pdf-all' and 'clean' to generate or remove
the documentation for all targets are available.
The file 'Dependencies' contains dependencies for the .tag files.
To add another part to the documentation just copy a Doxyfile and add
the necessary dependencies to the file 'Dependencies'.
The following environment variables can be used in the Doxyfile:
- DOXYGEN_SRC_PATH (/usr/src/sys)
- DOXYGEN_DEST_PATH (where the docs are generated)
- DOXYGEN_TARGET_ARCH (${TARGET_ARCH} if set, else ${MACHINE_ARCH})
For the PDF generation you may have to change some limits in the latex
configuration (the build may fail and an error about e.g. "pool size" is
shown), for print/texlive-full this is done in
/usr/local/share/texmf/web2c/texmf.cnf
Programs needed to generate the API docs:
- devel/doxygen
- print/texlive-full
- graphics/graphviz
--