libbpf: Add API documentation convention guidelines
authorGrant Seltzer <grantseltzer@gmail.com>
Mon, 4 Oct 2021 21:56:44 +0000 (17:56 -0400)
committerAndrii Nakryiko <andrii@kernel.org>
Wed, 6 Oct 2021 19:34:02 +0000 (12:34 -0700)
commit9330303446382a33aa62a8a88a7a48555f76df0b
tree6adf59485ab8b1746081d8183802e9f6510faa79
parent189c83bdde850e1fc8bb347f813cdd8776ce7abf
libbpf: Add API documentation convention guidelines

This adds a section to the documentation for libbpf
naming convention which describes how to document
API features in libbpf, specifically the format of
which API doc comments need to conform to.

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Acked-by: Song Liu <songliubraving@fb.com>
Link: https://lore.kernel.org/bpf/20211004215644.497327-1-grantseltzer@gmail.com
Documentation/bpf/libbpf/libbpf_naming_convention.rst