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

Doxygen update for virtio structures #510

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Doxygen update for virtio structures #510

merged 2 commits into from
Oct 13, 2023

Conversation

arnopo
Copy link
Collaborator

@arnopo arnopo commented Oct 9, 2023

Complete virtio structure doxygen description initiate in #507

@tammyleino
Copy link
Collaborator

Added a few minor comments, but looks good otherwise. Thanks!

Copy link
Collaborator

@tnmysh tnmysh left a comment

Choose a reason for hiding this comment

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

Approved with minor comment that can be fixed later as well.

Add descriptions for following structures:
- virtio_device_id
- virtio_feature_desc
- virtio_dispatch
- virtqueue_buf
- virtqueue
- vring_alloc_info

Move some comments related to the vring structure in its description.

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Add function description in Doxygen format for documentation.

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
@arnopo arnopo merged commit 0360890 into OpenAMP:main Oct 13, 2023
2 checks passed
@arnopo arnopo added this to the Release V2023.10 milestone Oct 13, 2023
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.

3 participants