aboutsummaryrefslogtreecommitdiff
path: root/backend
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2022-05-25 14:04:16 +0200
committerSimon Zeni <simon@bl4ckb0ne.ca>2022-05-25 14:22:58 +0000
commit27383a1929348daf01e18349f215c998b6ef8c2f (patch)
tree0910c1515faf5e823e3c6dc49b3e57fac86ecee6 /backend
parentf91f38b79af2bcd091da7347e83066dea679a1bd (diff)
contributing: add section about documentation conventions
Document the existing conventions. Use `mystruct.foo` instead of `mystruct::foo` because `::` is pretty alien to C. Instead of backticks, use a different format to reference declarations in our docs: See foo(). See struct foo. See union bar. See enum baz. See typedef meh. This is inspired by the kernel's documentation style [1]. This format has the upside of being pretty natural to write and read, and can be automatically processed by documentation generators. [1]: https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#cross-referencing-from-restructuredtext
Diffstat (limited to 'backend')
0 files changed, 0 insertions, 0 deletions