Changeset 1bfd3d3 in mainline for uspace/lib/c/generic/net/packet.c

Timestamp:

2010-11-19T22:02:09Z (13 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

973ef9fc, a9c6b966

Parents:

cc3c2a1c

Message:

Replace @returns with @return.

File:

• uspace/lib/c/generic/net/packet.c (modified) (11 diffs)

uspace/lib/c/generic/net/packet.c

@@ -82 +82 @@
 /** Initializes the packet map.
  *
- * @returns             EOK on success.
- * @returns             ENOMEM if there is not enough memory left.
+ * @return              EOK on success.
+ * @return              ENOMEM if there is not enough memory left.
  */
 int pm_init(void)
@@ -101 +101 @@
  *
  * @param[in] packet_id The packet identifier to be found.
- * @returns             The found packet reference.
- * @returns             NULL if the mapping does not exist.
+ * @return              The found packet reference.
+ * @return              NULL if the mapping does not exist.
  */
 packet_t pm_find(packet_id_t packet_id)
@@ -130 +130 @@
  *
  * @param[in] packet    The packet to be remembered.
- * @returns             EOK on success.
- * @returns             EINVAL if the packet is not valid.
- * @returns             EINVAL if the packet map is not initialized.
- * @returns             ENOMEM if there is not enough memory left.
+ * @return              EOK on success.
+ * @return              EINVAL if the packet is not valid.
+ * @return              EINVAL if the packet map is not initialized.
+ * @return              ENOMEM if there is not enough memory left.
  */
 int pm_add(packet_t packet)
@@ -205 +205 @@
  * @param[in] order     The packet order value.
  * @param[in] metric    The metric value of the packet.
- * @returns             EOK on success.
- * @returns             EINVAL if the first parameter is NULL.
- * @returns             EINVAL if the packet is not valid.
+ * @return              EOK on success.
+ * @return              EINVAL if the first parameter is NULL.
+ * @return              EINVAL if the packet is not valid.
  */
 int pq_add(packet_t * first, packet_t packet, size_t order, size_t metric)
@@ -249 +249 @@
  * @param[in] first     The first packet of the queue.
  * @param[in] order     The packet order value.
- * @returns             The packet with the given order.
- * @returns             NULL if the first packet is not valid.
- * @returns             NULL if the packet is not found.
+ * @return              The packet with the given order.
+ * @return              NULL if the first packet is not valid.
+ * @return              NULL if the packet is not found.
  */
 packet_t pq_find(packet_t packet, size_t order)
@@ -275 +275 @@
  * @param[in] packet    The packet in the queue.
  * @param[in] new_packet The new packet to be inserted.
- * @returns             EOK on success.
- * @returns             EINVAL if etiher of the packets is invalid.
+ * @return              EOK on success.
+ * @return              EINVAL if etiher of the packets is invalid.
  */
 int pq_insert_after(packet_t packet, packet_t new_packet)
@@ -298 +298 @@
  *
  * @param[in] packet    The packet to be detached.
- * @returns             The next packet in the queue. If the packet is the first
+ * @return              The next packet in the queue. If the packet is the first
  *                      one of the queue, this becomes the new first one.
- * @returns             NULL if there is no packet left.
- * @returns             NULL if the packet is not valid.
+ * @return              NULL if there is no packet left.
+ * @return              NULL if the packet is not valid.
  */
 packet_t pq_detach(packet_t packet)
@@ -328 +328 @@
  * @param[in] order     The packet order value.
  * @param[in] metric    The metric value of the packet.
- * @returns             EOK on success.
- * @returns             EINVAL if the packet is invalid.
+ * @return              EOK on success.
+ * @return              EINVAL if the packet is invalid.
  */
 int pq_set_order(packet_t packet, size_t order, size_t metric)
@@ -346 +346 @@
  * @param[out] order    The packet order value.
  * @param[out] metric   The metric value of the packet.
- * @returns             EOK on success.
- * @returns             EINVAL if the packet is invalid.
+ * @return              EOK on success.
+ * @return              EINVAL if the packet is invalid.
  */
 int pq_get_order(packet_t packet, size_t *order, size_t *metric)
@@ -391 +391 @@
  *
  * @param[in] packet    The packet queue member.
- * @returns             The next packet in the queue.
- * @returns             NULL if there is no next packet.
- * @returns             NULL if the packet is not valid.
+ * @return              The next packet in the queue.
+ * @return              NULL if there is no next packet.
+ * @return              NULL if the packet is not valid.
  */
 packet_t pq_next(packet_t packet)
@@ -406 +406 @@
  *
  * @param[in] packet    The packet queue member.
- * @returns             The previous packet in the queue.
- * @returns             NULL if there is no previous packet.
- * @returns             NULL if the packet is not valid.
+ * @return              The previous packet in the queue.
+ * @return              NULL if there is no previous packet.
+ * @return              NULL if the packet is not valid.
  */
 packet_t pq_previous(packet_t packet)