Changeset 1bfd3d3 in mainline for uspace/srv/net/tl


Ignore:
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/srv/net/tl
Files:
3 edited

Legend:

Unmodified
Added
Removed

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

    rcc3c2a1c r1bfd3d3  
    100100 * @param[in,out] header The ICMP datagram header.
    101101 * @param[in] length    The total datagram length.
    102  * @returns             The computed checksum.
     102 * @return              The computed checksum.
    103103 */
    104104#define ICMP_CHECKSUM(header, length) \
    … …  
    112112 * @param[in] id        The message identifier.
    113113 * @param[in] sequence  The message sequence number.
    114  * @returns             The computed ICMP reply data key.
     114 * @return              The computed ICMP reply data key.
    115115 */
    116116#define ICMP_GET_REPLY_KEY(id, sequence) \
    … …  
    128128 * @param[in] packet    The packet queue to be released.
    129129 * @param[in] result    The result to be returned.
    130  * @returns             The result parameter.
     130 * @return              The result parameter.
    131131 */
    132132static int icmp_release_and_return(packet_t packet, int result)
    … …  
    152152 * @param[in] dont_fragment The value indicating whether the datagram must not
    153153 *                      be fragmented. Is used as a MTU discovery.
    154  * @returns             EOK on success.
    155  * @returns             EPERM if the error message is not allowed.
     154 * @return              EOK on success.
     155 * @return              EPERM if the error message is not allowed.
    156156 */
    157157static int icmp_send_packet(icmp_type_t type, icmp_code_t code, packet_t packet,
    … …  
    186186 *
    187187 * @param[in,out] packet The original packet.
    188  * @returns The prefixed ICMP header.
    189  * @returns NULL on errors.
     188 * @return The prefixed ICMP header.
     189 * @return NULL on errors.
    190190 */
    191191static icmp_header_t *icmp_prepare_packet(packet_t packet)
    … …  
    234234 * @param[in] addr      The target host address.
    235235 * @param[in] addrlen   The torget host address length.
    236  * @returns             ICMP_ECHO on success.
    237  * @returns             ETIMEOUT if the reply has not arrived before the
     236 * @return              ICMP_ECHO on success.
     237 * @return              ETIMEOUT if the reply has not arrived before the
    238238 *                      timeout.
    239  * @returns             ICMP type of the received error notification.
    240  * @returns             EINVAL if the addrlen parameter is less or equal to
     239 * @return              ICMP type of the received error notification.
     240 * @return              EINVAL if the addrlen parameter is less or equal to
    241241 *                      zero.
    242  * @returns             ENOMEM if there is not enough memory left.
    243  * @returns             EPARTY if there was an internal error.
     242 * @return              ENOMEM if there is not enough memory left.
     243 * @return              EPARTY if there was an internal error.
    244244 */
    245245static int icmp_echo(icmp_param_t id, icmp_param_t sequence, size_t size,
    … …  
    398398 * @param[in] client_connection The client connection processing function. The
    399399 *                      module skeleton propagates its own one.
    400  * @returns             EOK on success.
    401  * @returns             ENOMEM if there is not enough memory left.
     400 * @return              EOK on success.
     401 * @return              ENOMEM if there is not enough memory left.
    402402 */
    403403int icmp_initialize(async_client_conn_t client_connection)
    … …  
    507507 * @param[in] error     The packet error reporting service. Prefixes the
    508508 *                      received packet.
    509  * @returns             EOK on success.
    510  * @returns             EINVAL if the packet is not valid.
    511  * @returns             EINVAL if the stored packet address is not the an_addr_t.
    512  * @returns             EINVAL if the packet does not contain any data.
    513  * @returns             NO_DATA if the packet content is shorter than the user
     509 * @return              EOK on success.
     510 * @return              EINVAL if the packet is not valid.
     511 * @return              EINVAL if the stored packet address is not the an_addr_t.
     512 * @return              EINVAL if the packet does not contain any data.
     513 * @return              NO_DATA if the packet content is shorter than the user
    514514 *                      datagram header.
    515  * @returns             ENOMEM if there is not enough memory left.
    516  * @returns             EADDRNOTAVAIL if the destination socket does not exist.
    517  * @returns             Other error codes as defined for the
     515 * @return              ENOMEM if there is not enough memory left.
     516 * @return              EADDRNOTAVAIL if the destination socket does not exist.
     517 * @return              Other error codes as defined for the
    518518 *                      ip_client_process_packet() function.
    519519 */
    … …  
    654654 * @param[in] error     The packet error reporting service. Prefixes the
    655655 *                      received packet.
    656  * @returns             EOK on success.
    657  * @returns             Other error codes as defined for the
     656 * @return              EOK on success.
     657 * @return              Other error codes as defined for the
    658658 *                      icmp_process_packet() function.
    659659 */
    … …  
    673673 *
    674674 * @param[in] call      The message parameters.
    675  * @returns             EOK on success.
    676  * @returns             ENOTSUP if the message is not known.
    677  * @returns             Other error codes as defined for the packet_translate()
     675 * @return              EOK on success.
     676 * @return              ENOTSUP if the message is not known.
     677 * @return              Other error codes as defined for the packet_translate()
    678678 *                      function.
    679  * @returns             Other error codes as defined for the
     679 * @return              Other error codes as defined for the
    680680 *                      icmp_destination_unreachable_msg_local() function.
    681  * @returns             Other error codes as defined for the
     681 * @return              Other error codes as defined for the
    682682 *                      icmp_source_quench_msg_local() function.
    683  * @returns             Other error codes as defined for the
     683 * @return              Other error codes as defined for the
    684684 *                      icmp_time_exceeded_msg_local() function.
    685  * @returns             Other error codes as defined for the
     685 * @return              Other error codes as defined for the
    686686 *                      icmp_parameter_problem_msg_local() function.
    687687 *
    … …  
    731731 *
    732732 * @param[in,out] echo_data The echo data to be bound.
    733  * @returns             Index of the inserted echo data.
    734  * @returns             EBADMEM if the echo_data parameter is NULL.
    735  * @returns             ENOTCONN if no free identifier have been found.
     733 * @return              Index of the inserted echo data.
     734 * @return              EBADMEM if the echo_data parameter is NULL.
     735 * @return              ENOTCONN if no free identifier have been found.
    736736 */
    737737static int icmp_bind_free_id(icmp_echo_t *echo_data)
    … …  
    778778 * @param[in] callid    The message identifier.
    779779 * @param[in] call      The message parameters.
    780  * @returns EOK.
     780 * @return EOK.
    781781 *
    782782 * @see icmp_interface.h
    … …  
    887887 * @param[out] answer_count The last parameter for the actual answer in the
    888888 *                      answer parameter.
    889  * @returns             EOK on success.
    890  * @returns             ENOTSUP if the message is not known.
     889 * @return              EOK on success.
     890 * @return              ENOTSUP if the message is not known.
    891891 *
    892892 * @see icmp_interface.h
    … …  
    964964/** Starts the module.
    965965 *
    966  * @returns             EOK on success.
    967  * @returns             Other error codes as defined for each specific module
     966 * @return              EOK on success.
     967 * @return              Other error codes as defined for each specific module
    968968 *                      start function.
    969969 */

  • uspace/srv/net/tl/tcp/tcp.c

    rcc3c2a1c r1bfd3d3  
    224224 * @param[in] client_connection The client connection processing function. The
    225225 *                      module skeleton propagates its own one.
    226  * @returns             EOK on success.
    227  * @returns             ENOMEM if there is not enough memory left.
     226 * @return              EOK on success.
     227 * @return              ENOMEM if there is not enough memory left.
    228228 */
    229229int tcp_initialize(async_client_conn_t client_connection)
    … …  
    12221222 * @param[out] answer_count The last parameter for the actual answer in the
    12231223 *                      answer parameter.
    1224  * @returns             EOK on success.
    1225  * @returns             ENOTSUP if the message is not known.
     1224 * @return              EOK on success.
     1225 * @return              ENOTSUP if the message is not known.
    12261226 *
    12271227 * @see tcp_interface.h
    … …  
    24942494/** Starts the module.
    24952495 *
    2496  * @returns             EOK on success.
    2497  * @returns             Other error codes as defined for each specific module
     2496 * @return              EOK on success.
     2497 * @return              Other error codes as defined for each specific module
    24982498 *                      start function.
    24992499 */

  • uspace/srv/net/tl/udp/udp.c

    rcc3c2a1c r1bfd3d3  
    9797 * @param[in] client_connection The client connection processing function. The
    9898 *                      module skeleton propagates its own one.
    99  * @returns             EOK on success.
    100  * @returns             ENOMEM if there is not enough memory left.
     99 * @return              EOK on success.
     100 * @return              ENOMEM if there is not enough memory left.
    101101 */
    102102int udp_initialize(async_client_conn_t client_connection)
    … …  
    205205 * @param[in] error     The packet error reporting service. Prefixes the
    206206 *                      received packet.
    207  * @returns             EOK on success.
    208  * @returns             EINVAL if the packet is not valid.
    209  * @returns             EINVAL if the stored packet address is not the
     207 * @return              EOK on success.
     208 * @return              EINVAL if the packet is not valid.
     209 * @return              EINVAL if the stored packet address is not the
    210210 *                      an_addr_t.
    211  * @returns             EINVAL if the packet does not contain any data.
    212  * @returns             NO_DATA if the packet content is shorter than the user
     211 * @return              EINVAL if the packet does not contain any data.
     212 * @return              NO_DATA if the packet content is shorter than the user
    213213 *                      datagram header.
    214  * @returns             ENOMEM if there is not enough memory left.
    215  * @returns             EADDRNOTAVAIL if the destination socket does not exist.
    216  * @returns             Other error codes as defined for the
     214 * @return              ENOMEM if there is not enough memory left.
     215 * @return              EADDRNOTAVAIL if the destination socket does not exist.
     216 * @return              Other error codes as defined for the
    217217 *                      ip_client_process_packet() function.
    218218 */
    … …  
    409409 * @param[in] error     The packet error reporting service. Prefixes the
    410410 *                      received packet.
    411  * @returns             EOK on success.
    412  * @returns             Other error codes as defined for the
     411 * @return              EOK on success.
     412 * @return              Other error codes as defined for the
    413413 *                      udp_process_packet() function.
    414414 */
    … …  
    439439 * @param[out] data_fragment_size The data fragment size in bytes.
    440440 * @param[in] flags     Various send flags.
    441  * @returns             EOK on success.
    442  * @returns             EAFNOTSUPPORT if the address family is not supported.
    443  * @returns             ENOTSOCK if the socket is not found.
    444  * @returns             EINVAL if the address is invalid.
    445  * @returns             ENOTCONN if the sending socket is not and cannot be
     441 * @return              EOK on success.
     442 * @return              EAFNOTSUPPORT if the address family is not supported.
     443 * @return              ENOTSOCK if the socket is not found.
     444 * @return              EINVAL if the address is invalid.
     445 * @return              ENOTCONN if the sending socket is not and cannot be
    446446 *                      bound.
    447  * @returns             ENOMEM if there is not enough memory left.
    448  * @returns             Other error codes as defined for the
     447 * @return              ENOMEM if there is not enough memory left.
     448 * @return              Other error codes as defined for the
    449449 *                      socket_read_packet_data() function.
    450  * @returns             Other error codes as defined for the
     450 * @return              Other error codes as defined for the
    451451 *                      ip_client_prepare_packet() function.
    452  * @returns             Other error codes as defined for the ip_send_msg()
     452 * @return              Other error codes as defined for the ip_send_msg()
    453453 *                      function.
    454454 */
    … …  
    599599 * @param[in] flags     Various receive flags.
    600600 * @param[out] addrlen  The source address length.
    601  * @returns             The number of bytes received.
    602  * @returns             ENOTSOCK if the socket is not found.
    603  * @returns             NO_DATA if there are no received packets or data.
    604  * @returns             ENOMEM if there is not enough memory left.
    605  * @returns             EINVAL if the received address is not an IP address.
    606  * @returns             Other error codes as defined for the packet_translate()
     601 * @return              The number of bytes received.
     602 * @return              ENOTSOCK if the socket is not found.
     603 * @return              NO_DATA if there are no received packets or data.
     604 * @return              ENOMEM if there is not enough memory left.
     605 * @return              EINVAL if the received address is not an IP address.
     606 * @return              Other error codes as defined for the packet_translate()
    607607 *                      function.
    608  * @returns             Other error codes as defined for the data_reply()
     608 * @return              Other error codes as defined for the data_reply()
    609609 *                      function.
    610610 */
    … …  
    698698 * @param[in] callid    The message identifier.
    699699 * @param[in] call      The message parameters.
    700  * @returns             EOK on success.
     700 * @return              EOK on success.
    701701 *
    702702 * @see socket.h
    … …  
    852852 * @param[out] answer_count The last parameter for the actual answer in the
    853853 *                      answer parameter.
    854  * @returns             EOK on success.
    855  * @returns             ENOTSUP if the message is not known.
     854 * @return              EOK on success.
     855 * @return              ENOTSUP if the message is not known.
    856856 *
    857857 * @see udp_interface.h
    … …  
    924924/** Starts the module.
    925925 *
    926  * @returns             EOK on success.
    927  * @returns             Other error codes as defined for each specific module
     926 * @return              EOK on success.
     927 * @return              Other error codes as defined for each specific module
    928928 *                      start function.
    929929 */
Note: See TracChangeset for help on using the changeset viewer.