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

Add doxygen style comments to all common ebpf headers #58

Merged
merged 12 commits into from
Apr 23, 2021
Merged

Add doxygen style comments to all common ebpf headers #58

merged 12 commits into from
Apr 23, 2021

Conversation

Alan-Jowett
Copy link
Member

Add doxygen style comments to all common ebpf headers

Resolves: #57

Signed-off-by: Alan Jowett alanjo@microsoft.com

@Alan-Jowett Alan-Jowett requested a review from a team as a code owner April 21, 2021 16:53
*
* @param[in] work_item Work item to schedule.
* @param[in] parameter_1 Parameter to pass to work item.
* @retval false Work item is already queued.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's internal then it's fine in my opinion (i..e, ok as is). Is this entire file an "internal" header? Separate from this PR, we should look at separating internal headers and exposed headers into separate subdirs.

@dthaler
Copy link
Collaborator

dthaler commented Apr 23, 2021

@Alan-Jowett need to resolve merge conflicts

Alan-Jowett and others added 12 commits April 23, 2021 10:23
Resolves: #57

Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Co-authored-by: Dave Thaler <dthaler@microsoft.com>
Co-authored-by: Dave Thaler <dthaler@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
@Alan-Jowett Alan-Jowett merged commit 44e748f into microsoft:master Apr 23, 2021
@Alan-Jowett Alan-Jowett deleted the doxygen branch May 5, 2021 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Headers for shared code modules should have doxygen comments
2 participants