eal: mark internal interrupts file as such to doxygen
authorBruce Richardson <bruce.richardson@intel.com>
Thu, 19 Oct 2017 16:36:28 +0000 (17:36 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 23 Oct 2017 23:24:22 +0000 (01:24 +0200)
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>
lib/librte_eal/common/include/rte_eal_interrupts.h

index 64f8e1e..5628f62 100644 (file)
 #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_