[RFC PATCH 04/11] docs/doxygen: Add doxygen tags to arch-arm.h

[Luca Fancellu <luca.fancellu@xxxxxxx>]

Add doxygen tags to arch-arm.h to:
1) create hyper calling convention section
2) create supported hypercalls section

Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx>
---
 xen/include/public/arch-arm.h | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/xen/include/public/arch-arm.h b/xen/include/public/arch-arm.h
index c365b1b39e..7afc14e67b 100644
--- a/xen/include/public/arch-arm.h
+++ b/xen/include/public/arch-arm.h
@@ -24,13 +24,20 @@
  * Copyright 2011 (C) Citrix Systems
  */
 
+/**
+ * @file
+ * @brief Guest OS interface to ARM Xen.
+ */
+
 #ifndef __XEN_PUBLIC_ARCH_ARM_H__
 #define __XEN_PUBLIC_ARCH_ARM_H__
 
 /*
  * `incontents 50 arm_abi Hypercall Calling Convention
- *
- * A hypercall is issued using the ARM HVC instruction.
+ */
+
+/**
+ * @brief A hypercall is issued using the ARM HVC instruction.
  *
  * A hypercall can take up to 5 arguments. These are passed in
  * registers, the first argument in x0/r0 (for arm64/arm32 guests
@@ -70,12 +77,17 @@
  *    vcpu_info, the grant table, etc).
  *
  * Any cache allocation hints are acceptable.
+ * @addtogroup hypercall_calling_convention Hyper Calling Convention
+ * @{
+ * @}
  */
 
 /*
  * `incontents 55 arm_hcall Supported Hypercalls
- *
- * Xen on ARM makes extensive use of hardware facilities and therefore
+ */
+
+/**
+ * @brief Xen on ARM makes extensive use of hardware facilities and therefore
  * only a subset of the potential hypercalls are required.
  *
  * Since ARM uses second stage paging any machine/physical addresses
@@ -161,6 +173,9 @@
  *
  * - The device tree Xen compatible node is fully described under Linux
  *   at Documentation/devicetree/bindings/arm/xen.txt.
+ * @addtogroup supported_hypercalls Supported Hypercalls
+ * @{
+ * @}
  */
 
 #define XEN_HYPERCALL_TAG   0XEA1
-- 
2.17.1