[dpdk-dev] [PATCH 4/5] eal: mark internal interrupts file as such to doxygen
Bruce Richardson
bruce.richardson at intel.com
Thu Oct 19 18:36:28 CEST 2017
Put a file-level comment on rte_eal_interrupts.h to mark it as an
internal only header.
Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
---
lib/librte_eal/common/include/rte_eal_interrupts.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/lib/librte_eal/common/include/rte_eal_interrupts.h b/lib/librte_eal/common/include/rte_eal_interrupts.h
index 64f8e1eb3..5628f62c1 100644
--- a/lib/librte_eal/common/include/rte_eal_interrupts.h
+++ b/lib/librte_eal/common/include/rte_eal_interrupts.h
@@ -35,6 +35,14 @@
#error "don't include this file directly, please include generic <rte_interrupts.h>"
#endif
+/**
+ * @file rte_eal_interrupts.h
+ * @internal
+ *
+ * Contains function prototypes exposed by the EAL for interrupt handling by
+ * drivers and other DPDK internal consumers.
+ */
+
#ifndef _RTE_EAL_INTERRUPTS_H_
#define _RTE_EAL_INTERRUPTS_H_
--
2.13.6
More information about the dev
mailing list