From: Bruce Richardson <bruce.richardson@intel.com>
Date: Thu, 19 Oct 2017 16:36:28 +0000 (+0100)
Subject: eal: mark internal interrupts file as such to doxygen
X-Git-Tag: spdx-start~1269
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=1ae0a97f1457b027b1a8cbff6a0fe10743d9db28;p=dpdk.git

eal: mark internal interrupts file as such to doxygen

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@intel.com>
---

diff --git a/lib/librte_eal/common/include/rte_eal_interrupts.h b/lib/librte_eal/common/include/rte_eal_interrupts.h
index 64f8e1eb33..5628f62c1b 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_