diff options
author | Anders Roxell <anders.roxell@linaro.org> | 2014-08-21 02:03:03 +0200 |
---|---|---|
committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2014-08-22 12:43:32 +0400 |
commit | 6498e3431353cfd7b841267ea13b2c9607a6c5f0 (patch) | |
tree | f7777028245fc9334b61339d7e613553292f200b /platform | |
parent | 7fd717d8ffdff7f09e4824a28bedaa9829f80cff (diff) |
doxygen: fix doxygen-run generated warnings
Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
Reviewed-and-Tested-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org>
Diffstat (limited to 'platform')
-rw-r--r-- | platform/linux-generic/include/api/odp_pktio_netmap.h | 19 | ||||
-rw-r--r-- | platform/linux-generic/include/api/odp_pktio_socket.h | 13 | ||||
-rw-r--r-- | platform/linux-generic/include/api/odp_pktio_types.h | 16 |
3 files changed, 39 insertions, 9 deletions
diff --git a/platform/linux-generic/include/api/odp_pktio_netmap.h b/platform/linux-generic/include/api/odp_pktio_netmap.h index d57e2128f..85272d54a 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 deeeeedc3..6444cbaae 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 8d195a5fb..54ce459c8 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 |