diff mbox

[PATCHv2] example: generator: add missing doxygen documentation

Message ID 1424713469-18702-1-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit 1f4b7b7181d82feef8cbe399887429a7d6961715
Headers show

Commit Message

Bill Fischofer Feb. 23, 2015, 5:44 p.m. UTC
Add missing doxygen documentation to resolve
Bug https://bugs.linaro.org/show_bug.cgi?id=1249

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 example/generator/odp_generator.c | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Mike Holmes Feb. 23, 2015, 5:59 p.m. UTC | #1
On 23 February 2015 at 12:44, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> Add missing doxygen documentation to resolve
> Bug https://bugs.linaro.org/show_bug.cgi?id=1249
>
> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
>

Reviewed-by: Mike Holmes <mike.holmes@linaro.org>


> ---
>  example/generator/odp_generator.c | 9 +++++++++
>  1 file changed, 9 insertions(+)
>
> diff --git a/example/generator/odp_generator.c
> b/example/generator/odp_generator.c
> index db9e0c2..47cab6c 100644
> --- a/example/generator/odp_generator.c
> +++ b/example/generator/odp_generator.c
> @@ -287,6 +287,15 @@ static odp_packet_t pack_icmp_pkt(odp_pool_t pool)
>         return pkt;
>  }
>
> +/**
> + * Create a pktio object
> + *
> + * @param dev Name of device to open
> + * @param pool Pool to associate with device for packet RX/TX
> + *
> + * @return The handle of the created pktio object.
> + * @warning This routine aborts if the create is unsuccessful.
> + */
>  static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool)
>  {
>         odp_queue_param_t qparam;
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov Feb. 25, 2015, 9:19 a.m. UTC | #2
Merged,
Maxim.

On 02/23/2015 08:59 PM, Mike Holmes wrote:
>
>
> On 23 February 2015 at 12:44, Bill Fischofer 
> <bill.fischofer@linaro.org <mailto:bill.fischofer@linaro.org>> wrote:
>
>     Add missing doxygen documentation to resolve
>     Bug https://bugs.linaro.org/show_bug.cgi?id=1249
>
>     Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org
>     <mailto:bill.fischofer@linaro.org>>
>
>
> Reviewed-by: Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>>
>
>     ---
>      example/generator/odp_generator.c | 9 +++++++++
>      1 file changed, 9 insertions(+)
>
>     diff --git a/example/generator/odp_generator.c
>     b/example/generator/odp_generator.c
>     index db9e0c2..47cab6c 100644
>     --- a/example/generator/odp_generator.c
>     +++ b/example/generator/odp_generator.c
>     @@ -287,6 +287,15 @@ static odp_packet_t pack_icmp_pkt(odp_pool_t
>     pool)
>             return pkt;
>      }
>
>     +/**
>     + * Create a pktio object
>     + *
>     + * @param dev Name of device to open
>     + * @param pool Pool to associate with device for packet RX/TX
>     + *
>     + * @return The handle of the created pktio object.
>     + * @warning This routine aborts if the create is unsuccessful.
>     + */
>      static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool)
>      {
>             odp_queue_param_t qparam;
>     --
>     2.1.0
>
>
>     _______________________________________________
>     lng-odp mailing list
>     lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     http://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> -- 
> *Mike Holmes*
> Linaro  Sr Technical Manager
> LNG - ODP
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/example/generator/odp_generator.c b/example/generator/odp_generator.c
index db9e0c2..47cab6c 100644
--- a/example/generator/odp_generator.c
+++ b/example/generator/odp_generator.c
@@ -287,6 +287,15 @@  static odp_packet_t pack_icmp_pkt(odp_pool_t pool)
 	return pkt;
 }
 
+/**
+ * Create a pktio object
+ *
+ * @param dev Name of device to open
+ * @param pool Pool to associate with device for packet RX/TX
+ *
+ * @return The handle of the created pktio object.
+ * @warning This routine aborts if the create is unsuccessful.
+ */
 static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool)
 {
 	odp_queue_param_t qparam;