Changeset cde999a in mainline for uspace/lib/c/generic/inet

Timestamp:

2018-01-04T20:22:51Z (8 years ago)

Author:

Jiří Zárevúcky <zarevucky.jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

3d95c9d, 84a1a54

Parents:

3c7702c0

git-author:

Jiří Zárevúcky <zarevucky.jiri@…> (2018-01-04 19:18:29)

git-committer:

Jiří Zárevúcky <zarevucky.jiri@…> (2018-01-04 20:22:51)

Message:

Fix comments to stop referring to error codes as negative.

Location:

uspace/lib/c/generic/inet

Files:

• tcp.c (modified) (9 diffs)
• udp.c (modified) (6 diffs)

uspace/lib/c/generic/inet/tcp.c

@@ -59 +59 @@
  *
  * @param tcp TCP service
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 static int tcp_callback_create(tcp_t *tcp)
@@ -205 +205 @@
  * @param rconn Place to store pointer to new connection
  *
- * @return EOK on success or negative error code.
+ * @return EOK on success or an error code.
  */
 int tcp_conn_create(tcp_t *tcp, inet_ep2_t *epp, tcp_cb_t *cb, void *arg,
@@ -316 +316 @@
  * @param rlst Place to store pointer to new listener
  *
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int tcp_listener_create(tcp_t *tcp, inet_ep_t *ep, tcp_listen_cb_t *lcb,
@@ -446 +446 @@
  * @param bytes Data size in bytes
  *
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int tcp_conn_send(tcp_conn_t *conn, const void *data, size_t bytes)
@@ -478 +478 @@
  *
  * @param conn Connection
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int tcp_conn_send_fin(tcp_conn_t *conn)
@@ -494 +494 @@
  *
  * @param conn Connection
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int tcp_conn_push(tcp_conn_t *conn)
@@ -510 +510 @@
  *
  * @param conn Connection
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int tcp_conn_reset(tcp_conn_t *conn)
@@ -538 +538 @@
  *
  * @return EOK on success, EAGAIN if no received data is pending, or other
- *         negative error code in case of other error
+ *         error code in case of other error
  */
 int tcp_conn_recv(tcp_conn_t *conn, void *buf, size_t bsize, size_t *nrecv)
@@ -586 +586 @@
  * @param nrecv Place to store actual number of received bytes
  *
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int tcp_conn_recv_wait(tcp_conn_t *conn, void *buf, size_t bsize,

uspace/lib/c/generic/inet/udp.c

@@ -46 +46 @@
  *
  * @param udp UDP service
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 static int udp_callback_create(udp_t *udp)
@@ -158 +158 @@
  * @param rassoc Place to store pointer to new association
  *
- * @return EOK on success or negative error code.
+ * @return EOK on success or an error code.
  */
 int udp_assoc_create(udp_t *udp, inet_ep2_t *epp, udp_cb_t *cb, void *arg,
@@ -250 +250 @@
  * @param bytes Message size in bytes
  *
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 int udp_assoc_send_msg(udp_assoc_t *assoc, inet_ep_t *dest, void *data,
@@ -316 +316 @@
  * @param bsize Buffer size
  *
- * @return EOK on success or negative error code.
+ * @return EOK on success or an error code.
  */
 int udp_rmsg_read(udp_rmsg_t *rmsg, size_t off, void *buf, size_t bsize)
@@ -380 +380 @@
  * @param rmsg Place to store message information
  *
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 static int udp_rmsg_info(udp_t *udp, udp_rmsg_t *rmsg)
@@ -413 +413 @@
  *
  * @param udp UDP client
- * @return EOK on success or negative error code
+ * @return EOK on success or an error code
  */
 static int udp_rmsg_discard(udp_t *udp)