diff mbox

[ODP] Doxygen error correction

Message ID 1413870106-20049-1-git-send-email-bala.manoharan@linaro.org
State Superseded
Headers show

Commit Message

Balasubramanian Manoharan Oct. 21, 2014, 5:41 a.m. UTC
Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org>
---
This patch corrects the errors in classification header file
pointed out by doxygen tool

 platform/linux-generic/include/api/odp_classification.h | 14 +++++++++-----
 platform/linux-generic/odp_classification.c             |  3 ++-
 2 files changed, 11 insertions(+), 6 deletions(-)

Comments

Bill Fischofer Oct. 21, 2014, 12:26 p.m. UTC | #1
On Tue, Oct 21, 2014 at 12:41 AM, Balasubramanian Manoharan <
bala.manoharan@linaro.org> wrote:

> Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org>
>
    Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>

> ---
> This patch corrects the errors in classification header file
> pointed out by doxygen tool
>
>  platform/linux-generic/include/api/odp_classification.h | 14
> +++++++++-----
>  platform/linux-generic/odp_classification.c             |  3 ++-
>  2 files changed, 11 insertions(+), 6 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_classification.h
> b/platform/linux-generic/include/api/odp_classification.h
> index 99b94e9..0c24cd5 100644
> --- a/platform/linux-generic/include/api/odp_classification.h
> +++ b/platform/linux-generic/include/api/odp_classification.h
> @@ -195,7 +195,7 @@ int odp_pktio_set_skip(odp_pktio_t pktio_in, size_t
> offset);
>   *
>   * @note Optional.
>   */
> -int odp_pktio_set_headroom(odp_pktio_t port_id, size_t headroom);
> +int odp_pktio_set_headroom(odp_pktio_t pktio_in, size_t headroom);
>
>  /**
>   * Specify per-cos buffer headroom
> @@ -210,7 +210,7 @@ int odp_pktio_set_headroom(odp_pktio_t port_id, size_t
> headroom);
>   *
>   * @note Optional.
>   */
> -int odp_cos_set_headroom(odp_cos_t cos_id, size_t req_room);
> +int odp_cos_set_headroom(odp_cos_t cos_id, size_t headroom);
>
>  /**
>   * Request to override per-port class of service
> @@ -315,10 +315,14 @@ odp_cos_port_flow_signature(odp_pktio_t pktio_in,
>   * PMR - Packet Matching Rule
>   * Up to 32 bit of ternary matching of one of the available header fields
>   */
> -#define    ODP_PMR_INVAL ((odp_pmr_t)NULL)
>  typedef uint32_t odp_pmr_t;
>
>  /**
> + * Macro for Invalid PMR.
> + */
> +#define    ODP_PMR_INVAL ((odp_pmr_t)NULL)
> +
> +/**
>   * Packet Matching Rule field enumeration
>   * for fields that may be used to calculate
>   * the PMR, if present in a packet.
> @@ -462,7 +466,7 @@ typedef enum odp_pmr_match_type {
>   * appropriate fallback action.
>   */
>  typedef struct odp_pmr_match_t {
> -       odp_pmr_match_type_e match_type;
> +       odp_pmr_match_type_e match_type; /**< Packet Match Type*/
>         union {
>                 struct {
>                         odp_pmr_term_e  term;
> @@ -501,7 +505,7 @@ typedef uint32_t odp_pmr_set_t;
>   *                             or -1 for error.
>   */
>  int odp_pmr_match_set_create(int num_terms, odp_pmr_match_t *terms,
> -                            odp_pmr_set_t *pmr_set_id);
> +                            odp_cos_t dst_cos, odp_pmr_set_t *pmr_set_id);
>
>  /**
>   * Function to delete a composite packet match rule set
> diff --git a/platform/linux-generic/odp_classification.c
> b/platform/linux-generic/odp_classification.c
> index 901087c..dbc74e2 100644
> --- a/platform/linux-generic/odp_classification.c
> +++ b/platform/linux-generic/odp_classification.c
> @@ -209,11 +209,12 @@ unsigned odp_pmr_terms_avail(void)
>  }
>
>  int odp_pmr_match_set_create(int num_terms, odp_pmr_match_t *terms,
> -                            odp_pmr_set_t *pmr_set_id)
> +                            odp_cos_t dst_cos, odp_pmr_set_t *pmr_set_id)
>  {
>         (void)num_terms;
>         (void)terms;
>         (void)pmr_set_id;
> +       (void)dst_cos;
>         ODP_UNIMPLEMENTED();
>         return 0;
>  }
> --
> 2.0.1.472.g6f92e5f
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_classification.h b/platform/linux-generic/include/api/odp_classification.h
index 99b94e9..0c24cd5 100644
--- a/platform/linux-generic/include/api/odp_classification.h
+++ b/platform/linux-generic/include/api/odp_classification.h
@@ -195,7 +195,7 @@  int odp_pktio_set_skip(odp_pktio_t pktio_in, size_t offset);
  *
  * @note Optional.
  */
-int odp_pktio_set_headroom(odp_pktio_t port_id, size_t headroom);
+int odp_pktio_set_headroom(odp_pktio_t pktio_in, size_t headroom);
 
 /**
  * Specify per-cos buffer headroom
@@ -210,7 +210,7 @@  int odp_pktio_set_headroom(odp_pktio_t port_id, size_t headroom);
  *
  * @note Optional.
  */
-int odp_cos_set_headroom(odp_cos_t cos_id, size_t req_room);
+int odp_cos_set_headroom(odp_cos_t cos_id, size_t headroom);
 
 /**
  * Request to override per-port class of service
@@ -315,10 +315,14 @@  odp_cos_port_flow_signature(odp_pktio_t pktio_in,
  * PMR - Packet Matching Rule
  * Up to 32 bit of ternary matching of one of the available header fields
  */
-#define    ODP_PMR_INVAL ((odp_pmr_t)NULL)
 typedef uint32_t odp_pmr_t;
 
 /**
+ * Macro for Invalid PMR.
+ */
+#define    ODP_PMR_INVAL ((odp_pmr_t)NULL)
+
+/**
  * Packet Matching Rule field enumeration
  * for fields that may be used to calculate
  * the PMR, if present in a packet.
@@ -462,7 +466,7 @@  typedef enum odp_pmr_match_type {
  * appropriate fallback action.
  */
 typedef struct odp_pmr_match_t {
-	odp_pmr_match_type_e match_type;
+	odp_pmr_match_type_e match_type; /**< Packet Match Type*/
 	union {
 		struct {
 			odp_pmr_term_e  term;
@@ -501,7 +505,7 @@  typedef uint32_t odp_pmr_set_t;
  *				or -1 for error.
  */
 int odp_pmr_match_set_create(int num_terms, odp_pmr_match_t *terms,
-			     odp_pmr_set_t *pmr_set_id);
+			     odp_cos_t dst_cos, odp_pmr_set_t *pmr_set_id);
 
 /**
  * Function to delete a composite packet match rule set
diff --git a/platform/linux-generic/odp_classification.c b/platform/linux-generic/odp_classification.c
index 901087c..dbc74e2 100644
--- a/platform/linux-generic/odp_classification.c
+++ b/platform/linux-generic/odp_classification.c
@@ -209,11 +209,12 @@  unsigned odp_pmr_terms_avail(void)
 }
 
 int odp_pmr_match_set_create(int num_terms, odp_pmr_match_t *terms,
-			     odp_pmr_set_t *pmr_set_id)
+			     odp_cos_t dst_cos, odp_pmr_set_t *pmr_set_id)
 {
 	(void)num_terms;
 	(void)terms;
 	(void)pmr_set_id;
+	(void)dst_cos;
 	ODP_UNIMPLEMENTED();
 	return 0;
 }