diff mbox

[2/3] doxygen: fix doxygen-run generated warnings

Message ID 1408579384-21392-3-git-send-email-anders.roxell@linaro.org
State Accepted
Commit 6498e3431353cfd7b841267ea13b2c9607a6c5f0
Headers show

Commit Message

Anders Roxell Aug. 21, 2014, 12:03 a.m. UTC 
Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
---
 platform/linux-generic/include/api/odp_pktio_netmap.h | 19 ++++++++++++++-----
 platform/linux-generic/include/api/odp_pktio_socket.h | 13 +++++++++++--
 platform/linux-generic/include/api/odp_pktio_types.h  | 16 ++++++++++++++--
 3 files changed, 39 insertions(+), 9 deletions(-)
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_pktio_netmap.h b/platform/linux-generic/include/api/odp_pktio_netmap.h
index d57e212..85272d5 100644
--- a/platform/linux-generic/include/api/odp_pktio_netmap.h
+++ b/platform/linux-generic/include/api/odp_pktio_netmap.h
@@ -5,18 +5,27 @@ 
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @file
+ *
+ * ODP packet input/output netmap
+ */
+
 #ifndef ODP_PKTIO_NETMAP_H
 #define ODP_PKTIO_NETMAP_H
 
 #include <odp_pktio_types.h>
 
-#define ODP_NETMAP_MODE_HW	0
-#define ODP_NETMAP_MODE_SW	1
+#define ODP_NETMAP_MODE_HW	0 /**< Netmap mode in hardware */
+#define ODP_NETMAP_MODE_SW	1 /**< Netmap mode in software */
 
+/**
+ * Netmap parameters
+ */
 typedef struct {
-	odp_pktio_type_t type;
-	int netmap_mode;
-	uint16_t ringid;
+	odp_pktio_type_t type;	/**< Packet IO type */
+	int netmap_mode;	/**< Netmap Mode */
+	uint16_t ringid;	/**< Ring identifiers */
 } netmap_params_t;
 
 #endif
diff --git a/platform/linux-generic/include/api/odp_pktio_socket.h b/platform/linux-generic/include/api/odp_pktio_socket.h
index deeeeed..6444cba 100644
--- a/platform/linux-generic/include/api/odp_pktio_socket.h
+++ b/platform/linux-generic/include/api/odp_pktio_socket.h
@@ -4,6 +4,12 @@ 
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @file
+ *
+ * ODP packet input/output socket
+ */
+
 #ifndef ODP_PKTIO_SOCKET_H
 #define ODP_PKTIO_SOCKET_H
 
@@ -13,9 +19,12 @@  extern "C" {
 
 #include <odp_pktio_types.h>
 
+/**
+ * Socket Parameters
+ */
 typedef struct {
-	odp_pktio_type_t type;
-	int fanout;
+	odp_pktio_type_t type;	/**< Packet IO type */
+	int fanout;		/**< Fantout */
 } socket_params_t;
 
 #ifdef __cplusplus
diff --git a/platform/linux-generic/include/api/odp_pktio_types.h b/platform/linux-generic/include/api/odp_pktio_types.h
index 8d195a5..54ce459 100644
--- a/platform/linux-generic/include/api/odp_pktio_types.h
+++ b/platform/linux-generic/include/api/odp_pktio_types.h
@@ -4,6 +4,12 @@ 
  * SPDX-License-Identifier:     BSD-3-Clause
  */
 
+/**
+ * @file
+ *
+ * ODP packet input/output types
+ */
+
 #ifndef ODP_PKTIO_TYPES_H
 #define ODP_PKTIO_TYPES_H
 
@@ -16,6 +22,9 @@  extern "C" {
  * was not built with netmap support and there are more types define below
  */
 
+/**
+ * Packet IO types
+ */
 typedef enum {
 	ODP_PKTIO_TYPE_SOCKET_BASIC = 0x1,
 	ODP_PKTIO_TYPE_SOCKET_MMSG,
@@ -28,9 +37,12 @@  typedef enum {
 #include <odp_pktio_netmap.h>
 #endif
 
+/**
+ * Packet IO parameters
+ */
 typedef union odp_pktio_params_t {
-	odp_pktio_type_t type;
-	socket_params_t sock_params;
+	odp_pktio_type_t type;		/**< Packet IO type */
+	socket_params_t sock_params;	/**< Socket parameter */
 #ifdef ODP_HAVE_NETMAP
 	netmap_params_t nm_params;
 #endif