diff mbox

Correct todo for doxygen

Message ID 1395286082-13057-1-git-send-email-mike.holmes@linaro.org
State Rejected, archived
Headers show

Commit Message

Mike Holmes March 20, 2014, 3:28 a.m. UTC 
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 platform/linux-generic/source/odp_packet_netmap.c | 2 +-
 platform/linux-generic/source/odp_schedule.c      | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Petri Savolainen March 20, 2014, 7:51 a.m. UTC | #1 
On Thursday, 20 March 2014 05:28:02 UTC+2, Mike Holmes wrote:

> Signed-off-by: Mike Holmes <mike....@linaro.org <javascript:>> 
> --- 
>  platform/linux-generic/source/odp_packet_netmap.c | 2 +- 
>  platform/linux-generic/source/odp_schedule.c      | 6 +++--- 
>  2 files changed, 4 insertions(+), 4 deletions(-) 
>
> diff --git a/platform/linux-generic/source/odp_packet_netmap.c 
> b/platform/linux-generic/source/odp_packet_netmap.c 
> index 1cbd84c..9a0cf83 100644 
> --- a/platform/linux-generic/source/odp_packet_netmap.c 
> +++ b/platform/linux-generic/source/odp_packet_netmap.c 
> @@ -110,7 +110,7 @@ int setup_pkt_netmap(pkt_netmap_t * const pkt_nm, char 
> *netdev, 
>          uint8_t *pkt_buf; 
>          int wait_link = 2; 
>          uint16_t ringid; 
> -        int promisc = 1; /* TODO: maybe this should be exported to the 
> user */ 
> +        int promisc = 1; /** \todo maybe this should be exported to the 
> user */ 
>

@todo ...
 

>          uint8_t *l2_hdr; 
>          int ret; 
>   
> diff --git a/platform/linux-generic/source/odp_schedule.c 
> b/platform/linux-generic/source/odp_schedule.c 
> index c3e071a..f3818d1 100644 
> --- a/platform/linux-generic/source/odp_schedule.c 
> +++ b/platform/linux-generic/source/odp_schedule.c 
> @@ -27,7 +27,7 @@ 
>  /* Scheduler sub queues */ 
>  #define QUEUES_PER_PRIO  4 
>   
> -/* TODO: random or queue based selection */ 
> +/** \todo random or queue based selection */ 
>

@todo ...
 

>  #define SEL_PRI_QUEUE(x) ((QUEUES_PER_PRIO-1) & (queue_to_id(x))) 
>   
>  /* Maximum number of dequeues */ 
> @@ -223,10 +223,10 @@ static inline int copy_bufs(odp_buffer_t out_buf[], 
> unsigned int max) 
>          return i; 
>  } 
>   
> -/* 
> +/** 
>   * Schedule queues 
>   * 
> - * TODO: SYNC_ORDERED not implemented yet 
> + * \todo SYNC_ORDERED not implemented yet 
>

@todo ...
 

>   */ 
>  static int schedule(odp_queue_t *out_queue, odp_buffer_t out_buf[], 
>                      unsigned int max_num) 
> -- 
> 1.9.1 
>
>
Mike Holmes March 20, 2014, 5:50 p.m. UTC | #2 
Will resend


On 20 March 2014 03:51, Petri Savolainen <petri.savolainen@linaro.org>wrote:

>
>
> On Thursday, 20 March 2014 05:28:02 UTC+2, Mike Holmes wrote:
>
>> Signed-off-by: Mike Holmes <mike....@linaro.org>
>> ---
>>  platform/linux-generic/source/odp_packet_netmap.c | 2 +-
>>  platform/linux-generic/source/odp_schedule.c      | 6 +++---
>>  2 files changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/platform/linux-generic/source/odp_packet_netmap.c
>> b/platform/linux-generic/source/odp_packet_netmap.c
>> index 1cbd84c..9a0cf83 100644
>> --- a/platform/linux-generic/source/odp_packet_netmap.c
>> +++ b/platform/linux-generic/source/odp_packet_netmap.c
>> @@ -110,7 +110,7 @@ int setup_pkt_netmap(pkt_netmap_t * const pkt_nm,
>> char *netdev,
>>          uint8_t *pkt_buf;
>>          int wait_link = 2;
>>          uint16_t ringid;
>> -        int promisc = 1; /* TODO: maybe this should be exported to the
>> user */
>> +        int promisc = 1; /** \todo maybe this should be exported to the
>> user */
>>
>
> @todo ...
>
>
>>          uint8_t *l2_hdr;
>>          int ret;
>>
>> diff --git a/platform/linux-generic/source/odp_schedule.c
>> b/platform/linux-generic/source/odp_schedule.c
>> index c3e071a..f3818d1 100644
>> --- a/platform/linux-generic/source/odp_schedule.c
>> +++ b/platform/linux-generic/source/odp_schedule.c
>> @@ -27,7 +27,7 @@
>>  /* Scheduler sub queues */
>>  #define QUEUES_PER_PRIO  4
>>
>> -/* TODO: random or queue based selection */
>> +/** \todo random or queue based selection */
>>
>
> @todo ...
>
>
>>  #define SEL_PRI_QUEUE(x) ((QUEUES_PER_PRIO-1) & (queue_to_id(x)))
>>
>>  /* Maximum number of dequeues */
>> @@ -223,10 +223,10 @@ static inline int copy_bufs(odp_buffer_t out_buf[],
>> unsigned int max)
>>          return i;
>>  }
>>
>> -/*
>> +/**
>>   * Schedule queues
>>   *
>> - * TODO: SYNC_ORDERED not implemented yet
>> + * \todo SYNC_ORDERED not implemented yet
>>
>
> @todo ...
>
>
>>   */
>>  static int schedule(odp_queue_t *out_queue, odp_buffer_t out_buf[],
>>                      unsigned int max_num)
>> --
>> 1.9.1
>>
>>
Maxim Uvarov March 21, 2014, 12:42 p.m. UTC | #3 
looks like the same question for first 2 patches. So should it be \todo 
or @todo?

Maxim.

On 03/20/2014 11:51 AM, Petri Savolainen wrote:
>
>
> On Thursday, 20 March 2014 05:28:02 UTC+2, Mike Holmes wrote:
>
>     Signed-off-by: Mike Holmes <mike....@linaro.org <javascript:>>
>     ---
>      platform/linux-generic/source/odp_packet_netmap.c | 2 +-
>      platform/linux-generic/source/odp_schedule.c      | 6 +++---
>      2 files changed, 4 insertions(+), 4 deletions(-)
>
>     diff --git a/platform/linux-generic/source/odp_packet_netmap.c
>     b/platform/linux-generic/source/odp_packet_netmap.c
>     index 1cbd84c..9a0cf83 100644
>     --- a/platform/linux-generic/source/odp_packet_netmap.c
>     +++ b/platform/linux-generic/source/odp_packet_netmap.c
>     @@ -110,7 +110,7 @@ int setup_pkt_netmap(pkt_netmap_t * const
>     pkt_nm, char *netdev,
>              uint8_t *pkt_buf;
>              int wait_link = 2;
>              uint16_t ringid;
>     -        int promisc = 1; /* TODO: maybe this should be exported
>     to the user */
>     +        int promisc = 1; /** \todo maybe this should be exported
>     to the user */
>
>
> @todo ...
>
>              uint8_t *l2_hdr;
>              int ret;
>
>     diff --git a/platform/linux-generic/source/odp_schedule.c
>     b/platform/linux-generic/source/odp_schedule.c
>     index c3e071a..f3818d1 100644
>     --- a/platform/linux-generic/source/odp_schedule.c
>     +++ b/platform/linux-generic/source/odp_schedule.c
>     @@ -27,7 +27,7 @@
>      /* Scheduler sub queues */
>      #define QUEUES_PER_PRIO  4
>
>     -/* TODO: random or queue based selection */
>     +/** \todo random or queue based selection */
>
>
> @todo ...
>
>      #define SEL_PRI_QUEUE(x) ((QUEUES_PER_PRIO-1) & (queue_to_id(x)))
>
>      /* Maximum number of dequeues */
>     @@ -223,10 +223,10 @@ static inline int copy_bufs(odp_buffer_t
>     out_buf[], unsigned int max)
>              return i;
>      }
>
>     -/*
>     +/**
>       * Schedule queues
>       *
>     - * TODO: SYNC_ORDERED not implemented yet
>     + * \todo SYNC_ORDERED not implemented yet
>
>
> @todo ...
>
>       */
>      static int schedule(odp_queue_t *out_queue, odp_buffer_t out_buf[],
>                          unsigned int max_num)
>     -- 
>     1.9.1
>
> -- 
> You received this message because you are subscribed to the Google 
> Groups "LNG ODP Sub-team - lng-odp@linaro.org" group.
> To unsubscribe from this group and stop receiving emails from it, send 
> an email to lng-odp+unsubscribe@linaro.org 
> <mailto:lng-odp+unsubscribe@linaro.org>.
> To post to this group, send email to lng-odp@linaro.org 
> <mailto:lng-odp@linaro.org>.
> Visit this group at http://groups.google.com/a/linaro.org/group/lng-odp/.
> To view this discussion on the web visit 
> https://groups.google.com/a/linaro.org/d/msgid/lng-odp/537d3061-956d-4395-a2f9-cca39e3a15f7%40linaro.org 
> <https://groups.google.com/a/linaro.org/d/msgid/lng-odp/537d3061-956d-4395-a2f9-cca39e3a15f7%40linaro.org?utm_medium=email&utm_source=footer>.
> For more options, visit https://groups.google.com/a/linaro.org/d/optout.
Mike Holmes March 21, 2014, 3:13 p.m. UTC | #4 
We are going to standardize on @


On 21 March 2014 08:42, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> looks like the same question for first 2 patches. So should it be \todo or
> @todo?
>
> Maxim.
>
>
> On 03/20/2014 11:51 AM, Petri Savolainen wrote:
>
>>
>>
>> On Thursday, 20 March 2014 05:28:02 UTC+2, Mike Holmes wrote:
>>
>>     Signed-off-by: Mike Holmes <mike....@linaro.org <javascript:>>
>>
>>     ---
>>      platform/linux-generic/source/odp_packet_netmap.c | 2 +-
>>      platform/linux-generic/source/odp_schedule.c      | 6 +++---
>>      2 files changed, 4 insertions(+), 4 deletions(-)
>>
>>     diff --git a/platform/linux-generic/source/odp_packet_netmap.c
>>     b/platform/linux-generic/source/odp_packet_netmap.c
>>     index 1cbd84c..9a0cf83 100644
>>     --- a/platform/linux-generic/source/odp_packet_netmap.c
>>     +++ b/platform/linux-generic/source/odp_packet_netmap.c
>>     @@ -110,7 +110,7 @@ int setup_pkt_netmap(pkt_netmap_t * const
>>     pkt_nm, char *netdev,
>>              uint8_t *pkt_buf;
>>              int wait_link = 2;
>>              uint16_t ringid;
>>     -        int promisc = 1; /* TODO: maybe this should be exported
>>     to the user */
>>     +        int promisc = 1; /** \todo maybe this should be exported
>>     to the user */
>>
>>
>> @todo ...
>>
>>              uint8_t *l2_hdr;
>>              int ret;
>>
>>     diff --git a/platform/linux-generic/source/odp_schedule.c
>>     b/platform/linux-generic/source/odp_schedule.c
>>     index c3e071a..f3818d1 100644
>>     --- a/platform/linux-generic/source/odp_schedule.c
>>     +++ b/platform/linux-generic/source/odp_schedule.c
>>     @@ -27,7 +27,7 @@
>>      /* Scheduler sub queues */
>>      #define QUEUES_PER_PRIO  4
>>
>>     -/* TODO: random or queue based selection */
>>     +/** \todo random or queue based selection */
>>
>>
>> @todo ...
>>
>>      #define SEL_PRI_QUEUE(x) ((QUEUES_PER_PRIO-1) & (queue_to_id(x)))
>>
>>      /* Maximum number of dequeues */
>>     @@ -223,10 +223,10 @@ static inline int copy_bufs(odp_buffer_t
>>     out_buf[], unsigned int max)
>>              return i;
>>      }
>>
>>     -/*
>>     +/**
>>       * Schedule queues
>>       *
>>     - * TODO: SYNC_ORDERED not implemented yet
>>     + * \todo SYNC_ORDERED not implemented yet
>>
>>
>> @todo ...
>>
>>       */
>>      static int schedule(odp_queue_t *out_queue, odp_buffer_t out_buf[],
>>                          unsigned int max_num)
>>     --     1.9.1
>>
>> --
>> You received this message because you are subscribed to the Google Groups
>> "LNG ODP Sub-team - lng-odp@linaro.org" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to lng-odp+unsubscribe@linaro.org <mailto:lng-odp+unsubscribe@
>> linaro.org>.
>> To post to this group, send email to lng-odp@linaro.org <mailto:
>> lng-odp@linaro.org>.
>> Visit this group at http://groups.google.com/a/linaro.org/group/lng-odp/.
>> To view this discussion on the web visit https://groups.google.com/a/
>> linaro.org/d/msgid/lng-odp/537d3061-956d-4395-a2f9-
>> cca39e3a15f7%40linaro.org <https://groups.google.com/a/
>> linaro.org/d/msgid/lng-odp/537d3061-956d-4395-a2f9-
>> cca39e3a15f7%40linaro.org?utm_medium=email&utm_source=footer>.
>> For more options, visit https://groups.google.com/a/linaro.org/d/optout.
>>
>
> --
> You received this message because you are subscribed to the Google Groups
> "LNG ODP Sub-team - lng-odp@linaro.org" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to lng-odp+unsubscribe@linaro.org.
> To post to this group, send email to lng-odp@linaro.org.
> Visit this group at http://groups.google.com/a/linaro.org/group/lng-odp/.
> To view this discussion on the web visit https://groups.google.com/a/
> linaro.org/d/msgid/lng-odp/532C33CC.40007%40linaro.org.
> For more options, visit https://groups.google.com/a/linaro.org/d/optout.
>
diff mbox

Patch

diff --git a/platform/linux-generic/source/odp_packet_netmap.c b/platform/linux-generic/source/odp_packet_netmap.c
index 1cbd84c..9a0cf83 100644
--- a/platform/linux-generic/source/odp_packet_netmap.c
+++ b/platform/linux-generic/source/odp_packet_netmap.c
@@ -110,7 +110,7 @@  int setup_pkt_netmap(pkt_netmap_t * const pkt_nm, char *netdev,
 	uint8_t *pkt_buf;
 	int wait_link = 2;
 	uint16_t ringid;
-	int promisc = 1; /* TODO: maybe this should be exported to the user */
+	int promisc = 1; /** \todo maybe this should be exported to the user */
 	uint8_t *l2_hdr;
 	int ret;
 
diff --git a/platform/linux-generic/source/odp_schedule.c b/platform/linux-generic/source/odp_schedule.c
index c3e071a..f3818d1 100644
--- a/platform/linux-generic/source/odp_schedule.c
+++ b/platform/linux-generic/source/odp_schedule.c
@@ -27,7 +27,7 @@ 
 /* Scheduler sub queues */
 #define QUEUES_PER_PRIO  4
 
-/* TODO: random or queue based selection */
+/** \todo random or queue based selection */
 #define SEL_PRI_QUEUE(x) ((QUEUES_PER_PRIO-1) & (queue_to_id(x)))
 
 /* Maximum number of dequeues */
@@ -223,10 +223,10 @@  static inline int copy_bufs(odp_buffer_t out_buf[], unsigned int max)
 	return i;
 }
 
-/*
+/**
  * Schedule queues
  *
- * TODO: SYNC_ORDERED not implemented yet
+ * \todo SYNC_ORDERED not implemented yet
  */
 static int schedule(odp_queue_t *out_queue, odp_buffer_t out_buf[],
 		    unsigned int max_num)