Mailing List Archive

Convert in-code comments to kernel-doc format wherever possible.

Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
---
xen/include/public/hvm/hvm_op.h | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/xen/include/public/hvm/hvm_op.h b/xen/include/public/hvm/hvm_op.h
index 870ec52060..d62d3a96f8 100644
--- a/xen/include/public/hvm/hvm_op.h
+++ b/xen/include/public/hvm/hvm_op.h
@@ -27,14 +27,26 @@
#include "../trace.h"
#include "../event_channel.h"

-/* Get/set subcommands: extra argument == pointer to xen_hvm_param struct. */
+/**
+ * DOC: HVMOP_set_param and HVMOP_get_param
+ *
+ * Get/set subcommands: extra argument == pointer to xen_hvm_param struct.
+ */
#define HVMOP_set_param 0
#define HVMOP_get_param 1
+
+/**
+ * struct xen_hvm_param
+ */
struct xen_hvm_param {
- domid_t domid; /* IN */
+ /** @domid: IN parameter */
+ domid_t domid;
+ /** @pad: padding */
uint16_t pad;
- uint32_t index; /* IN */
- uint64_t value; /* IN/OUT */
+ /** @index: IN parameter */
+ uint32_t index;
+ /** @value: IN/OUT parameter */
+ uint64_t value;
};
typedef struct xen_hvm_param xen_hvm_param_t;
DEFINE_XEN_GUEST_HANDLE(xen_hvm_param_t);
--
2.17.1