libbpf: Add sphinx code documentation comments

Browse source

This adds comments above five functions in btf.h which document
their uses. These comments are of a format that doxygen and sphinx
can pick up and render. These are rendered by libbpf.readthedocs.org

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20210915021951.117186-1-grantseltzer@gmail.com

...

This commit is contained in:

Grant Seltzer 2021-09-14 22:19:52 -04:00 • committed by Andrii Nakryiko

parent 2220ecf55c

commit 69cd823956

1 changed files with 70 additions and 0 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

70

tools/lib/bpf/btf.h

View file