Changes in uspace/srv/net/tl/icmp/icmp.c [1bfd3d3:4eca056] in mainline

File:

• uspace/srv/net/tl/icmp/icmp.c (modified) (14 diffs)

uspace/srv/net/tl/icmp/icmp.c

@@ -100 +100 @@
  * @param[in,out] header The ICMP datagram header.
  * @param[in] length    The total datagram length.
- * @return              The computed checksum.
+ * @returns             The computed checksum.
  */
 #define ICMP_CHECKSUM(header, length) \
@@ -112 +112 @@
  * @param[in] id        The message identifier.
  * @param[in] sequence  The message sequence number.
- * @return              The computed ICMP reply data key.
+ * @returns             The computed ICMP reply data key.
  */
 #define ICMP_GET_REPLY_KEY(id, sequence) \
@@ -128 +128 @@
  * @param[in] packet    The packet queue to be released.
  * @param[in] result    The result to be returned.
- * @return              The result parameter.
+ * @returns             The result parameter.
  */
 static int icmp_release_and_return(packet_t packet, int result)
@@ -152 +152 @@
  * @param[in] dont_fragment The value indicating whether the datagram must not
  *                      be fragmented. Is used as a MTU discovery.
- * @return              EOK on success.
- * @return              EPERM if the error message is not allowed.
+ * @returns             EOK on success.
+ * @returns             EPERM if the error message is not allowed.
  */
 static int icmp_send_packet(icmp_type_t type, icmp_code_t code, packet_t packet,
@@ -186 +186 @@
  *
  * @param[in,out] packet The original packet.
- * @return The prefixed ICMP header.
- * @return NULL on errors.
+ * @returns The prefixed ICMP header.
+ * @returns NULL on errors.
  */
 static icmp_header_t *icmp_prepare_packet(packet_t packet)
@@ -234 +234 @@
  * @param[in] addr      The target host address.
  * @param[in] addrlen   The torget host address length.
- * @return              ICMP_ECHO on success.
- * @return              ETIMEOUT if the reply has not arrived before the
+ * @returns             ICMP_ECHO on success.
+ * @returns             ETIMEOUT if the reply has not arrived before the
  *                      timeout.
- * @return              ICMP type of the received error notification.
- * @return              EINVAL if the addrlen parameter is less or equal to
+ * @returns             ICMP type of the received error notification.
+ * @returns             EINVAL if the addrlen parameter is less or equal to
  *                      zero.
- * @return              ENOMEM if there is not enough memory left.
- * @return              EPARTY if there was an internal error.
+ * @returns             ENOMEM if there is not enough memory left.
+ * @returns             EPARTY if there was an internal error.
  */
 static int icmp_echo(icmp_param_t id, icmp_param_t sequence, size_t size,
@@ -398 +398 @@
  * @param[in] client_connection The client connection processing function. The
  *                      module skeleton propagates its own one.
- * @return              EOK on success.
- * @return              ENOMEM if there is not enough memory left.
+ * @returns             EOK on success.
+ * @returns             ENOMEM if there is not enough memory left.
  */
 int icmp_initialize(async_client_conn_t client_connection)
@@ -507 +507 @@
  * @param[in] error     The packet error reporting service. Prefixes the
  *                      received packet.
- * @return              EOK on success.
- * @return              EINVAL if the packet is not valid.
- * @return              EINVAL if the stored packet address is not the an_addr_t.
- * @return              EINVAL if the packet does not contain any data.
- * @return              NO_DATA if the packet content is shorter than the user
+ * @returns             EOK on success.
+ * @returns             EINVAL if the packet is not valid.
+ * @returns             EINVAL if the stored packet address is not the an_addr_t.
+ * @returns             EINVAL if the packet does not contain any data.
+ * @returns             NO_DATA if the packet content is shorter than the user
  *                      datagram header.
- * @return              ENOMEM if there is not enough memory left.
- * @return              EADDRNOTAVAIL if the destination socket does not exist.
- * @return              Other error codes as defined for the
+ * @returns             ENOMEM if there is not enough memory left.
+ * @returns             EADDRNOTAVAIL if the destination socket does not exist.
+ * @returns             Other error codes as defined for the
  *                      ip_client_process_packet() function.
  */
@@ -654 +654 @@
  * @param[in] error     The packet error reporting service. Prefixes the
  *                      received packet.
- * @return              EOK on success.
- * @return              Other error codes as defined for the
+ * @returns             EOK on success.
+ * @returns             Other error codes as defined for the
  *                      icmp_process_packet() function.
  */
@@ -673 +673 @@
  *
  * @param[in] call      The message parameters.
- * @return              EOK on success.
- * @return              ENOTSUP if the message is not known.
- * @return              Other error codes as defined for the packet_translate()
+ * @returns             EOK on success.
+ * @returns             ENOTSUP if the message is not known.
+ * @returns             Other error codes as defined for the packet_translate()
  *                      function.
- * @return              Other error codes as defined for the
+ * @returns             Other error codes as defined for the
  *                      icmp_destination_unreachable_msg_local() function.
- * @return              Other error codes as defined for the
+ * @returns             Other error codes as defined for the
  *                      icmp_source_quench_msg_local() function.
- * @return              Other error codes as defined for the
+ * @returns             Other error codes as defined for the
  *                      icmp_time_exceeded_msg_local() function.
- * @return              Other error codes as defined for the
+ * @returns             Other error codes as defined for the
  *                      icmp_parameter_problem_msg_local() function.
  *
@@ -731 +731 @@
  *
  * @param[in,out] echo_data The echo data to be bound.
- * @return              Index of the inserted echo data.
- * @return              EBADMEM if the echo_data parameter is NULL.
- * @return              ENOTCONN if no free identifier have been found.
+ * @returns             Index of the inserted echo data.
+ * @returns             EBADMEM if the echo_data parameter is NULL.
+ * @returns             ENOTCONN if no free identifier have been found.
  */
 static int icmp_bind_free_id(icmp_echo_t *echo_data)
@@ -778 +778 @@
  * @param[in] callid    The message identifier.
  * @param[in] call      The message parameters.
- * @return EOK.
+ * @returns EOK.
  *
  * @see icmp_interface.h
@@ -887 +887 @@
  * @param[out] answer_count The last parameter for the actual answer in the
  *                      answer parameter.
- * @return              EOK on success.
- * @return              ENOTSUP if the message is not known.
+ * @returns             EOK on success.
+ * @returns             ENOTSUP if the message is not known.
  *
  * @see icmp_interface.h
@@ -964 +964 @@
 /** Starts the module.
  *
- * @return              EOK on success.
- * @return              Other error codes as defined for each specific module
+ * @returns             EOK on success.
+ * @returns             Other error codes as defined for each specific module
  *                      start function.
  */