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


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/lib/net/include
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • uspace/lib/net/include/il_local.h

    rcc3c2a1c r1bfd3d3  
    4444 * @param[out]          answer_count The last parameter for the actual answer in
    4545 *                      the answer parameter.
    46  * @returns             EOK on success.
    47  * @returns             Other error codes as defined for the arp_message()
     46 * @return              EOK on success.
     47 * @return              Other error codes as defined for the arp_message()
    4848 *                      function.
    4949 */
     
    5959 * @param[in] client_connection The client connection processing function. The
    6060 *                      module skeleton propagates its own one.
    61  * @returns             EOK on successful module termination.
    62  * @returns             Other error codes as defined for the arp_initialize()
     61 * @return              EOK on successful module termination.
     62 * @return              Other error codes as defined for the arp_initialize()
    6363 *                      function.
    64  * @returns             Other error codes as defined for the REGISTER_ME() macro
     64 * @return              Other error codes as defined for the REGISTER_ME() macro
    6565 *                      function.
    6666 */
  • uspace/lib/net/include/ip_interface.h

    rcc3c2a1c r1bfd3d3  
    6868 * @param[in] error     The packet error reporting service. Prefixes the
    6969 *                      received packet.
    70  * @returns             EOK on success.
     70 * @return              EOK on success.
    7171 */
    7272typedef int (*tl_received_msg_t)(device_id_t device_id, packet_t packet,
  • uspace/lib/net/include/packet_client.h

    rcc3c2a1c r1bfd3d3  
    6161 * @param[in] type      The type to be allocated at the beginning of the packet
    6262 *                      content.
    63  * @returns             The typed pointer to the allocated memory.
    64  * @returns             NULL if the packet is not valid.
    65  * @returns             NULL if there is not enough memory left.
     63 * @return              The typed pointer to the allocated memory.
     64 * @return              NULL if the packet is not valid.
     65 * @return              NULL if there is not enough memory left.
    6666 */
    6767#define PACKET_PREFIX(packet, type) \
     
    7676 * @param[in] type      The type to be allocated at the end of the packet
    7777 *                      content.
    78  * @returns             The typed pointer to the allocated memory.
    79  * @returns             NULL if the packet is not valid.
    80  * @returns             NULL if there is not enough memory left.
     78 * @return              The typed pointer to the allocated memory.
     79 * @return              NULL if the packet is not valid.
     80 * @return              NULL if there is not enough memory left.
    8181 */
    8282#define PACKET_SUFFIX(packet, type) \
     
    9292 * @param[in] suffix    The type of the suffix to be removed from the end of
    9393 *                      the packet content.
    94  * @returns             EOK on success.
    95  * @returns             EINVAL if the packet is not valid.
    96  * @returns             ENOMEM if there is not enough memory left.
     94 * @return              EOK on success.
     95 * @return              EINVAL if the packet is not valid.
     96 * @return              ENOMEM if there is not enough memory left.
    9797 */
    9898#define PACKET_TRIM(packet, prefix, suffix) \
  • uspace/lib/net/include/tl_local.h

    rcc3c2a1c r1bfd3d3  
    4545 * @param[in] client_connection The client connection processing function. The
    4646 *                      module skeleton propagates its own one.
    47  * @returns             EOK on successful module termination.
    48  * @returns             Other error codes as defined for the module initialize
     47 * @return              EOK on successful module termination.
     48 * @return              Other error codes as defined for the module initialize
    4949 *                      function.
    50  * @returns             Other error codes as defined for the REGISTER_ME() macro
     50 * @return              Other error codes as defined for the REGISTER_ME() macro
    5151 *                      function.
    5252 */
     
    6262 * @param[out] answer_count The last parameter for the actual answer in the
    6363 *                      answer parameter.
    64  * @returns             EOK on success.
    65  * @returns             Other error codes as defined for the module's message
     64 * @return              EOK on success.
     65 * @return              Other error codes as defined for the module's message
    6666 *                      standalone function.
    6767 */
Note: See TracChangeset for help on using the changeset viewer.