diff mbox series

[API-NEXT,v1,6/6] api: pktio: clean up doxygen tags

Message ID 1510844412-21931-7-git-send-email-odpbot@yandex.ru
State New
Headers show
Series [API-NEXT,v1,1/6] api: pktio: add max frame length | expand

Commit Message

Github ODP bot Nov. 16, 2017, 3 p.m. UTC 
From: Petri Savolainen <petri.savolainen@linaro.org>


Remove [in] from @param tags as by default parameters
are input only.

Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>

---
/** Email created from pull request 298 (psavol:next-frame-len)
 ** https://github.com/Linaro/odp/pull/298
 ** Patch: https://github.com/Linaro/odp/pull/298.patch
 ** Base sha: d4b364849c4abb4c71e0c5260e1a793ebb8dc97d
 ** Merge commit sha: f65f2a6ea63917fca4366f41eeac436d31acec9f
 **/
 include/odp/api/spec/packet_io.h | 48 +++++++++++++++++++---------------------
 1 file changed, 23 insertions(+), 25 deletions(-)
diff mbox series

Patch

diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h
index a9a39a641..60d13043d 100644
--- a/include/odp/api/spec/packet_io.h
+++ b/include/odp/api/spec/packet_io.h
@@ -954,8 +954,8 @@  uint32_t ODP_DEPRECATE(odp_pktio_mtu)(odp_pktio_t pktio);
 /**
  * Enable/Disable promiscuous mode on a packet IO interface.
  *
- * @param[in] pktio	Packet IO handle.
- * @param[in] enable	1 to enable, 0 to disable.
+ * @param pktio   Packet IO handle.
+ * @param enable  1 to enable, 0 to disable.
  *
  * @retval 0 on success
  * @retval <0 on failure
@@ -965,7 +965,7 @@  int odp_pktio_promisc_mode_set(odp_pktio_t pktio, odp_bool_t enable);
 /**
  * Determine if promiscuous mode is enabled for a packet IO interface.
  *
- * @param[in] pktio Packet IO handle.
+ * @param pktio  Packet IO handle.
  *
  * @retval  1 if promiscuous mode is enabled.
  * @retval  0 if promiscuous mode is disabled.
@@ -1034,14 +1034,13 @@  int odp_pktio_mac_addr_set(odp_pktio_t pktio, const void *mac_addr,
 /**
  * Setup per-port default class-of-service.
  *
- * @param[in]	pktio		Ingress port pktio handle.
- * @param[in]	default_cos	Class-of-service set to all packets arriving
- *				at this ingress port,
- *				unless overridden by subsequent
- *				header-based filters.
+ * @param pktio        Ingress port pktio handle.
+ * @param default_cos  Class-of-service set to all packets arriving at this
+ *                     ingress port, unless overridden by subsequent
+ *                     header-based filters.
  *
- * @retval			0 on success
- * @retval			<0 on failure
+ * @retval  0 on success
+ * @retval <0 on failure
  *
  * @note The default_cos has to be unique per odp_pktio_t instance.
  */
@@ -1050,12 +1049,12 @@  int odp_pktio_default_cos_set(odp_pktio_t pktio, odp_cos_t default_cos);
 /**
  * Setup per-port error class-of-service
  *
- * @param[in]	pktio		Ingress port pktio handle.
- * @param[in]	error_cos	class-of-service set to all packets arriving
- *				at this ingress port that contain an error.
+ * @param pktio      Ingress port pktio handle.
+ * @param error_cos  class-of-service set to all packets arriving at this
+ *                   ingress port that contain an error.
  *
- * @retval			0 on success
- * @retval			<0 on failure
+ * @retval  0 on success
+ * @retval <0 on failure
  *
  * @note Optional.
  */
@@ -1064,24 +1063,23 @@  int odp_pktio_error_cos_set(odp_pktio_t pktio, odp_cos_t error_cos);
 /**
  * Setup per-port header offset
  *
- * @param[in]	pktio		Ingress port pktio handle.
- * @param[in]	offset		Number of bytes the classifier must skip.
+ * @param pktio      Ingress port pktio handle.
+ * @param offset     Number of bytes the classifier must skip.
  *
- * @retval			0 on success
- * @retval			<0 on failure
- * @note  Optional.
+ * @retval  0 on success
+ * @retval <0 on failure
  *
+ * @note Optional.
  */
 int odp_pktio_skip_set(odp_pktio_t pktio, uint32_t offset);
 
 /**
  * Specify per-port buffer headroom
  *
- * @param[in]	pktio		Ingress port pktio handle.
- * @param[in]	headroom	Number of bytes of space preceding
- *				packet data to reserve for use as headroom.
- *				Must not exceed the implementation
- *				defined ODP_PACKET_MAX_HEADROOM.
+ * @param pktio     Ingress port pktio handle.
+ * @param headroom  Number of bytes of space preceding packet data to reserve
+ *                  for use as headroom. Must not exceed the implementation
+ *                  defined ODP_PACKET_MAX_HEADROOM.
  *
  * @retval			0 on success
  * @retval			<0 on failure