Skip to content

Commit fe8ebe9

Browse files
Reword
1 parent 096b823 commit fe8ebe9

File tree

1 file changed

+3
-3
lines changed
  • connectivity/netsocket/include/netsocket

1 file changed

+3
-3
lines changed

connectivity/netsocket/include/netsocket/Socket.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,11 +316,11 @@ class Socket {
316316
* On error, returns nullptr and sets the error code parameter (if provided).
317317
*
318318
* Note that if a socket is returned, you must eventually call close() on it to release its resources.
319-
* Calling close() will also delete the socket object, no separate delete() is required.
319+
* Calling close() will also delete the socket object, no separate \c delete is required.
320320
* Referencing the returned socket after a close() call is not allowed and leads to undefined behavior.
321321
*
322-
* By default, this function blocks until incoming connection occurs. If socket is set to
323-
* non-blocking or times out, error is set to NSAPI_ERROR_WOULD_BLOCK.
322+
* By default, this function blocks until an incoming connection occurs. If socket is set to
323+
* non-blocking or times out, an \c NSAPI_ERROR_WOULD_BLOCK error is returned.
324324
*
325325
* @param error If you wish to check the error code, pass an error code pointer here.
326326
* @return Pointer to a socket, or nullptr on error

0 commit comments

Comments
 (0)