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

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:

• il_local.h (modified) (2 diffs)
• ip_interface.h (modified) (1 diff)
• packet_client.h (modified) (3 diffs)
• tl_local.h (modified) (2 diffs)

uspace/lib/net/include/il_local.h

@@ -44 +44 @@
  * @param[out]          answer_count The last parameter for the actual answer in
  *                      the answer parameter.
- * @returns             EOK on success.
- * @returns             Other error codes as defined for the arp_message()
+ * @return              EOK on success.
+ * @return              Other error codes as defined for the arp_message()
  *                      function.
  */
@@ -59 +59 @@
  * @param[in] client_connection The client connection processing function. The
  *                      module skeleton propagates its own one.
- * @returns             EOK on successful module termination.
- * @returns             Other error codes as defined for the arp_initialize()
+ * @return              EOK on successful module termination.
+ * @return              Other error codes as defined for the arp_initialize()
  *                      function.
- * @returns             Other error codes as defined for the REGISTER_ME() macro
+ * @return              Other error codes as defined for the REGISTER_ME() macro
  *                      function.
  */

uspace/lib/net/include/ip_interface.h

@@ -68 +68 @@
  * @param[in] error     The packet error reporting service. Prefixes the
  *                      received packet.
- * @returns             EOK on success.
+ * @return              EOK on success.
  */
 typedef int (*tl_received_msg_t)(device_id_t device_id, packet_t packet,

uspace/lib/net/include/packet_client.h

@@ -61 +61 @@
  * @param[in] type      The type to be allocated at the beginning of the packet
  *                      content.
- * @returns             The typed pointer to the allocated memory.
- * @returns             NULL if the packet is not valid.
- * @returns             NULL if there is not enough memory left.
+ * @return              The typed pointer to the allocated memory.
+ * @return              NULL if the packet is not valid.
+ * @return              NULL if there is not enough memory left.
  */
 #define PACKET_PREFIX(packet, type) \
@@ -76 +76 @@
  * @param[in] type      The type to be allocated at the end of the packet
  *                      content.
- * @returns             The typed pointer to the allocated memory.
- * @returns             NULL if the packet is not valid.
- * @returns             NULL if there is not enough memory left.
+ * @return              The typed pointer to the allocated memory.
+ * @return              NULL if the packet is not valid.
+ * @return              NULL if there is not enough memory left.
  */
 #define PACKET_SUFFIX(packet, type) \
@@ -92 +92 @@
  * @param[in] suffix    The type of the suffix to be removed from the end of
  *                      the packet content.
- * @returns             EOK on success.
- * @returns             EINVAL if the packet is not valid.
- * @returns             ENOMEM if there is not enough memory left.
+ * @return              EOK on success.
+ * @return              EINVAL if the packet is not valid.
+ * @return              ENOMEM if there is not enough memory left.
  */
 #define PACKET_TRIM(packet, prefix, suffix) \

uspace/lib/net/include/tl_local.h

@@ -45 +45 @@
  * @param[in] client_connection The client connection processing function. The
  *                      module skeleton propagates its own one.
- * @returns             EOK on successful module termination.
- * @returns             Other error codes as defined for the module initialize
+ * @return              EOK on successful module termination.
+ * @return              Other error codes as defined for the module initialize
  *                      function.
- * @returns             Other error codes as defined for the REGISTER_ME() macro
+ * @return              Other error codes as defined for the REGISTER_ME() macro
  *                      function.
  */
@@ -62 +62 @@
  * @param[out] answer_count The last parameter for the actual answer in the
  *                      answer parameter.
- * @returns             EOK on success.
- * @returns             Other error codes as defined for the module's message
+ * @return              EOK on success.
+ * @return              Other error codes as defined for the module's message
  *                      standalone function.
  */