virtio: Add virtio_dev_name function description

Add function description in Doxygen format for documentation. Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
OpenAMP · Oct 9, 2023 · 8f4a209 · 8f4a209
1 parent fd28176
commit 8f4a209
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/include/openamp/virtio.h b/lib/include/openamp/virtio.h
@@ -227,6 +227,14 @@ struct virtio_device {
 /*
  * Helper functions.
  */
+
+/**
+ * @brief Get the name of a virtio device.
+ *
+ * @param devid Id of the device.
+ *
+ * @return pointer to the device name string if found, otherwise null.
+ */
 const char *virtio_dev_name(uint16_t devid);
 void virtio_describe(struct virtio_device *dev, const char *msg,
 		     uint32_t features,