Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Add Doxygen documentation for bpf map batch APIs #3629

Closed
shpalani opened this issue Jun 13, 2024 · 3 comments · Fixed by #3652
Closed

[Doc] Add Doxygen documentation for bpf map batch APIs #3629

shpalani opened this issue Jun 13, 2024 · 3 comments · Fixed by #3652
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation triaged Discussed in a triage meeting
Milestone

Comments

@shpalani
Copy link
Collaborator

Describe the bug

There is no doxygen documentation for the bpf_map_xxx_batch() apis searched in https://microsoft.github.io/ebpf-for-windows/libbpf_8h.html.

This issue is created to add the doxygen map batch API support in include\bpf\bpf.h

OS information

Windows 11

Steps taken to reproduce bug

There is no doxygen documentation for the bpf_map_xxx_batch() apis searched in
https://microsoft.github.io/ebpf-for-windows/bpf_2bpf_8h.html,
https://microsoft.github.io/ebpf-for-windows/libbpf_8h.html

Expected behavior

Add the missing batch map APIs doc in https://microsoft.github.io/ebpf-for-windows/libbpf_8h.html

Actual outcome

Not present in https://microsoft.github.io/ebpf-for-windows/libbpf_8h.html

Additional details

No response

@shpalani shpalani added the bug Something isn't working label Jun 13, 2024
@shpalani
Copy link
Collaborator Author

I'm working on it.

@shpalani shpalani self-assigned this Jun 15, 2024
@dthaler dthaler added the documentation Improvements or additions to documentation label Jun 17, 2024
@dahavey dahavey added the triaged Discussed in a triage meeting label Jun 17, 2024
@dahavey dahavey added this to the 2406 milestone Jun 17, 2024
@shpalani shpalani linked a pull request Jun 18, 2024 that will close this issue
@shankarseal shankarseal modified the milestones: 2406, 2408 Jun 26, 2024
@shpalani
Copy link
Collaborator Author

shpalani commented Jul 1, 2024

Status: In PR. I have addressed the review comment.

@shpalani
Copy link
Collaborator Author

shpalani commented Jul 9, 2024

I am still waiting for the second reviewer's approval.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation triaged Discussed in a triage meeting
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants