Mailing List Archive

[PATCH v2 03/14] kernel-doc: public/device_tree_defs.h
Convert in-code comments to kernel-doc format wherever possible.

Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
---
xen/include/public/device_tree_defs.h | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/xen/include/public/device_tree_defs.h b/xen/include/public/device_tree_defs.h
index 209d43de3f..be35598b53 100644
--- a/xen/include/public/device_tree_defs.h
+++ b/xen/include/public/device_tree_defs.h
@@ -2,7 +2,9 @@
#define __XEN_DEVICE_TREE_DEFS_H__

#if defined(__XEN__) || defined(__XEN_TOOLS__)
-/*
+/**
+ * DOC: GUEST_PHANDLE_GIC
+ *
* The device tree compiler (DTC) is allocating the phandle from 1 to
* onwards. Reserve a high value for the GIC phandle.
*/
@@ -12,17 +14,17 @@
#define GUEST_ROOT_SIZE_CELLS 2

/**
- * IRQ line type.
+ * DOC: IRQ line type.
*
- * DT_IRQ_TYPE_NONE - default, unspecified type
- * DT_IRQ_TYPE_EDGE_RISING - rising edge triggered
- * DT_IRQ_TYPE_EDGE_FALLING - falling edge triggered
- * DT_IRQ_TYPE_EDGE_BOTH - rising and falling edge triggered
- * DT_IRQ_TYPE_LEVEL_HIGH - high level triggered
- * DT_IRQ_TYPE_LEVEL_LOW - low level triggered
- * DT_IRQ_TYPE_LEVEL_MASK - Mask to filter out the level bits
- * DT_IRQ_TYPE_SENSE_MASK - Mask for all the above bits
- * DT_IRQ_TYPE_INVALID - Use to initialize the type
+ * - DT_IRQ_TYPE_NONE - default, unspecified type
+ * - DT_IRQ_TYPE_EDGE_RISING - rising edge triggered
+ * - DT_IRQ_TYPE_EDGE_FALLING - falling edge triggered
+ * - DT_IRQ_TYPE_EDGE_BOTH - rising and falling edge triggered
+ * - DT_IRQ_TYPE_LEVEL_HIGH - high level triggered
+ * - DT_IRQ_TYPE_LEVEL_LOW - low level triggered
+ * - DT_IRQ_TYPE_LEVEL_MASK - Mask to filter out the level bits
+ * - DT_IRQ_TYPE_SENSE_MASK - Mask for all the above bits
+ * - DT_IRQ_TYPE_INVALID - Use to initialize the type
*/
#define DT_IRQ_TYPE_NONE 0x00000000
#define DT_IRQ_TYPE_EDGE_RISING 0x00000001
--
2.17.1