[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[RFC PATCH 10/11] docs/doxygen: Add doxygen tags to xs_wire.h



Add doxygen tags to comments for create XenStore wire protocol group

Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx>
---
 xen/include/public/io/xs_wire.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/xen/include/public/io/xs_wire.h b/xen/include/public/io/xs_wire.h
index 4dd6632669..bab2e7b703 100644
--- a/xen/include/public/io/xs_wire.h
+++ b/xen/include/public/io/xs_wire.h
@@ -23,9 +23,22 @@
  * Copyright (C) 2005 Rusty Russell IBM Corporation
  */
 
+/**
+ * @file
+ * @brief Details of the "wire" protocol between Xen Store Daemon and client
+ * library or guest kernel.
+ */
+
 #ifndef _XS_WIRE_H
 #define _XS_WIRE_H
 
+/**
+ * @brief Inter-domain shared memory communications.
+ *
+ * @addtogroup xenstore_wire_protocol XenStore wire protocol
+ * @{
+ */
+
 enum xsd_sockmsg_type
 {
     XS_CONTROL,
@@ -140,6 +153,10 @@ struct xenstore_domain_interface {
 #define XENSTORE_CONNECTED 0 /* the steady-state */
 #define XENSTORE_RECONNECT 1 /* guest has initiated a reconnect */
 
+/**
+ * @}
+ */
+
 #endif /* _XS_WIRE_H */
 
 /*
-- 
2.17.1




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.