[RFC PATCH 09/11] docs/doxygen: Add doxygen tags to features.h

[Luca Fancellu <luca.fancellu@xxxxxxx>]

Add doxygen tags to comments for:
1) create XEN_ELFNOTE_FEATURES group
2) set documentation for macros

Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx>
---
 xen/include/public/features.h | 48 +++++++++++++++++++++++------------
 1 file changed, 32 insertions(+), 16 deletions(-)

diff --git a/xen/include/public/features.h b/xen/include/public/features.h
index 1613b2aab8..a92d9f2184 100644
--- a/xen/include/public/features.h
+++ b/xen/include/public/features.h
@@ -24,11 +24,20 @@
  * Copyright (c) 2006, Keir Fraser <keir@xxxxxxxxxxxxx>
  */
 
+/**
+ * @file
+ * @brief Feature flags, reported by XENVER_get_features.
+ */
+
 #ifndef __XEN_PUBLIC_FEATURES_H__
 #define __XEN_PUBLIC_FEATURES_H__
 
 /*
  * `incontents 200 elfnotes_features XEN_ELFNOTE_FEATURES
+ */
+
+/**
+ * @brief XEN_ELFNOTE_FEATURES
  *
  * The list of all the features the guest supports. They are set by
  * parsing the XEN_ELFNOTE_FEATURES and XEN_ELFNOTE_SUPPORTED_FEATURES
@@ -38,22 +47,25 @@
  * must be preceded by a '!' character.
  *
  * Note that if XEN_ELFNOTE_SUPPORTED_FEATURES is used, then in the
- * XENFEAT_dom0 MUST be set if the guest is to be booted as dom0,
+ * XENFEAT_dom0 MUST be set if the guest is to be booted as dom0.
+ *
+ * @addtogroup xen_elfnote_features XEN_ELFNOTE_FEATURES
+ * @{
  */
 
-/*
+/**
  * If set, the guest does not need to write-protect its pagetables, and can
  * update them via direct writes.
  */
 #define XENFEAT_writable_page_tables       0
 
-/*
+/**
  * If set, the guest does not need to write-protect its segment descriptor
  * tables, and can update them via direct writes.
  */
 #define XENFEAT_writable_descriptor_tables 1
 
-/*
+/**
  * If set, translation between the guest's 'pseudo-physical' address space
  * and the host's machine address space are handled by the hypervisor. In this
  * mode the guest does not need to perform phys-to/from-machine translations
@@ -61,37 +73,37 @@
  */
 #define XENFEAT_auto_translated_physmap    2
 
-/* If set, the guest is running in supervisor mode (e.g., x86 ring 0). */
+/** If set, the guest is running in supervisor mode (e.g., x86 ring 0). */
 #define XENFEAT_supervisor_mode_kernel     3
 
-/*
+/**
  * If set, the guest does not need to allocate x86 PAE page directories
  * below 4GB. This flag is usually implied by auto_translated_physmap.
  */
 #define XENFEAT_pae_pgdir_above_4gb        4
 
-/* x86: Does this Xen host support the MMU_PT_UPDATE_PRESERVE_AD hypercall? */
+/** x86: Does this Xen host support the MMU_PT_UPDATE_PRESERVE_AD hypercall? */
 #define XENFEAT_mmu_pt_update_preserve_ad  5
 
-/* x86: Does this Xen host support the MMU_{CLEAR,COPY}_PAGE hypercall? */
+/** x86: Does this Xen host support the MMU_{CLEAR,COPY}_PAGE hypercall? */
 #define XENFEAT_highmem_assist             6
 
-/*
+/**
  * If set, GNTTABOP_map_grant_ref honors flags to be placed into guest kernel
  * available pte bits.
  */
 #define XENFEAT_gnttab_map_avail_bits      7
 
-/* x86: Does this Xen host support the HVM callback vector type? */
+/** x86: Does this Xen host support the HVM callback vector type? */
 #define XENFEAT_hvm_callback_vector        8
 
-/* x86: pvclock algorithm is safe to use on HVM */
+/** x86: pvclock algorithm is safe to use on HVM */
 #define XENFEAT_hvm_safe_pvclock           9
 
-/* x86: pirq can be used by HVM guests */
+/** x86: pirq can be used by HVM guests */
 #define XENFEAT_hvm_pirqs                 10
 
-/* operation as Dom0 is supported */
+/** operation as Dom0 is supported */
 #define XENFEAT_dom0                      11
 
 /* Xen also maps grant references at pfn = mfn.
@@ -99,13 +111,13 @@
 #define XENFEAT_grant_map_identity        12
  */
 
-/* Guest can use XENMEMF_vnode to specify virtual node for memory op. */
+/** Guest can use XENMEMF_vnode to specify virtual node for memory op. */
 #define XENFEAT_memory_op_vnode_supported 13
 
-/* arm: Hypervisor supports ARM SMC calling convention. */
+/** arm: Hypervisor supports ARM SMC calling convention. */
 #define XENFEAT_ARM_SMCCC_supported       14
 
-/*
+/**
  * x86/PVH: If set, ACPI RSDP can be placed at any address. Otherwise RSDP
  * must be located in lower 1MB, as required by ACPI Specification for IA-PC
  * systems.
@@ -116,6 +128,10 @@
 
 #define XENFEAT_NR_SUBMAPS 1
 
+/**
+ * @}
+*/
+
 #endif /* __XEN_PUBLIC_FEATURES_H__ */
 
 /*
-- 
2.17.1