commit 3b6256c2c57061c365cfad7857e12fd8d15ca3c8
author Alex Bennée <alex.bennee@linaro.org> Mon Jul 10 16:35:07 2023 +0100
committer Michael S. Tsirkin <mst@redhat.com> Mon Jul 10 18:59:32 2023 -0400
tree c58e1d14a92e9c2c8cf70beba6570bb29d25002b
parent a0cc7673ab731794caefed2033d68a2199d6bfaf

include/hw/virtio: add kerneldoc for virtio_init

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20230710153522.3469097-6-alex.bennee@linaro.org>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>

include/hw/virtio/virtio.h

diff --git a/include/hw/virtio/virtio.h b/include/hw/virtio/virtio.h
index 0671989..631490b 100644
--- a/include/hw/virtio/virtio.h
+++ b/include/hw/virtio/virtio.h
@@ -219,6 +219,12 @@
 void virtio_instance_init_common(Object *proxy_obj, void *data,
                                  size_t vdev_size, const char *vdev_name);
 
+/**
+ * virtio_init() - initialise the common VirtIODevice structure
+ * @vdev: pointer to VirtIODevice
+ * @device_id: the VirtIO device ID (see virtio_ids.h)
+ * @config_size: size of the config space
+ */
 void virtio_init(VirtIODevice *vdev, uint16_t device_id, size_t config_size);
 
 void virtio_cleanup(VirtIODevice *vdev);