[API-NEXT] api: pktio description of doxygen group

Message ID 1439979895-26593-1-git-send-email-maxim.uvarov@linaro.org
State New
Headers show

Commit Message

Maxim Uvarov Aug. 19, 2015, 10:24 a.m.
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
---
 include/odp/api/packet_io.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mike Holmes Aug. 19, 2015, 11:46 a.m. | #1
On 19 August 2015 at 06:24, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:
> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
> ---
>  include/odp/api/packet_io.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
> index e00d011..8169372 100644
> --- a/include/odp/api/packet_io.h
> +++ b/include/odp/api/packet_io.h
> @@ -19,7 +19,7 @@ extern "C" {
>  #endif
>
>  /** @defgroup odp_packet_io ODP PACKET IO
> - *  Operations on a packet.
> + *  Operations on a packet input/output interface.
>   *  @{
>   */
>
> --
> 1.9.1
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp

If you are adding detail could we add a paragraph of detailed
description below this brief description ?

Currently all we have is if the following for the detailed description.
"
Detailed Description

Operations on a packet. "

I think it is important that we describe its two modes, it may be used
in polled mode or with the classifier and scheduler in event driven
mode, and then allude broadly to what you can do with this module to
configure an interface.

This is a very rough example of what I think we need.
"
Packet IO is the Ingress and Egress interface to ODP processing. It
allows manipulation of the interface for setting such attributes as
the mtu, mac etc.
Pktio is usually followed by the classifier and a default class COS
can be set so that the scheduler may distribute flows. The interface
may be used directly in polled mode with odp_pktio_recv() &
odp_pktio_send().
Diagnostic massages can be enhanced by using odp_pktio_to_u64 which
will generate a printable reference for a pktio handle for use with
the logging @ref odp_ver_abt_log_dbg
"

Patch

diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h
index e00d011..8169372 100644
--- a/include/odp/api/packet_io.h
+++ b/include/odp/api/packet_io.h
@@ -19,7 +19,7 @@  extern "C" {
 #endif
 
 /** @defgroup odp_packet_io ODP PACKET IO
- *  Operations on a packet.
+ *  Operations on a packet input/output interface.
  *  @{
  */