diff mbox

example: generator: add missing doxygen documentation

Message ID 1424711937-13477-1-git-send-email-bill.fischofer@linaro.org
State New
Headers show

Commit Message

Bill Fischofer Feb. 23, 2015, 5:18 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:38 p.m. UTC | #1
On 23 February 2015 at 12:18, 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>
> ---
>  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..f2cad7c 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. This routine aborts
> + * if the create is unsuccessful.
>

warnings about a fn calling abort should be an actual doxygen @warning,
because that exceptional path is not strictly a return case

Maybe:
@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
>
Bill Fischofer Feb. 23, 2015, 5:39 p.m. UTC | #2
OK.  Will send a v2 with that shortly.

On Mon, Feb 23, 2015 at 11:38 AM, Mike Holmes <mike.holmes@linaro.org>
wrote:

>
>
> On 23 February 2015 at 12:18, 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>
>> ---
>>  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..f2cad7c 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. This routine aborts
>> + * if the create is unsuccessful.
>>
>
> warnings about a fn calling abort should be an actual doxygen @warning,
> because that exceptional path is not strictly a return case
>
> Maybe:
> @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
>>
>
>
>
> --
> *Mike Holmes*
> Linaro  Sr Technical Manager
> LNG - ODP
>
diff mbox

Patch

diff --git a/example/generator/odp_generator.c b/example/generator/odp_generator.c
index db9e0c2..f2cad7c 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. 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;