Skip to content

Documentation rules

To write

How the code is documented and how this site is built.

House style

  • @file + @brief, @param[in|out], @retval per error, @syscall_* tags

Gates

  • make doc-check, docs/doc-scope, make doc-report DIR=

This site

  • reference pages come from scripts/gen_docs.py; hand-written pages live in kagantmr/zuzu-docs