Skip to content

doxygen: add @code block to correct generation of vring code snippet #661

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doxygen: add @code block to correct generation of vring code snippet #661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/include/openamp/virtio_ring.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ struct vring_used {
* The standard layout for the ring is a continuous chunk of memory which
* looks like this. We assume num is a power of 2.
*
* @code{.c}
* struct vring {
* // The actual descriptors (16 bytes each)
* struct vring_desc desc[num];
Expand All @@ -145,6 +146,7 @@ struct vring_used {
* struct vring_used_elem used[num];
* __u16 avail_event_idx;
* };
* @endcode
*
* NOTE: for VirtIO PCI, align is 4096.
*/
Expand Down