Changeset 1bfd3d3 in mainline for uspace/lib/net/il

Timestamp:

2010-11-19T22:02:09Z (15 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.

Location:

uspace/lib/net/il

Files:

• arp_remote.c (modified) (6 diffs)
• ip_client.c (modified) (5 diffs)
• ip_remote.c (modified) (2 diffs)

uspace/lib/net/il/arp_remote.c

@@ -52 +52 @@
  *
  * @param service       The ARP module service. Ignored parameter.
- * @returns             The ARP module phone on success.
+ * @return              The ARP module phone on success.
  */
 int arp_connect_module(services_t service)
@@ -65 +65 @@
  *
  * @param[in] arp_phone The ARP module phone used for (semi)remote calls.
- * @returns             EOK on success.
+ * @return              EOK on success.
  */
 int arp_clean_cache_req(int arp_phone)
@@ -78 +78 @@
  * @param[in] protocol  The requesting protocol service.
  * @param[in] address   The protocol address to be cleared.
- * @returns             EOK on success.
- * @returns             ENOENT if the mapping is not found.
+ * @return              EOK on success.
+ * @return              ENOENT if the mapping is not found.
  */
 int
@@ -100 +100 @@
  * @param[in] arp_phone The ARP module phone used for (semi)remote calls.
  * @param[in] device_id The device identifier.
- * @returns             EOK on success.
- * @returns             ENOENT if the device is not found.
+ * @return              EOK on success.
+ * @return              ENOENT if the device is not found.
  */
 int arp_clear_device_req(int arp_phone, device_id_t device_id)
@@ -119 +119 @@
  * @param[in] netif     The underlying device network interface layer service.
  * @param[in] address   The local requesting protocol address of the device.
- * @returns             EOK on success.
- * @returns             EEXIST if the device is already used.
- * @returns             ENOMEM if there is not enough memory left.
- * @returns             ENOENT if the network interface service is not known.
- * @returns             EREFUSED if the network interface service is not
+ * @return              EOK on success.
+ * @return              EEXIST if the device is already used.
+ * @return              ENOMEM if there is not enough memory left.
+ * @return              ENOENT if the network interface service is not known.
+ * @return              EREFUSED if the network interface service is not
  *                      responding.
- * @returns             Other error codes as defined for the
+ * @return              Other error codes as defined for the
  *                      nil_packet_get_size() function.
- * @returns             Other error codes as defined for the nil_get_addr()
+ * @return              Other error codes as defined for the nil_get_addr()
  *                      function.
- * @returns             Other error codes as defined for the
+ * @return              Other error codes as defined for the
  *                      nil_get_broadcast_addr() function.
  */
@@ -157 +157 @@
  * @param[out] translation The translation of the local protocol address.
  * @param[out] data     The allocated raw translation data container.
- * @returns             EOK on success.
- * @returns             EINVAL if the address parameter is NULL.
- * @returns             EBADMEM if the translation or the data parameters are
+ * @return              EOK on success.
+ * @return              EINVAL if the address parameter is NULL.
+ * @return              EBADMEM if the translation or the data parameters are
  *                      NULL.
- * @returns             ENOENT if the mapping is not found.
+ * @return              ENOENT if the mapping is not found.
  */
 int

uspace/lib/net/il/ip_client.c

@@ -48 +48 @@
  *
  * @param[in] packet    The packet.
- * @returns             The IP header length in bytes.
- * @returns             Zero if there is no IP header.
+ * @return              The IP header length in bytes.
+ * @return              Zero if there is no IP header.
  */
 size_t ip_client_header_length(packet_t packet)
@@ -72 +72 @@
  * @param[out] header   The constructed IPv4 pseudo header.
  * @param[out] headerlen The length of the IP pseudo header in bytes.
- * @returns             EOK on success.
- * @returns             EBADMEM if the header and/or the headerlen parameter is
+ * @return              EOK on success.
+ * @return              EBADMEM if the header and/or the headerlen parameter is
  *                      NULL.
- * @returns             EINVAL if the source address and/or the destination
+ * @return              EINVAL if the source address and/or the destination
  *                      address parameter is NULL.
- * @returns             EINVAL if the source address length is less than struct
+ * @return              EINVAL if the source address length is less than struct
  *                      sockaddr length.
- * @returns             EINVAL if the source address length differs from the
+ * @return              EINVAL if the source address length differs from the
  *                      destination address length.
- * @returns             EINVAL if the source address family differs from the
+ * @return              EINVAL if the source address family differs from the
  *                      destination family.
- * @returns             EAFNOSUPPORT if the address family is not supported.
- * @returns             ENOMEM if there is not enough memory left.
+ * @return              EAFNOSUPPORT if the address family is not supported.
+ * @return              ENOMEM if there is not enough memory left.
  */
 int
@@ -148 +148 @@
  *                      disabled.
  * @param[in] ipopt_length The prefixed IP options length in bytes.
- * @returns             EOK on success.
- * @returns             ENOMEM if there is not enough memory left in the packet.
+ * @return              EOK on success.
+ * @return              ENOMEM if there is not enough memory left in the packet.
  */
 int
@@ -203 +203 @@
  * @param[out] ipopt_length The IP options length in bytes. May be NULL if not
  *                      desired.
- * @returns             The prefixed IP header length in bytes on success.
- * @returns             ENOMEM if the packet is too short to contain the IP
+ * @return              The prefixed IP header length in bytes on success.
+ * @return              ENOMEM if the packet is too short to contain the IP
  *                      header.
  */
@@ -238 +238 @@
  * @param[in] headerlen The length of the IP pseudo header in bytes.
  * @param[in] data_length The data length to be set.
- * @returns             EOK on success.
- * @returns             EBADMEM if the header parameter is NULL.
- * @returns             EINVAL if the headerlen parameter is not IPv4 pseudo
+ * @return              EOK on success.
+ * @return              EBADMEM if the header parameter is NULL.
+ * @return              EINVAL if the headerlen parameter is not IPv4 pseudo
  *                      header length.
  */

uspace/lib/net/il/ip_remote.c

@@ -78 +78 @@
  * @param[in] me        The requesting module service.
  * @param[in] receiver  The message receiver. Used for remote connection.
- * @returns             The phone of the needed service.
- * @returns             EOK on success.
- * @returns             Other error codes as defined for the bind_service()
+ * @return              The phone of the needed service.
+ * @return              EOK on success.
+ * @return              Other error codes as defined for the bind_service()
  *                      function.
  */
@@ -93 +93 @@
  *
  * @param service       The IP module service. Ignored parameter.
- * @returns             The IP module phone on success.
+ * @return              The IP module phone on success.
  */
 int ip_connect_module(services_t service)