Skip to content

Commit 74bd7bc

Browse files
Jianyun Gaoanakryiko
authored andcommitted
libbpf: Complete the missing @param and @return tags in btf.h
Complete the missing @param and @return tags in the Doxygen comments of the btf.h file. Signed-off-by: Jianyun Gao <[email protected]> Signed-off-by: Andrii Nakryiko <[email protected]> Link: https://lore.kernel.org/bpf/[email protected]
1 parent 11369e6 commit 74bd7bc

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

tools/lib/bpf/btf.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ LIBBPF_API struct btf *btf__new_empty(void);
9494
* @brief **btf__new_empty_split()** creates an unpopulated BTF object from an
9595
* ELF BTF section except with a base BTF on top of which split BTF should be
9696
* based
97+
* @param base_btf base BTF object
9798
* @return new BTF object instance which has to be eventually freed with
9899
* **btf__free()**
99100
*
@@ -115,6 +116,10 @@ LIBBPF_API struct btf *btf__new_empty_split(struct btf *base_btf);
115116
* When that split BTF is loaded against a (possibly changed) base, this
116117
* distilled base BTF will help update references to that (possibly changed)
117118
* base BTF.
119+
* @param src_btf source split BTF object
120+
* @param new_base_btf pointer to where the new base BTF object pointer will be stored
121+
* @param new_split_btf pointer to where the new split BTF object pointer will be stored
122+
* @return 0 on success; negative error code, otherwise
118123
*
119124
* Both the new split and its associated new base BTF must be freed by
120125
* the caller.
@@ -264,6 +269,9 @@ LIBBPF_API int btf__dedup(struct btf *btf, const struct btf_dedup_opts *opts);
264269
* to base BTF kinds, and verify those references are compatible with
265270
* *base_btf*; if they are, *btf* is adjusted such that is re-parented to
266271
* *base_btf* and type ids and strings are adjusted to accommodate this.
272+
* @param btf split BTF object to relocate
273+
* @param base_btf base BTF object
274+
* @return 0 on success; negative error code, otherwise
267275
*
268276
* If successful, 0 is returned and **btf** now has **base_btf** as its
269277
* base.

0 commit comments

Comments
 (0)