libbpf: Add doc comments in libbpf.h
authorGrant Seltzer <grantseltzer@gmail.com>
Mon, 6 Dec 2021 20:37:09 +0000 (15:37 -0500)
committerAndrii Nakryiko <andrii@kernel.org>
Mon, 6 Dec 2021 22:22:37 +0000 (14:22 -0800)
commitd5284dedccdb9053988278dd30c834d46b8c866d
tree9f8310e62d4d498b111498e34f7718c0d06ca033
parent222c98c7979084fbefb4ce2ae377210c6e42011e
libbpf: Add doc comments in libbpf.h

This adds comments above functions in libbpf.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

These doc comments are for:

- bpf_object__open_file()
- bpf_object__open_mem()
- bpf_program__attach_uprobe()
- bpf_program__attach_uprobe_opts()

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